$AltBody = ''
[line 111]
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.
Tags:
$attachment = array()
[line 260]
Tags:
$bcc = array()
[line 258]
Tags:
$Body = ''
[line 102]
Sets the Body of the message. This can be either an HTML or text body.
If HTML then run IsHTML(true).
Tags:
$boundary = array()
[line 263]
Tags:
$cc = array()
[line 257]
Tags:
$CharSet = 'iso-8859-1'
[line 51]
Sets the CharSet of the message.
Tags:
$ConfirmReadingTo = ''
[line 149]
Sets the email address that a reading confirmation will be sent.
Tags:
$ContentType = 'text/plain'
[line 57]
Sets the Content-type of the message.
Tags:
$CustomHeader = array()
[line 261]
Tags:
$Encoding = '8bit'
[line 64]
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Tags:
$ErrorInfo = ''
[line 70]
Holds the most recent mailer error message.
Tags:
$error_count = 0
[line 265]
Tags:
$From = 'root@localhost'
[line 76]
Sets the From email address for the message.
Tags:
$FromName = 'Root User'
[line 82]
Sets the From name of the message.
Tags:
$Helo = ''
[line 190]
Sets the SMTP HELO of the message (Default is $Hostname).
Tags:
$Host = 'localhost'
[line 178]
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.
Tags:
$Hostname = ''
[line 157]
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'.
Tags:
$language = array()
[line 264]
Tags:
$LE = "\r\n"
[line 249]
Provides the ability to change the line ending
Tags:
$Mailer = 'mail'
[line 124]
Method to send mail: ("mail", "sendmail", or "smtp").
Tags:
$MessageID = ''
[line 164]
Sets the message ID to be used in the Message-Id header.
If empty, a unique id will be generated.
Tags:
$message_type = ''
[line 262]
Tags:
$Password = ''
[line 215]
Sets SMTP password.
Tags:
$PluginDir = ''
[line 137]
Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.
Tags:
$Port = 25
[line 184]
Sets the default SMTP server port.
Tags:
$Priority = 3
[line 45]
Email priority (1 = High, 3 = Normal, 5 = low).
Tags:
$ReplyTo = array()
[line 259]
Tags:
$Sender = ''
[line 89]
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.
Tags:
$Sendmail = '/usr/sbin/sendmail'
[line 130]
Sets the path of the sendmail program.
Tags:
$sign_cert_file = ""
[line 266]
Tags:
$sign_key_file = ""
[line 267]
Tags:
$sign_key_pass = ""
[line 268]
Tags:
$SingleTo = false
[line 243]
Provides the ability to have the TO field process individual
emails, instead of sending to entire TO addresses
Tags:
$smtp = NULL
[line 255]
Tags:
$SMTPAuth = false
[line 203]
Sets SMTP authentication. Utilizes the Username and Password variables.
Tags:
$SMTPDebug = false
[line 228]
Sets SMTP class debugging on or off.
Tags:
$SMTPKeepAlive = false
[line 236]
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().
Tags:
$SMTPSecure = ""
[line 197]
Sets connection prefix.
Options are "", "ssl" or "tls"
Tags:
$Subject = ''
[line 95]
Sets the Subject of the message.
Tags:
$Timeout = 10
[line 222]
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
Tags:
$to = array()
[line 256]
Tags:
$Username = ''
[line 209]
Sets SMTP username.
Tags:
$Version = "2.3"
[line 143]
Holds PHPMailer version.
Tags:
$WordWrap = 0
[line 118]
Sets word wrapping on the body of the message to a given number of characters.
Tags:
static method RFCDate [line 1635]
Returns the proper RFC 822 formatted date.
Tags:
method AddAddress [line 330]
void AddAddress(
string
$address, [string
$name = ''])
|
|
Adds a "To" address.
Tags:
Parameters:
method AddAttachment [line 1139]
bool AddAttachment(
string
$path, [string
$name = ''], [string
$encoding = 'base64'], [string
$type = 'application/octet-stream'])
|
|
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found or accessed.
Tags:
Parameters:
method AddBCC [line 358]
void AddBCC(
string
$address, [string
$name = ''])
|
|
Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Tags:
Parameters:
method AddCC [line 344]
void AddCC(
string
$address, [string
$name = ''])
|
|
Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Tags:
Parameters:
method AddCustomHeader [line 1705]
void AddCustomHeader(
$custom_header)
|
|
Adds a custom header.
Tags:
Parameters:
method AddEmbeddedImage [line 1508]
bool AddEmbeddedImage(
string
$path, string
$cid, [string
$name = ''], [string
$encoding = 'base64'], [string
$type = 'application/octet-stream'])
|
|
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".
Tags:
Parameters:
method AddrAppend [line 696]
string AddrAppend(
$type,
$addr)
|
|
Creates recipient headers.
Tags:
Parameters:
method AddReplyTo [line 370]
void AddReplyTo(
string
$address, [string
$name = ''])
|
|
Adds a "Reply-to" address.
Tags:
Parameters:
method AddrFormat [line 714]
string AddrFormat(
$addr)
|
|
Formats an address correctly.
Tags:
Parameters:
method AddStringAttachment [line 1482]
void AddStringAttachment(
string
$string, string
$filename, [string
$encoding = 'base64'], [string
$type = 'application/octet-stream'])
|
|
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.
Tags:
Parameters:
method AttachAll [line 1169]
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
Tags:
method Base64EncodeWrapMB [line 1363]
string Base64EncodeWrapMB(
string
$str)
|
|
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
Tags:
Parameters:
method ClearAddresses [line 1559]
Clears all recipients assigned in the TO array. Returns void.
Tags:
method ClearAllRecipients [line 1592]
void ClearAllRecipients(
)
|
|
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Tags:
method ClearAttachments [line 1603]
Clears all previously set filesystem, string, and binary attachments. Returns void.
Tags:
method ClearBCCs [line 1575]
Clears all recipients assigned in the BCC array. Returns void.
Tags:
method ClearCCs [line 1567]
Clears all recipients assigned in the CC array. Returns void.
Tags:
method ClearCustomHeaders [line 1611]
void ClearCustomHeaders(
)
|
|
Clears all custom headers. Returns void.
Tags:
method ClearReplyTos [line 1583]
Clears all recipients assigned in the ReplyTo array. Returns void.
Tags:
method CreateBody [line 985]
Assembles the message body. Returns an empty string on failure.
Tags:
method CreateHeader [line 873]
Assembles message header.
Tags:
method EncodeFile [line 1229]
string EncodeFile(
$path, [
$encoding = 'base64'])
|
|
Encodes attachment in requested format. Returns an empty string on failure.
Tags:
Parameters:
method EncodeHeader [line 1286]
string EncodeHeader(
$str, [
$position = 'text'])
|
|
Encode a header string to best of Q, B, quoted or none.
Tags:
Parameters:
method EncodeQ [line 1448]
string EncodeQ(
$str, [
$position = 'text'])
|
|
Encode string to q encoding.
Tags:
Parameters:
method EncodeQP [line 1402]
string EncodeQP(
[
$input = ''], [integer
$line_max = 76], [
$space_conv = false], string
$string)
|
|
Encode string to quoted-printable.
Tags:
Parameters:
method EncodeString [line 1256]
string EncodeString(
$str, [
$encoding = 'base64'])
|
|
Encodes string to requested format. Returns an empty string on failure.
Tags:
Parameters:
method EndBoundary [line 1083]
void EndBoundary(
$boundary)
|
|
Returns the end of a message boundary.
Tags:
Parameters:
method FixEOL [line 1693]
Changes every end of line from CR or LF to CRLF.
Tags:
Parameters:
method GetBoundary [line 1059]
void GetBoundary(
$boundary,
$charSet,
$contentType,
$encoding)
|
|
Returns the start of a message boundary.
Tags:
Parameters:
method getFile [line 1870]
void getFile(
string
$filename)
|
|
Read a file from a supplied filename and return it.
Tags:
Parameters:
method GetMailMIME [line 950]
Returns the message MIME.
Tags:
method HasMultiBytes [line 1347]
bool HasMultiBytes(
string
$str)
|
|
Checks if a string contains multibyte characters.
Tags:
Parameters:
method HeaderLine [line 1112]
void HeaderLine(
$name,
$value)
|
|
Tags:
Parameters:
method InlineImageExists [line 1539]
bool InlineImageExists(
)
|
|
Returns true if an inline attachment is present.
Tags:
method IsError [line 1684]
Returns true if an error occurred.
Tags:
method IsHTML [line 279]
Sets message type to HTML.
Tags:
Parameters:
method IsMail [line 299]
Sets Mailer to send message using PHP mail() function.
Tags:
method IsQmail [line 315]
Sets Mailer to send message using the qmail MTA.
Tags:
method IsSendmail [line 307]
Sets Mailer to send message using the $Sendmail program.
Tags:
method IsSMTP [line 291]
Sets Mailer to send message using SMTP.
Tags:
method Lang [line 1667]
Returns a message in the appropriate language.
Tags:
Overridden in child classes as:
- C_mailer::Lang()
- Returns a message in the appropriate language.
Parameters:
method MailSend [line 469]
bool MailSend(
$header,
$body)
|
|
Sends mail using the PHP mail() function.
Tags:
Parameters:
method MsgHTML [line 1714]
$message MsgHTML(
$message, [
$basedir = ''])
|
|
Evaluates the message and returns modifications for inline images and backgrounds
Tags:
Parameters:
method SecureHeader [line 1889]
string SecureHeader(
string
$str)
|
|
Strips newlines to prevent header injection.
Tags:
Parameters:
method Send [line 386]
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.
Tags:
method SendmailSend [line 437]
bool SendmailSend(
$header,
$body)
|
|
Sends mail using the $Sendmail program.
Tags:
Parameters:
method ServerHostname [line 1650]
Returns the server hostname or 'localhost.localdomain' if unknown.
Tags:
method set [line 1855]
void set(
string
$name, [mixed
$value = ''])
|
|
Set (or reset) Class Objects (variables)
Usage Example: $page->set('X-Priority', '3');
Tags:
Parameters:
method SetError [line 1625]
Adds the error message to the error container.
Returns void.
Tags:
Overridden in child classes as:
- C_mailer::SetError()
- Replace the default SetError
Parameters:
method SetLanguage [line 666]
bool SetLanguage(
[string
$lang_type = 'en'], [string
$lang_path = 'language/'])
|
|
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
Tags:
Parameters:
method SetMessageType [line 1092]
Sets the message type.
Tags:
method SetWordWrap [line 851]
Set the body wrapping.
Tags:
method Sign [line 1903]
void Sign(
$cert_filename, string
$key_filename, string
$key_pass)
|
|
Set the private key file and password to sign the message.
Tags:
Parameters:
method SmtpClose [line 648]
Closes the active SMTP session if one exists.
Tags:
method SmtpConnect [line 586]
Initiates a connection to an SMTP server. Returns false if the operation failed.
Tags:
method SmtpSend [line 519]
bool SmtpSend(
$header,
$body)
|
|
Sends mail via SMTP using PhpSMTP (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Tags:
Parameters:
method TextLine [line 1121]
Returns a formatted mail line.
Tags:
Parameters:
method UTF8CharBoundary [line 813]
int UTF8CharBoundary(
string
$encodedText, int
$maxLength)
|
|
Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string.
Original written by Colin Brown.
Tags:
Parameters:
method WrapText [line 731]
string WrapText(
$message,
$length, [
$qp_mode = false])
|
|
Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable.
Original written by philippe.
Tags:
Parameters:
method _mime_types [line 1751]
mime _mime_types(
[
$ext = ''])
|
|
Gets the mime type of the embedded or inline image
Tags:
Parameters: