PHPMailer - PHP email transport class
Located in /shared/phpmailer/class.phpmailer.php (line 28)
Class | Description |
---|---|
C_mailer | C_mailer - PHPMailer class extension |
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.
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'.
Method to send mail: ("mail", "sendmail", or "smtp").
Sets SMTP password.
Path to PHPMailer plugins. This is now only 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.
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 the Subject of the message.
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
Sets SMTP username.
Holds PHPMailer version.
Sets word wrapping on the body of the message to a given number of characters.
Adds a "To" address.
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.
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.
Encodes attachment in requested format. Returns an empty string on failure.
Encode a header string to best of Q, B, quoted or none.
Encode string to q encoding.
Encode string to quoted-printable.
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.
Returns the start of a message boundary.
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.
Returns the proper RFC 822 formatted date.
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.
Returns the appropriate server variable. Should work with both PHP 4.1.0+ as well as older versions. Returns an empty string if nothing is found.
Adds the error message to the error container.
Returns void.
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
Sets the message type.
Set the body wrapping.
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 (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Returns a formatted mail line.
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 Nov 2006 21:16:04 +0100 by phpDocumentor 1.3.0RC3