PHPMailer - PHP email transport class
NOTE: Requires PHP version 5 or later
Located in /class.phpmailer.php (line 40)
Callback Action function name
the function that handles the result of the send email action. 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
Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.
Sets the Body of the message. This can be either an HTML or text body.
If HTML then run IsHTML(true).
Sets the CharSet of the message.
Sets the email address that a reading confirmation will be sent.
Sets the Content-type of the message.
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Used with DKIM DNS Resource Record
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Used with DKIM DNS Resource Record
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Holds the most recent mailer error message.
Sets the From email address for the message.
Sets the From name of the message.
Sets the SMTP HELO of the message (Default is $Hostname).
Sets the SMTP hosts. All hosts must be separated by a semicolon. 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.
Sets 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'.
Provides the ability to change the line ending
Method to send mail: ("mail", "sendmail", or "smtp").
Sets the message ID to be used in the Message-Id header.
If empty, a unique id will be generated.
Stores the complete compiled MIME message body.
Stores the complete compiled MIME message headers.
Sets SMTP password.
Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
Sets the default SMTP server port.
Email priority (1 = High, 3 = Normal, 5 = low).
Sets 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.
Sets the path of the sendmail program.
Stores the complete sent MIME message (Body and Headers)
Provides the ability to have the TO field process individual
emails, instead of sending to entire TO addresses
If SingleTo is true, this provides the array to hold the email addresses
Sets SMTP authentication. Utilizes the Username and Password variables.
Sets SMTP class debugging on or off.
Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().
Sets connection prefix.
Options are "", "ssl" or "tls"
Sets the Subject of the message.
Sets the SMTP server timeout in seconds.
This function will not work with the win32 version.
Sets SMTP username.
Sets the PHPMailer Version number
Sets word wrapping on the body of the message to a given number of characters.
What to use in the X-Mailer header
Returns the proper RFC 822 formatted date.
Check that a string looks roughly like an email address should
Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822
Gets the MIME type of the embedded or inline image
Constructor
Adds a "To" address.
Adds an address to one of the recipient arrays
Addresses that have been added already return false, but do not throw exceptions
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found or accessed.
Adds a "Bcc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Adds a "Cc" address.
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Adds a custom header.
Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif".
Creates recipient headers.
Adds a "Reply-to" address.
Formats an address correctly.
Adds a string or binary attachment (non-filesystem) to the list.
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
Clears all recipients assigned in the TO array. Returns void.
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Clears all previously set filesystem, string, and binary attachments. Returns void.
Clears all recipients assigned in the BCC array. Returns void.
Clears all recipients assigned in the CC array. Returns void.
Clears all custom headers. Returns void.
Clears all recipients assigned in the ReplyTo array. Returns void.
Assembles the message body. Returns an empty string on failure.
Assembles message header.
Create the DKIM header, body, as new header
Generate DKIM Canonicalization Body
Generate DKIM Canonicalization Header
Set the private key file and password to sign the message.
Generate DKIM signature
Encodes attachment in requested format.
Returns an empty string on failure.
Encode a header string to best (shortest) of Q, B, quoted or none.
Encode string to q encoding.
Encode string to RFC2045 (6.7) quoted-printable format
Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding
Encode string to quoted-printable.
Only uses standard PHP, slow, but will always work
Encodes string to requested format.
Returns an empty string on failure.
Returns the end of a message boundary.
Changes every end of line from CR or LF to CRLF.
Return the current array of attachments
Returns the start of a message boundary.
Returns the message MIME.
Returns the MIME message (headers and body). Only really valid post PreSend().
Return the current array of language strings
Checks if a string contains multibyte characters.
Returns a formatted header line.
Returns true if an inline attachment is present.
Returns true if an error occurred.
Sets message type to HTML.
Sets Mailer to send message using PHP mail() function.
Sets Mailer to send message using the qmail MTA.
Sets Mailer to send message using the $Sendmail program.
Sets Mailer to send message using SMTP.
Returns a message in the appropriate language.
Sends mail using the PHP mail() function.
Evaluates the message and returns modifications for inline images and backgrounds
Strips newlines to prevent header injection.
Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.
Sends mail using the $Sendmail program.
Returns the server hostname or 'localhost.localdomain' if unknown.
Set (or reset) Class Objects (variables)
Usage Example: $page->set('X-Priority', '3');
Adds the error message to the error container.
Set the From and FromName properties
Sets the language for all class error messages.
Returns false if it cannot load the language file. The default language is English.
Sets the message type.
Set the body wrapping.
Set the private key file and password to sign the message.
Closes the active SMTP session if one exists.
Initiates a connection to an SMTP server.
Returns false if the operation failed.
Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Returns a formatted mail line.
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Original written by philippe.
Documentation generated on Fri, 24 Aug 2012 01:16:45 +0200 by phpDocumentor 1.4.4