ntp.snails.email - NTP REST API!
\

\APIMultiMailer

Mailer Class.

At the moment, this does nothing but send email through PHP "mail()" function, but it has the ability to do much more.

If you have problems sending mail with "mail()", you can edit the member variables to suit your setting. Later this will be possible through the admin panel.

Summary

Methods
Properties
Constants
__construct()
setSMTPAuth()
AddrFormat()
$From
$FromName
$Mailer
$Sendmail
$Host
$SMTPAuth
$Username
$Password
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$From

$From :

'from' address

Type

—

$FromName

$FromName :

'from' name

Type

—

$Mailer

$Mailer :

Method to be used when sending the mail.

This can be:

  • mail (standard PHP function 'mail()') (default)
  • smtp (send through any SMTP server, SMTPAuth is supported. You must set $Host, for SMTPAuth also $SMTPAuth, $Username, and $Password.)
  • sendmail (manually set the path to your sendmail program to something different than 'mail()' uses in $Sendmail)

    Type

    —

    • $Sendmail

    $Sendmail :

    set if $Mailer is 'sendmail'

    Only used if $Mailer is set to 'sendmail'. Contains the full path to your sendmail program or replacement.

    Type

    —

    $Host

    $Host :

    SMTP Host.

    Only used if $Mailer is set to 'smtp'

    Type

    —

    $SMTPAuth

    $SMTPAuth :

    Does your SMTP host require SMTPAuth authentication?

    Type

    —

    $Username

    $Username :

    Username for authentication with your SMTP host.

    Only used if $Mailer is 'smtp' and $SMTPAuth is TRUE

    Type

    —

    $Password

    $Password :

    Password for SMTPAuth.

    Only used if $Mailer is 'smtp' and $SMTPAuth is TRUE

    Type

    —

    Methods

    __construct()

    __construct( from,  fromName,  method = mail) :

    Constructor

    Parameters

    from
    fromName
    method

    Returns

    —

    setSMTPAuth()

    setSMTPAuth( host,  username,  password) :

    Constructor

    Parameters

    host
    username
    password

    Returns

    —

    AddrFormat()

    AddrFormat( addr) :

    Formats an address correctly. This overrides the default addr_format method which does not seem to encode $FromName correctly

    Parameters

    addr

    Returns

    —