PHPMailer - PHP email creation and transport class.
Located in /class.phpmailer.php (line 28)
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
Whether to allow sending messages with an empty body.
An array of all kinds of addresses.
Includes all of $to, $cc, $bcc, $replyto
The plain-text message body.
This body can be read by mail clients that do not have HTML email capability such as mutt & Eudora. Clients that can read HTML will view the normal Body.
The array of attachments.
SMTP auth type.
Options are LOGIN (default), PLAIN, NTLM, CRAM-MD5
The array of 'bcc' addresses.
An HTML or plain text message body.
If HTML then call isHTML(true).
The array of MIME boundary strings.
The array of 'cc' addresses.
The character set of the message.
The email address that a reading confirmation should be sent to.
The MIME Content-type of the message.
The array of custom headers.
How to handle debug output.
Options: 'echo': Output plain-text as-is, appropriate for CLI 'html': Output escaped, line breaks converted to
, appropriate for browser output 'error_log': Output to error log as configured in php.ini
DKIM signing domain name.
DKIM Identity.
Usually the email address used as the source of the email
DKIM passphrase.
Used if your key is encrypted.
DKIM private key file path.
DKIM selector.
Whether to generate VERP addresses on send.
Only applicable when sending via SMTP.
The message encoding.
Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".
Holds the most recent mailer error message.
The number of errors encountered.
Whether to throw exceptions for errors.
The From email address for the message.
The From name of the message.
The SMTP HELO of the message.
Default is $Hostname.
SMTP hosts.
Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). Hosts will be tried in order.
The hostname to use in Message-Id and Received headers and as default HELO string.
If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
An iCal message part body.
Only supported in simple alt or alt_inline message types To generate iCal events, use the bundled extras/EasyPeasyICS.php class or iCalcreator
The array of available languages.
The most recent Message-ID (including angular brackets).
The default line ending.
Which method to use to send mail.
Options: "mail", "sendmail", or "smtp".
Extra headers that createHeader() doesn't fold in.
The message Date to be used in the Date header.
If empty, the current date will be added.
An ID to be used in the Message-Id header.
If empty, a unique id will be generated.
The message's MIME type.
The complete compiled MIME message body.
The complete compiled MIME message headers.
SMTP password.
Path to PHPMailer plugins.
Useful if the SMTP class is not in the PHP include path.
The default SMTP server port.
Email priority.
Options: 1 = High, 3 = Normal, 5 = low.
SMTP realm.
Used for NTLM auth
The array of reply-to names and addresses.
The Return-Path of the message.
If empty, it will be set to either From or Sender.
The Sender email (Return-Path) of the message.
If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
The path to the sendmail program.
The S/MIME certificate file path.
The S/MIME key file path.
The S/MIME password for the key.
Used only if the key is encrypted.
Whether to split multiple to addresses into multiple messages or send them all in one message.
Storage for addresses when SingleTo is enabled.
An instance of the SMTP sender class.
Whether to use SMTP authentication.
Uses the Username and Password properties.
SMTP class debug output mode.
Options: 0: no output 1: commands 2: data and commands 3: as 2 plus connection status 4: low level data output
Whether to keep SMTP connection open after each message.
If this is set to true then to close the connection requires an explicit call to smtpClose().
The secure connection prefix.
Options: "", "ssl" or "tls"
The Subject of the message.
The SMTP server timeout in seconds.
The array of 'to' addresses.
SMTP username.
Whether mail() uses a fully sendmail-compatible MTA.
One which supports sendmail's "-oi -f" options.
The PHPMailer Version number.
Word-wrap the message body to this number of chars.
SMTP workstation.
Used for NTLM auth
What to use in the X-Mailer header.
Options: null for default, whitespace for none, or a string to use
Map a file name to a MIME type.
Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
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
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.
Return an RFC 822 formatted date.
Check that a string looks like an email address.
Get the MIME type for a file extension.
Constructor
Destructor.
Add a "To" address.
Add an address to one of the recipient arrays.
Addresses that have been added already return false, but do not throw exceptions
Add an attachment from a path on the filesystem.
Returns false if the file could not be found or read.
Add a "BCC" address.
Add a "CC" address.
Add a custom header.
$name value can be overloaded to contain both header name and value (name:value)
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.
Create recipient headers.
Add a "Reply-to" address.
Format an address for use in a message header.
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.
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'.
Check if this message has an alternative body set.
Attach all file, string, and binary attachments to the message.
Returns an empty string on failure.
Check if an attachment (non-inline) is present.
Encode and wrap long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid
Clear all To recipients.
Clear all recipient types.
Clear all filesystem, string, and binary attachments.
Clear all BCC recipients.
Clear all CC recipients.
Clear all custom headers.
Clear all ReplyTo recipients.
Assemble the message body.
Returns an empty string on failure.
Assemble message headers.
Create the DKIM header and body in a new message header.
Generate a DKIM canonicalization body.
Generate a DKIM canonicalization header.
Quoted-Printable-encode a DKIM header.
Generate a DKIM signature.
Perform a callback.
Output debugging info via user-defined method.
Only if debug output is enabled.
Encode a file attachment in requested format.
Returns an empty string on failure.
Encode a header string optimally.
Picks shortest of Q, B, quoted-printable or none.
Encode a string using Q encoding.
Encode a string in quoted-printable format.
According to RFC2045 section 6.7.
Backward compatibility wrapper for an old QP encoding function that was removed.
Encode a string in requested format.
Returns an empty string on failure.
Return the end of a message boundary.
Ensure consistent line endings in a string.
Changes every end of line from CRLF, CR or LF to $this->LE.
Allows for public read access to 'all_recipients' property.
Return the array of attachments.
Allows for public read access to 'bcc' property.
Return the start of a message boundary.
Allows for public read access to 'cc' property.
Return the Message-ID header of the last email.
Technically this is the value from the last time the headers were created, but it's also the message ID of the last sent message except in pathological cases.
Get the message MIME type headers.
Allows for public read access to 'ReplyTo' property.
Returns the whole MIME message.
Includes complete headers and body. Only valid post preSend().
Get an instance to use for SMTP operations.
Override this function to load your own SMTP implementation
Allows for public read access to 'to' property.
Get the array of strings for the current language.
Does a string contain any 8-bit chars (in any charset)?
Check if a string contains multi-byte characters.
Format a header line.
Convert an HTML string into plain text.
Check if an inline attachment is present.
Check if an error occurred.
Sets message type to HTML or plain.
Send messages using PHP's mail() function.
Send messages using qmail.
Send messages using $Sendmail.
Send messages using SMTP.
Get an error message in the current language.
Send mail using the PHP mail() function.
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
Actually send a message.
Send the email via the selected mechanism
Prepare a message for sending.
Strip newlines to prevent header injection.
Create a message and send it.
Uses the sending method specified by $Mailer.
Send mail using the $Sendmail program.
Get the server hostname.
Returns 'localhost.localdomain' if unknown.
Set or reset instance properties.
Usage Example: $page->set('X-Priority', '3');
Add an error message to the error container.
Set the From and FromName properties.
Set the language for error messages.
Returns false if it cannot load the language file. The default language is English.
Set the message type.
PHPMailer only supports some preset message types, not arbitrary MIME structures.
Set the body wrapping.
Set the public and private key files and password for S/MIME signing.
Close the active SMTP session if one exists.
Initiate a connection to an SMTP server.
Returns false if the operation failed.
Send mail via SMTP.
Returns false if there is a bad MAIL FROM, RCPT, or DATA input. Uses the PHPMailerSMTP class by default.
Return a formatted mail line.
Find the last character boundary prior to $maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
Word-wrap message.
For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.
SMTP RFC standard line ending
Error severity: message, likely ok to continue processing
Error severity: message, plus full stop, critical error reached
Error severity: message only, continue processing
Documentation generated on Sat, 25 Oct 2014 20:22:56 +0200 by phpDocumentor 1.4.4