$action_function = ''
[line 307]
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
Tags:
$all_recipients = array()
[line 324]
Tags:
$AltBody = ''
[line 129]
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 325]
Tags:
$bcc = array()
[line 322]
Tags:
$Body = ''
[line 120]
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 328]
Tags:
$cc = array()
[line 321]
Tags:
$CharSet = 'iso-8859-1'
[line 69]
Sets the CharSet of the message.
Tags:
$ConfirmReadingTo = ''
[line 161]
Sets the email address that a reading confirmation will be sent.
Tags:
$ContentType = 'text/plain'
[line 75]
Sets the Content-type of the message.
Tags:
$CustomHeader = array()
[line 326]
Tags:
$DKIM_domain = ''
[line 287]
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Tags:
$DKIM_identity = ''
[line 280]
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Tags:
$DKIM_private = ''
[line 294]
Used with DKIM DNS Resource Record
optional, in format of email address 'you@yourdomain.com'
Tags:
$DKIM_selector = 'phpmailer'
[line 273]
Used with DKIM DNS Resource Record
Tags:
$Encoding = '8bit'
[line 82]
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Tags:
$ErrorInfo = ''
[line 88]
Holds the most recent mailer error message.
Tags:
$error_count = 0
[line 330]
Tags:
$exceptions = false
[line 334]
Tags:
$From = 'root@localhost'
[line 94]
Sets the From email address for the message.
Tags:
$FromName = 'Root User'
[line 100]
Sets the From name of the message.
Tags:
$Helo = ''
[line 202]
Sets the SMTP HELO of the message (Default is $Hostname).
Tags:
$Host = 'localhost'
[line 190]
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 169]
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 329]
Tags:
$LE = "\n"
[line 267]
Provides the ability to change the line ending
Tags:
$Mailer = 'mail'
[line 142]
Method to send mail: ("mail", "sendmail", or "smtp").
Tags:
$MessageID = ''
[line 176]
Sets the message ID to be used in the Message-Id header.
If empty, a unique id will be generated.
Tags:
$message_type = ''
[line 327]
Tags:
$Password = ''
[line 227]
Sets SMTP password.
Tags:
$PluginDir = ''
[line 155]
Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
Tags:
$Port = 25
[line 196]
Sets the default SMTP server port.
Tags:
$Priority = 3
[line 63]
Email priority (1 = High, 3 = Normal, 5 = low).
Tags:
$ReplyTo = array()
[line 323]
Tags:
$Sender = ''
[line 107]
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 148]
Sets the path of the sendmail program.
Tags:
$sign_cert_file = ""
[line 331]
Tags:
$sign_key_file = ""
[line 332]
Tags:
$sign_key_pass = ""
[line 333]
Tags:
$SingleTo = false
[line 255]
Provides the ability to have the TO field process individual
emails, instead of sending to entire TO addresses
Tags:
$SingleToArray = array()
[line 261]
If SingleTo is true, this provides the array to hold the email addresses
Tags:
$smtp = NULL
[line 319]
Tags:
$SMTPAuth = false
[line 215]
Sets SMTP authentication. Utilizes the Username and Password variables.
Tags:
$SMTPDebug = false
[line 240]
Sets SMTP class debugging on or off.
Tags:
$SMTPKeepAlive = false
[line 248]
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 209]
Sets connection prefix.
Options are "", "ssl" or "tls"
Tags:
$Subject = ''
[line 113]
Sets the Subject of the message.
Tags:
$Timeout = 10
[line 234]
Sets the SMTP server timeout in seconds.
This function will not work with the win32 version.
Tags:
$to = array()
[line 320]
Tags:
$Username = ''
[line 221]
Sets SMTP username.
Tags:
$Version = '5.1'
[line 313]
Sets the PHPMailer Version number
Tags:
$WordWrap = 0
[line 136]
Sets word wrapping on the body of the message to a given number of characters.
Tags:
static method RFCDate [line 1934]
Returns the proper RFC 822 formatted date.
Tags:
static method ValidateAddress [line 533]
static boolean ValidateAddress(
string
$address)
|
|
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
Tags:
Overridden in child classes as:
- C_mailer::ValidateAddress()
- Check that a string looks roughly like an email address should (override original ValidateAddress method).
Parameters:
static method _mime_types [line 2051]
static string _mime_types(
[string
$ext = ''])
|
|
Gets the MIME type of the embedded or inline image
Tags:
Parameters:
constructor __construct [line 352]
PHPMailer __construct(
[boolean
$exceptions = false])
|
|
Constructor
Tags:
Parameters:
method AddAddress [line 417]
boolean AddAddress(
string
$address, [string
$name = ''])
|
|
Adds a "To" address.
Tags:
Parameters:
method AddAnAddress [line 462]
boolean AddAnAddress(
string
$kind, string
$address, [string
$name = ''])
|
|
Adds an address to one of the recipient arrays
Addresses that have been added already return false, but do not throw exceptions
Tags:
Parameters:
method AddAttachment [line 1354]
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 439]
boolean 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 428]
boolean 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 2004]
void AddCustomHeader(
$custom_header)
|
|
Adds a custom header.
Tags:
Parameters:
method AddEmbeddedImage [line 1793]
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 907]
string AddrAppend(
$type,
$addr)
|
|
Creates recipient headers.
Tags:
Parameters:
method AddReplyTo [line 449]
boolean AddReplyTo(
string
$address, [string
$name = ''])
|
|
Adds a "Reply-to" address.
Tags:
Parameters:
method AddrFormat [line 924]
string AddrFormat(
$addr)
|
|
Formats an address correctly.
Tags:
Parameters:
method AddStringAttachment [line 1766]
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 1402]
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
Tags:
method Base64EncodeWrapMB [line 1609]
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 1842]
Clears all recipients assigned in the TO array. Returns void.
Tags:
method ClearAllRecipients [line 1884]
void ClearAllRecipients(
)
|
|
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Tags:
method ClearAttachments [line 1896]
Clears all previously set filesystem, string, and binary attachments. Returns void.
Tags:
method ClearBCCs [line 1864]
Clears all recipients assigned in the BCC array. Returns void.
Tags:
method ClearCCs [line 1853]
Clears all recipients assigned in the CC array. Returns void.
Tags:
method ClearCustomHeaders [line 1904]
void ClearCustomHeaders(
)
|
|
Clears all custom headers. Returns void.
Tags:
method ClearReplyTos [line 1875]
Clears all recipients assigned in the ReplyTo array. Returns void.
Tags:
method CreateBody [line 1200]
Assembles the message body. Returns an empty string on failure.
Tags:
method CreateHeader [line 1083]
Assembles message header.
Tags:
method DKIM_Add [line 2281]
void DKIM_Add(
string
$headers_line, string
$subject, string
$body)
|
|
Create the DKIM header, body, as new header
Tags:
Parameters:
method DKIM_BodyC [line 2261]
void DKIM_BodyC(
string
$body)
|
|
Generate DKIM Canonicalization Body
Tags:
Parameters:
method DKIM_HeaderC [line 2242]
void DKIM_HeaderC(
string
$s)
|
|
Generate DKIM Canonicalization Header
Tags:
Parameters:
method DKIM_QP [line 2204]
void DKIM_QP(
$txt, string
$key_filename, string
$key_pass)
|
|
Set the private key file and password to sign the message.
Tags:
Parameters:
method DKIM_Sign [line 2224]
void DKIM_Sign(
string
$s)
|
|
Generate DKIM signature
Tags:
Parameters:
method doCallback [line 2316]
void doCallback(
$isSent,
$to,
$cc,
$bcc,
$subject,
$body)
|
|
Tags:
Parameters:
method EncodeFile [line 1469]
string EncodeFile(
string
$path, [string
$encoding = 'base64'])
|
|
Encodes attachment in requested format.
Returns an empty string on failure.
Tags:
Parameters:
method EncodeHeader [line 1532]
string EncodeHeader(
$str, [
$position = 'text'])
|
|
Encode a header string to best (shortest) of Q, B, quoted or none.
Tags:
Parameters:
method EncodeQ [line 1731]
string EncodeQ(
string
$str, [string
$position = 'text'])
|
|
Encode string to q encoding.
Tags:
Parameters:
method EncodeQP [line 1702]
string EncodeQP(
string
$string, [integer
$line_max = 76], [boolean
$space_conv = false])
|
|
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
Tags:
Parameters:
method EncodeQPphp [line 1649]
string EncodeQPphp(
[
$input = ''], [integer
$line_max = 76], [
$space_conv = false], string
$string)
|
|
Encode string to quoted-printable.
Only uses standard PHP, slow, but will always work
Tags:
Parameters:
method EncodeString [line 1501]
string EncodeString(
string
$str, [string
$encoding = 'base64'])
|
|
Encodes string to requested format.
Returns an empty string on failure.
Tags:
Parameters:
method EndBoundary [line 1297]
void EndBoundary(
$boundary)
|
|
Returns the end of a message boundary.
Tags:
Parameters:
method FixEOL [line 1992]
Changes every end of line from CR or LF to CRLF.
Tags:
Parameters:
method GetAttachments [line 1392]
Return the current array of attachments
Tags:
method GetBoundary [line 1273]
void GetBoundary(
$boundary,
$charSet,
$contentType,
$encoding)
|
|
Returns the start of a message boundary.
Tags:
Parameters:
method GetMailMIME [line 1166]
Returns the message MIME.
Tags:
method GetTranslations [line 894]
Return the current array of language strings
Tags:
method HasMultiBytes [line 1593]
bool HasMultiBytes(
string
$str)
|
|
Checks if a string contains multibyte characters.
Tags:
Parameters:
method HeaderLine [line 1327]
string HeaderLine(
$name,
$value)
|
|
Returns a formatted header line.
Tags:
Parameters:
method InlineImageExists [line 1825]
bool InlineImageExists(
)
|
|
Returns true if an inline attachment is present.
Tags:
method IsError [line 1983]
Returns true if an error occurred.
Tags:
method IsHTML [line 361]
void IsHTML(
[bool
$ishtml = true])
|
|
Sets message type to HTML.
Tags:
Parameters:
method IsMail [line 381]
Sets Mailer to send message using PHP mail() function.
Tags:
method IsQmail [line 400]
Sets Mailer to send message using the qmail MTA.
Tags:
method IsSendmail [line 389]
Sets Mailer to send message using the $Sendmail program.
Tags:
method IsSMTP [line 373]
Sets Mailer to send message using SMTP.
Tags:
method Lang [line 1966]
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 654]
bool MailSend(
string
$header, string
$body)
|
|
Sends mail using the PHP mail() function.
Tags:
Parameters:
method MsgHTML [line 2013]
$message MsgHTML(
$message, [
$basedir = ''])
|
|
Evaluates the message and returns modifications for inline images and backgrounds
Tags:
Parameters:
method SecureHeader [line 2178]
string SecureHeader(
string
$str)
|
|
Strips newlines to prevent header injection.
Tags:
Parameters:
method Send [line 555]
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 608]
bool SendmailSend(
string
$header, string
$body)
|
|
Sends mail using the $Sendmail program.
Tags:
Parameters:
method ServerHostname [line 1949]
Returns the server hostname or 'localhost.localdomain' if unknown.
Tags:
method set [line 2156]
void set(
string
$name, [mixed
$value = ''])
|
|
Set (or reset) Class Objects (variables)
Usage Example: $page->set('X-Priority', '3');
Tags:
Parameters:
method SetError [line 1917]
Adds the error message to the error container.
Tags:
Overridden in child classes as:
- C_mailer::SetError()
- Replace the default SetError
Parameters:
method SetFrom [line 498]
boolean SetFrom(
string
$address, [string
$name = ''], [
$auto = 1])
|
|
Set the From and FromName properties
Tags:
Parameters:
method SetLanguage [line 860]
void SetLanguage(
[string
$langcode = '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 is English.
Tags:
Parameters:
method SetMessageType [line 1306]
Sets the message type.
Tags:
method SetWordWrap [line 1062]
Set the body wrapping.
Tags:
method Sign [line 2191]
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 844]
Closes the active SMTP session if one exists.
Tags:
method SmtpConnect [line 782]
Initiates a connection to an SMTP server.
Returns false if the operation failed.
Tags:
method SmtpSend [line 711]
bool SmtpSend(
string
$header, string
$body)
|
|
Sends mail via SMTP using PhpSMTP Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Tags:
Parameters:
method TextLine [line 1336]
Returns a formatted mail line.
Tags:
Parameters:
method UTF8CharBoundary [line 1024]
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 942]
string WrapText(
string
$message, integer
$length, [boolean
$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: