XoopsMailerLocal

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

XoopsMailerLocal

Mailer Class.

• Class name: XoopsMailerLocal
• Namespace:
• Parent class: icms_messaging_EmailHandler

Properties

$From

public string $From

"from" address

• Visibility: public

$FromName

public string $FromName

"from" name

• Visibility: public

$Mailer

public string $Mailer = mail

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)

• Visibility: public

$Sendmail

public string $Sendmail = /usr/sbin/sendmail

set if $Mailer is "sendmail"

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

• Visibility: public

$Host

public string $Host

SMTP Host.

Only used if $Mailer is set to "smtp"

• Visibility: public

$SMTPSecure

public string $SMTPSecure

Sets connection prefix.

Options are "", "ssl" or "tls"

• Visibility: public

$SMTPAuth

public bool $SMTPAuth = \false

Does your SMTP host require SMTPAuth authentication?

• Visibility: public

$Username

public string $Username

Username for authentication with your SMTP host.

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

• Visibility: public

$Password

public string $Password

Password for SMTPAuth.

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

• Visibility: public

$Port

public bool $Port = 25

Sets default SMTP Port to use?

• Visibility: public

Methods

__construct

void icms_messaging_EmailHandler::__construct()

Constuctor

• Visibility: public
• This method is defined by icms_messaging_EmailHandler

encodeFromName

mixed icms_messaging_EmailHandler::encodeFromName(mixed text)

• Visibility: public
• This method is defined by icms_messaging_EmailHandler

Arguments

• text mixed

encodeSubject

mixed icms_messaging_EmailHandler::encodeSubject(mixed text)

• Visibility: public
• This method is defined by icms_messaging_EmailHandler

Arguments

• text mixed

AddrFormat

string icms_messaging_EmailHandler::AddrFormat(string addr)

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

• Visibility: public
• This method is defined by icms_messaging_EmailHandler

Arguments

• addr string - <p>the email address to be formatted</p>

encodeBody

mixed icms_messaging_EmailHandler::encodeBody(mixed text)

• Visibility: public
• This method is defined by icms_messaging_EmailHandler

Arguments

• text mixed