STOP_MESSAGE
STOP_MESSAGE = 0
Error severity: message only, continue processing
PHPMailer - PHP email creation and transport class.
PHP Version 5.0.0
$action_function :
Callback Action function name.
The function that handles the result of the send email action. It is called out by send() for each email sent.
Value can be any php callable: http://www.php.net/is_callable
Parameters: bool $result result of the send action string $to email address of the recipient string $cc cc email addresses string $bcc bcc email addresses string $subject the subject string $body the email body string $from email address of sender
validateAddress(string $address, string $patternselect = 'auto') : boolean
Check that a string looks like an email address.
| string | $address | The email address to check |
| string | $patternselect | A selector for the validation pattern to use : 'auto' - pick best one automatically; 'pcre8' - use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14; 'pcre' - use old PCRE implementation; 'php' - use PHP built-in FILTER_VALIDATE_EMAIL; faster, less thorough; 'noregex' - super fast, really dumb. |
getSMTPInstance() : \SMTP
Get an instance to use for SMTP operations.
Override this function to load your own SMTP implementation
setLanguage(string $langcode = 'en', string $lang_path = 'language/') : boolean
Set the language for error messages.
Returns false if it cannot load the language file. The default language is English.
| string | $langcode | ISO 639-1 2-character language code (e.g. French is "fr") |
| string | $lang_path | Path to the language file directory, with trailing separator (slash) |
addrAppend(string $type, array $addr) : string
Create recipient headers.
| string | $type | |
| array | $addr | An array of recipient, where each recipient is a 2-element indexed array with element 0 containing an address and element 1 containing a name, like: array(array('joe@example.com', 'Joe User'), array('zoe@example.com', 'Zoe User')) |
wrapText(string $message, integer $length, boolean $qp_mode = false) : string
Word-wrap message.
For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.
| string | $message | The message to wrap |
| integer | $length | The line length to wrap to |
| boolean | $qp_mode | Whether to run in Quoted-Printable mode |
utf8CharBoundary(string $encodedText, integer $maxLength) : integer
Find the last character boundary prior to $maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
| string | $encodedText | utf-8 QP text |
| integer | $maxLength | find last character boundary prior to this length |
addAttachment(string $path, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'attachment') : boolean
Add an attachment from a path on the filesystem.
Returns false if the file could not be found or read.
| string | $path | Path to the attachment. |
| string | $name | Overrides the attachment name. |
| string | $encoding | File encoding (see $Encoding). |
| string | $type | File extension (MIME) type. |
| string | $disposition | Disposition to use |
encodeString(string $str, string $encoding = 'base64') : string
Encode a string in requested format.
Returns an empty string on failure.
| string | $str | The text to encode |
| string | $encoding | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
base64EncodeWrapMB(string $str, string $lf = null) : string
Encode and wrap long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid
| string | $str | multi-byte text to wrap encode |
| string | $lf | string to use as linefeed/end-of-line |
addStringAttachment(string $string, string $filename, string $encoding = 'base64', string $type = '', string $disposition = 'attachment') : void
Add a string or binary attachment (non-filesystem).
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
| string | $string | String attachment data. |
| string | $filename | Name of the attachment. |
| string | $encoding | File encoding (see $Encoding). |
| string | $type | File extension (MIME) type. |
| string | $disposition | Disposition to use |
addEmbeddedImage(string $path, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean
Add an embedded (inline) attachment from a file.
This can include images, sounds, and just about any other document type. These differ from 'regular' attachmants in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the $cid value.
| string | $path | Path to the attachment. |
| string | $cid | Content ID of the attachment; Use this to reference the content when using an embedded image in HTML. |
| string | $name | Overrides the attachment name. |
| string | $encoding | File encoding (see $Encoding). |
| string | $type | File MIME type. |
| string | $disposition | Disposition to use |
True on successfully adding an attachment
addStringEmbeddedImage(string $string, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean
Add an embedded stringified attachment.
This can include images, sounds, and just about any other document type. Be sure to set the $type to an image type for images: JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.
| string | $string | The attachment binary data. |
| string | $cid | Content ID of the attachment; Use this to reference the content when using an embedded image in HTML. |
| string | $name | |
| string | $encoding | File encoding (see $Encoding). |
| string | $type | MIME type. |
| string | $disposition | Disposition to use |
True on successfully adding an attachment
msgHTML(string $message, string $basedir = '', boolean $advanced = false) : string
Create a message from an HTML string.
Automatically makes modifications for inline images and backgrounds and creates a plain-text version by converting the HTML. Overwrites any existing values in $this->Body and $this->AltBody
| string | $message | HTML message string |
| string | $basedir | baseline directory for path |
| boolean | $advanced | Whether to use the advanced HTML to text converter |
$message
mb_pathinfo(string $path, integer|string $options = null) : string|array
Multi-byte-safe pathinfo replacement.
Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe. Works similarly to the one in PHP >= 5.2.0
| string | $path | A filename or path, does not need to exist as a file |
| integer|string | $options | Either a PATHINFO_* constant, or a string name to return only the specified piece, allows 'filename' to work on PHP < 5.2 |
normalizeBreaks(string $text, string $breaktype = "\r\n") : string
Normalize line breaks in a string.
Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. Defaults to CRLF (for message bodies) and preserves consecutive breaks.
| string | $text | |
| string | $breaktype | What kind of line break to use, defaults to CRLF |
addAnAddress(string $kind, string $address, string $name = '') : boolean
Add an address to one of the recipient arrays.
Addresses that have been added already return false, but do not throw exceptions
| string | $kind | One of 'to', 'cc', 'bcc', 'ReplyTo' |
| string | $address | The email address to send to |
| string | $name |
true on success, false if address already used or invalid in some way
smtpSend(string $header, string $body) : boolean
Send mail via SMTP.
Returns false if there is a bad MAIL FROM, RCPT, or DATA input. Uses the PHPMailerSMTP class by default.
| string | $header | The message headers |
| string | $body | The message body |
encodeFile(string $path, string $encoding = 'base64') : string
Encode a file attachment in requested format.
Returns an empty string on failure.
| string | $path | The full path to the file |
| string | $encoding | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
mailPassthru(string $to, string $subject, string $body, string $header, string $params) : boolean
Call mail() in a safe_mode-aware fashion.
Also, unless sendmail_path points to sendmail (or something that claims to be sendmail), don't pass params (not a perfect fix, but it will do)
| string | $to | To |
| string | $subject | Subject |
| string | $body | Message Body |
| string | $header | Additional Header(s) |
| string | $params | Params |