| Package | PHPMailer |
| Author | Andy Prevost |
| Copyright | 2004 - 2009 Andy Prevost |

class PHPMailer
| Package | PHPMailer |
| Author | Andy Prevost |
| Copyright | 2004 - 2009 Andy Prevost |
| + $AltBody | Sets the text-only body of the message |
| + $Body | Sets the Body of the message |
| + $CharSet | Sets the CharSet of the message |
| + $ConfirmReadingTo | Sets the email address that a reading confirmation will be sent |
| + $ContentType | Sets the Content-type of the message |
| + $CustomHeader | |
| + $Encoding | Sets the Encoding of the message |
| + $ErrorInfo | Holds the most recent mailer error message |
| + $From | Sets the From email address for the message |
| + $FromName | Sets the From name of the message |
| + $Helo | Sets the SMTP HELO of the message (Default is $Hostname) |
| + $Host | Sets the SMTP hosts |
| + $Hostname | Sets the hostname to use in Message-Id and Received headers |
| + $LE | |
| + $Mailer | Method to send mail: ("mail", "sendmail", or "smtp") |
| + $MessageID | Sets the message ID to be used in the Message-Id header. |
| + $Password | Sets SMTP password |
| + $PluginDir | Path to PHPMailer plugins |
| + $Port | Sets the default SMTP server port |
| + $Priority | Email priority (1 = High, 3 = Normal, 5 = low) |
| + $ReplyTo | |
| + $SMTPAuth | Sets SMTP authentication |
| + $SMTPDebug | Sets SMTP class debugging on or off |
| + $SMTPKeepAlive | Prevents the SMTP connection from being closed after each mail |
| + $SMTPSecure | Sets connection prefix. |
| + $Sender | Sets the Sender email (Return-Path) of the message |
| + $Sendmail | Sets the path of the sendmail program |
| + $SingleTo | Provides the ability to have the TO field process individual |
| + $Subject | Sets the Subject of the message |
| + $Timeout | Sets the SMTP server timeout in seconds |
| + $Username | Sets SMTP username |
| + $Version | Holds PHPMailer version |
| + $WordWrap | Sets word wrapping on the body of the message to a given number of |
| + $attachment | |
| + $bcc | |
| + $boundary | |
| + $cc | |
| + $error_count | |
| + $language | |
| + $message_type | |
| + $sign_cert_file | |
| + $sign_key_file | |
| + $sign_key_pass | |
| + $smtp | |
| + $to |
| + AddAddress() | Adds a "To" address |
| + AddAttachment() | Adds an attachment from a path on the filesystem. |
| + AddBCC() | Adds a "Bcc" address |
| + AddCC() | Adds a "Cc" address |
| + AddCustomHeader() | Adds a custom header |
| + AddEmbeddedImage() | Adds an embedded attachment |
| + AddReplyTo() | Adds a "Reply-To" address |
| + AddStringAttachment() | Adds a string or binary attachment (non-filesystem) to the list. |
| + AddrAppend() | Creates recipient headers |
| + AddrFormat() | Formats an address correctly |
| + AttachAll() | Attaches all fs, string, and binary attachments to the message. |
| + Base64EncodeWrapMB() | Correctly encodes and wraps long multibyte strings for mail headers |
| + ClearAddresses() | Clears all recipients assigned in the TO array |
| + ClearAllRecipients() | Clears all recipients assigned in the TO, CC and BCC |
| + ClearAttachments() | Clears all previously set filesystem, string, and binary |
| + ClearBCCs() | Clears all recipients assigned in the BCC array |
| + ClearCCs() | Clears all recipients assigned in the CC array |
| + ClearCustomHeaders() | Clears all custom headers |
| + ClearReplyTos() | Clears all recipients assigned in the ReplyTo array |
| + CreateBody() | Assembles the message body |
| + CreateHeader() | Assembles message header |
| + EncodeFile() | Encodes attachment in requested format |
| + EncodeHeader() | Encode a header string to best of Q, B, quoted or none |
| + EncodeQ() | Encode string to q encoding |
| + EncodeQP() | Encode string to quoted-printable |
| + EncodeQ_callback() | Callback for converting to "=XX" |
| + EncodeString() | Encodes string to requested format |
| + EndBoundary() | Returns the end of a message boundary |
| + FixEOL() | Changes every end of line from CR or LF to CRLF |
| + GetBoundary() | Returns the start of a message boundary |
| + GetMailMIME() | Returns the message MIME |
| + HasMultiBytes() | Checks if a string contains multibyte characters |
| + HeaderLine() | |
| + InlineImageExists() | Returns true if an inline attachment is present |
| + IsError() | Returns true if an error occurred |
| + IsHTML() | Sets message type to HTML |
| + IsMail() | Sets Mailer to send message using PHP mail() function |
| + IsQmail() | Sets Mailer to send message using the qmail MTA |
| + IsSMTP() | Sets Mailer to send message using SMTP |
| + IsSendmail() | Sets Mailer to send message using the $Sendmail program |
| + Lang() | Returns a message in the appropriate language |
| + MailSend() | Sends mail using the PHP mail() function |
| + MsgHTML() | Evaluates the message and returns modifications for inline images and backgrounds |
| + RFCDate() | Returns the proper RFC 822 formatted date |
| + SecureHeader() | Strips newlines to prevent header injection |
| + Send() | Creates message and assigns Mailer |
| + SendmailSend() | Sends mail using the $Sendmail program |
| + ServerHostname() | Returns the server hostname or 'localhost.localdomain' if unknown |
| + ServerVar() | Returns the appropriate server variable |
| + SetError() | Adds the error message to the error container. |
| + SetLanguage() | Sets the language for all class error messages |
| + SetMessageType() | Sets the message type |
| + SetWordWrap() | Set the body wrapping |
| + Sign() | Set the private key file and password to sign the message |
| + SmtpClose() | Closes the active SMTP session if one exists |
| + SmtpConnect() | Initiates a connection to an SMTP server |
| + SmtpSend() | Sends mail via SMTP using PhpSMTP (Author: |
| + TextLine() | Returns a formatted mail line |
| + UTF8CharBoundary() | Finds last character boundary prior to maxLength in a utf-8 |
| + WrapText() | Wraps message for use with mailers that do not |
| + _mime_types() | Gets the mime type of the embedded or inline image |
| + getFile() | Read a file from a supplied filename and return it |
| + set() | Set (or reset) Class Objects (variables) |
var $AltBody = ''var $Body = ''var $CharSet = 'iso-8859-1'var $ConfirmReadingTo = ''var $ContentType = 'text/plain'var $Encoding = '8bit'var $ErrorInfo = ''var $From = 'root@localhost'var $FromName = 'Root User'var $Helo = ''SMTP HELO of the message (Default is $Hostname).var $Host = 'localhost'SMTP hosts. All hosts must be separated by avar $Hostname = ''var $Mailer = 'mail'var $MessageID = ''var $Password = ''SMTP password.var $PluginDir = ''PHPMailer plugins. This is now only useful if the SMTP classvar $Port = 25SMTP server port.var $Priority = 3var $SMTPAuth = falseSMTP authentication. Utilizes the Username and Password variables.var $SMTPDebug = falseSMTP class debugging on or off.var $SMTPKeepAlive = falseSMTP connection from being closed after each mailvar $SMTPSecure = ""var $Sender = ''var $Sendmail = '/usr/sbin/sendmail'var $SingleTo = falsevar $Subject = ''var $Timeout = 10SMTP server timeout in seconds. This function will notvar $Username = ''SMTP username.var $Version = "2.0.4"PHPMailer version.var $WordWrap = 0
function AddAddress( |
$address)
|
string $address |
|
string $name |
function AddAttachment( |
$path)
|
string $path |
Path to the attachment. |
string $name |
Overrides the attachment name. |
string $encoding |
File encoding (see $Encoding). |
string $type |
File extension (MIME) type. |
function AddBCC( |
$address)
|
SMTP mailer on win32, not with the "mail"string $address |
|
string $name |
function AddCC( |
$address)
|
SMTP mailer on win32, not with the "mail"string $address |
|
string $name |
function AddCustomHeader( |
$custom_header)
|
$custom_header |
function AddEmbeddedImage( |
$path)
|
string $path |
Path to the attachment. |
string $cid |
Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form. |
string $name |
Overrides the attachment name. |
string $encoding |
File encoding (see $Encoding). |
string $type |
File extension (MIME) type. |
function AddReplyTo( |
$address)
|
string $address |
|
string $name |
function AddStringAttachment( |
$string)
|
string $string |
String attachment data. |
string $filename |
Name of the attachment. |
string $encoding |
File encoding (see $Encoding). |
string $type |
File extension (MIME) type. |
function AddrAppend( |
$type)
|
$type |
|
$addr |
function AddrFormat( |
$addr)
|
$addr |
function AttachAll( |
)
|
function Base64EncodeWrapMB( |
$str)
|
string $str |
multi-byte text to wrap encode |
function ClearAddresses( |
)
|
function ClearAllRecipients( |
)
|
function ClearAttachments( |
)
|
function ClearBCCs( |
)
|
function ClearCCs( |
)
|
function ClearCustomHeaders( |
)
|
function ClearReplyTos( |
)
|
function CreateBody( |
)
|
function CreateHeader( |
)
|
function EncodeFile( |
$path)
|
$path |
|
$encoding |
function EncodeHeader( |
$str)
|
$str |
|
$position |
function EncodeQ( |
$str)
|
$str |
|
$position |
function EncodeQP( |
$input = '')
|
$input |
|
$line_max |
|
$space_conv |
function EncodeQ_callback( |
$matches)
|
$matches |
function EncodeString( |
$str)
|
$str |
|
$encoding |
function EndBoundary( |
$boundary)
|
$boundary |
function FixEOL( |
$str)
|
$str |
function GetBoundary( |
$boundary)
|
$boundary |
|
$charSet |
|
$contentType |
|
$encoding |
function GetMailMIME( |
)
|
function HasMultiBytes( |
$str)
|
string $str |
multi-byte text to wrap encode |
function HeaderLine( |
$name)
|
$name |
|
$value |
function InlineImageExists( |
)
|
function IsError( |
)
|
function IsHTML( |
$bool)
|
bool $bool |
function IsMail( |
)
|
function IsQmail( |
)
|
function IsSMTP( |
)
|
SMTP.
function IsSendmail( |
)
|
function Lang( |
$key)
|
$key |
function MailSend( |
$header)
|
$header |
|
$body |
function MsgHTML( |
$message)
|
$message |
|
$basedir |
function RFCDate( |
)
|
function SecureHeader( |
$str)
|
string $str |
String |
function Send( |
)
|
function SendmailSend( |
$header)
|
$header |
|
$body |
function ServerHostname( |
)
|
function ServerVar( |
$varName)
|
$varName |
function SetError( |
$msg)
|
$msg |
function SetLanguage( |
$lang_type)
|
string $lang_type |
Type of language (e.g. Portuguese: "br") |
string $lang_path |
Path to the language file directory |
function SetMessageType( |
)
|
function SetWordWrap( |
)
|
function Sign( |
$cert_filename)
|
$cert_filename |
|
string $key_filename |
Parameter File Name |
string $key_pass |
Password for private key |
function SmtpClose( |
)
|
SMTP session if one exists.
function SmtpConnect( |
)
|
SMTP server. Returns false if the
function SmtpSend( |
$header)
|
SMTP using PhpSMTP (Author:$header |
|
$body |
function TextLine( |
$value)
|
$value |
function UTF8CharBoundary( |
$encodedText)
|
string $encodedText |
utf-8 QP text |
int $maxLength |
find last character boundary prior to this length |
function WrapText( |
$message)
|
$message |
|
$length |
|
$qp_mode |
function _mime_types( |
$ext = '')
|
$ext |
function getFile( |
$filename)
|
string $filename |
Parameter File Name |
function set( |
$name)
|
string $name |
Parameter Name |
mixed $value |
Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset |