Electronic mail message.
More...
Electronic mail message.
Definition at line 14 of file Email.php.
Email::AddHeaders |
( |
|
$NewHeaders | ) |
|
Specify additional message headers to be included.
- Parameters
-
array | $NewHeaders | Array of header lines. |
Definition at line 318 of file Email.php.
Email::AddLogData |
( |
|
$LogData | ) |
|
Provide additional data that should be included when a message is logged.
- Parameters
-
array | $LogData | Associative array of data. |
Definition at line 136 of file Email.php.
Email::AlternateBody |
( |
|
$NewValue = NULL | ) |
|
Get/set the plain-text alternative to the body.
- Parameters
-
string | $NewValue | New plain-text alternative. (OPTIONAL) |
- Returns
- Returns the current plain-text alternative, if any.
Definition at line 159 of file Email.php.
Referenced by DeliverySettingErrors().
Email::BCC |
( |
|
$NewValue = NULL | ) |
|
Get/set message BCC list.
- Parameters
-
array | string | $NewValue | New message BCC recipient or array of BCC recipients, in RFC-2822 format ("user@example.com" or "User
<user@example.com>" if name included). (OPTIONAL) |
- Returns
- Array of current message BCC recipient(s) in RFC-2822 format.
Definition at line 298 of file Email.php.
Referenced by DeliverySettingErrors().
Email::Body |
( |
|
$NewValue = NULL | ) |
|
Get/set message body.
- Parameters
-
string | $NewValue | New message body. (OPTIONAL) |
- Returns
- Current message body.
Definition at line 148 of file Email.php.
Referenced by DeliverySettingErrors().
Email::CC |
( |
|
$NewValue = NULL | ) |
|
Get/set message CC list.
- Parameters
-
array | string | $NewValue | New message CC recipient or array of CC recipients, in RFC-2822 format ("user@example.com" or "User
<user@example.com>" if name included). (OPTIONAL) |
- Returns
- Array of current message CC recipient(s) in RFC-2822 format.
Definition at line 275 of file Email.php.
Referenced by DeliverySettingErrors().
Email::CharSet |
( |
|
$NewValue = NULL | ) |
|
Specify a character encoding for the message.
This is used to set the PHPMailer::CharSet property.
- Parameters
-
string | $NewValue | New character encoding (OPTIONAL) |
- Returns
- Returns the current character encoding.
Definition at line 330 of file Email.php.
Referenced by DeliverySettingErrors().
static Email::ConvertHtmlToPlainText |
( |
|
$Html | ) |
|
|
static |
Try as best as possible to convert HTML to plain text.
- Parameters
-
string | $Html | The HTML to convert. |
- Returns
- Returns the HTML as plain text.
Definition at line 457 of file Email.php.
static Email::ConvertHtmlWhiteSpace |
( |
|
$Html, |
|
|
|
$Aggressive = FALSE , |
|
|
|
$LineEnding = "\r\n" |
|
) |
| |
|
staticprotected |
Convert horizontal white space with no semantic value to vertical white space when possible.
Only converts white space between tag attributes by default, but can also convert white space within tags if specified.
- Parameters
-
mixed | $Html | HTML string in which white space should be converted. |
bool | $Aggressive | TRUE to also convert white space within tags in which horizontal whitespace has no semantic value. This should only be used when absolutely necessary because it can make the HTML hard to read. This parameter is optional. |
string | $LineEnding | Character sequence to use as the line ending. This parameter is optional. |
- Returns
- Returns the HTML with its horizontal white space converted to vertical white space as specified in the parameters.
Definition at line 902 of file Email.php.
static Email::DefaultFrom |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set default "From" address.
This address is used when no "From" address is specified for a message.
- Parameters
-
string | $NewValue | New default address. (OPTIONAL) |
- Returns
- string Current default address.
Definition at line 213 of file Email.php.
static Email::DeliveryMethod |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set mail delivery method.
If specified, the method must be one of the predefined "METHOD_" constants.
- Parameters
-
int | $NewValue | New delivery method. (OPTIONAL) |
- Returns
- Current delivery method.
Definition at line 489 of file Email.php.
static Email::DeliverySettingErrors |
( |
| ) |
|
|
static |
static Email::DeliverySettings |
( |
|
$NewSettings = NULL | ) |
|
|
static |
Get/set serialized (opaque text) version of delivery settings.
This method is intended to be used to store and retrieve all email delivery settings for the class, in a form suitable to be saved to a database.
- Parameters
-
array | $NewSettings | New delivery settings values. |
- Returns
- Current delivery settings values.
Definition at line 564 of file Email.php.
static Email::DeliverySettingsOkay |
( |
| ) |
|
|
static |
Test delivery settings and report their validity.
For example, if the deliver method is set to SMTP it would test the server, port, and (if authentication is indicated) user name and password. If delivery settings are not okay, then DeliverySettingErrors() can be used to determine (if known) which settings may have problems.
- Returns
- TRUE if delivery settings are okay, otherwise FALSE.
Definition at line 596 of file Email.php.
Email::From |
( |
|
$NewAddress = NULL , |
|
|
|
$NewName = NULL |
|
) |
| |
Get/set message sender.
- Parameters
-
string | $NewAddress | New message sender address. (OPTIONAL, but required if NewName is specified.) |
string | $NewName | New message sender name. (OPTIONAL) |
- Returns
- Current message sender in RFC-2822 format ("user@example.com" or "User <user@example.com>" if name available).
Definition at line 189 of file Email.php.
Referenced by DeliverySettingErrors().
static Email::GetTagInfo |
( |
|
$Html, |
|
|
|
$TagBegin |
|
) |
| |
|
staticprotected |
Get the tag name and whether it's a closing tag from a tag that begins at a specific offset within some HTML.
This is really only useful to ConvertHtmlWhiteSpace().
- Parameters
-
string | $Html | HTML string from which to get the information. |
int | $TagBegin | Offset of where the tag begins. |
- Returns
- Returns an array containing the tag name and if it's a closing tag.
Definition at line 1014 of file Email.php.
static Email::LineEnding |
( |
|
$NewValue = NULL | ) |
|
|
static |
Specify the character sequence that should be used to end lines.
- Parameters
-
string | $NewValue | Character sequence used to end lines. |
- Returns
- Returns the current character sequence used to end lines.
Definition at line 346 of file Email.php.
static Email::Password |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set password for mail delivery.
- Parameters
-
string | $NewValue | New password. (OPTIONAL) |
- Returns
- Current password.
Definition at line 540 of file Email.php.
static Email::Port |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set port number for mail delivery.
- Parameters
-
int | $NewValue | New port number. (OPTIONAL) |
- Returns
- Current port number.
Definition at line 518 of file Email.php.
static Email::RegisterLoggingFunction |
( |
|
$NewValue | ) |
|
|
static |
Register a logging callback.
- Parameters
-
callable | $NewValue | Function to call just before an Email is sent. The Email will be provided as the first parameter. |
Definition at line 121 of file Email.php.
Email::ReplyTo |
( |
|
$NewAddress = NULL , |
|
|
|
$NewName = NULL |
|
) |
| |
Get/set message "Reply-To" address.
- Parameters
-
string | $NewAddress | New message "Reply-To" address. (OPTIONAL, but required if NewName is specified.) |
string | $NewName | New message "Reply-To" name. (OPTIONAL) |
- Returns
- Current message "Reply-To" address in RFC-2822 format ("user@example.com" or "User <user@example.com>" if name available).
Definition at line 227 of file Email.php.
Referenced by DeliverySettingErrors().
Mail the message.
If no recipients have been specified or all recipients were disallowed via whitelisting, successful execution is still reported by returning TRUE.
- Returns
- TRUE if message was successfully accepted for delivery, otherwise FALSE.
Definition at line 28 of file Email.php.
References StdLib\substr(), and To().
static Email::Server |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set server for mail delivery.
- Parameters
-
string | $NewValue | New server. (OPTIONAL) |
- Returns
- Current server.
Definition at line 507 of file Email.php.
Email::Subject |
( |
|
$NewValue = NULL | ) |
|
Get/set message subject.
- Parameters
-
string | $NewValue | New message subject. (OPTIONAL) |
- Returns
- Current message subject.
Definition at line 175 of file Email.php.
Referenced by DeliverySettingErrors().
static Email::TestLineEndings |
( |
|
$Value, |
|
|
|
$LineEnding |
|
) |
| |
|
static |
Test the line endings in a value to see if they all match the given line ending.
This only works with \r (CR), \n (LF), and \r\n (CRLF).
- Parameters
-
string | $Value | String to check. |
string | $LineEnding | Line ending character sequence. |
- Returns
- Returns TRUE if all the line endings match and FALSE otherwise.
Definition at line 424 of file Email.php.
Email::To |
( |
|
$NewValue = NULL | ) |
|
Get/set message recipient(s).
- Parameters
-
array | string | $NewValue | New message recipient or array of recipients, in RFC-2822 format ("user@example.com" or "User <user@example.com>" if name included). (OPTIONAL) |
- Returns
- Array of current message recipient(s) in RFC-2822 format.
Definition at line 252 of file Email.php.
Referenced by DeliverySettingErrors(), and Send().
static Email::ToWhitelist |
( |
|
$NewValue = NULL | ) |
|
|
static |
Set whitelist of acceptable recipient addresses.
If no whitelist patterns are set, all addresses are acceptable. (Pass in an empty array to clear whitelist.)
- Parameters
-
array | $NewValue | Array of regular expression patterns to match acceptable email addresses. (OPTIONAL) |
- Returns
- array Array of current whitelist entries.
Definition at line 107 of file Email.php.
static Email::UseAuthentication |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set whether to use authentication for mail delivery.
- Parameters
-
bool | $NewValue | New authentication setting. (OPTIONAL) |
- Returns
- Current authentication setting.
Definition at line 551 of file Email.php.
static Email::UserName |
( |
|
$NewValue = NULL | ) |
|
|
static |
Get/set user name for mail delivery.
- Parameters
-
string | $NewValue | New user name. (OPTIONAL) |
- Returns
- Current user name.
Definition at line 529 of file Email.php.
static Email::WrapHtmlAsNecessary |
( |
|
$Html, |
|
|
|
$MaxLineLength = 998 , |
|
|
|
$LineEnding = "\r\n" |
|
) |
| |
|
static |
Wrap HTML in an e-mail as necessary to get its lines less than some max length.
This does not guarantee that every line will be less than the max length because it guarantees instead that the sematics of the HTML remain unchanged.
- Parameters
-
string | $Html | HTML to wrap. |
int | $MaxLineLength | Maximum length of each line. This parameter is optional. |
string | $LineEnding | Line ending character sequence. This parameter is optional. |
- Returns
- Returns HTML that is wrapped as necessary.
Definition at line 368 of file Email.php.
const Email::METHOD_PHPMAIL = 1 |
Deliver using PHP's internal mail() mechanism.
Definition at line 498 of file Email.php.
const Email::METHOD_SMTP = 2 |
Deliver using SMTP.
(Requires specifying SMTP settings.)
Definition at line 500 of file Email.php.
The documentation for this class was generated from the following file: