Class: PHPMailer
Source Location: /shared/phpmailer/class.phpmailer.php
PHPMailer - PHP email transport class
Author(s):
- Marcus Bointon
- Andy Prevost
Version:
- $Id: class.phpmailer.php 447 2009-05-25 01:36:38Z codeworxtech $
Copyright:
|
|
|
|
Class Details
Class Variables
$all_recipients = array()
[line 268]
Tags:
$AltBody = ''
[line 119]
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 269]
Tags:
$bcc = array()
[line 266]
Tags:
$Body = ''
[line 110]
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 272]
Tags:
$cc = array()
[line 265]
Tags:
$CharSet = 'iso-8859-1'
[line 59]
Sets the CharSet of the message.
Tags:
$ConfirmReadingTo = ''
[line 151]
Sets the email address that a reading confirmation will be sent.
Tags:
$ContentType = 'text/plain'
[line 65]
Sets the Content-type of the message.
Tags:
$CustomHeader = array()
[line 270]
Tags:
$Encoding = '8bit'
[line 72]
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
Tags:
$ErrorInfo = ''
[line 78]
Holds the most recent mailer error message.
Tags:
$error_count = 0
[line 274]
Tags:
$exceptions = false
[line 278]
Tags:
$From = 'root@localhost'
[line 84]
Sets the From email address for the message.
Tags:
$FromName = 'Root User'
[line 90]
Sets the From name of the message.
Tags:
$Helo = ''
[line 192]
Sets the SMTP HELO of the message (Default is $Hostname).
Tags:
$Host = 'localhost'
[line 180]
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 159]
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 273]
Tags:
$LE = "\n"
[line 251]
Provides the ability to change the line ending
Tags:
$Mailer = 'mail'
[line 132]
Method to send mail: ("mail", "sendmail", or "smtp").
Tags:
$MessageID = ''
[line 166]
Sets the message ID to be used in the Message-Id header. If empty, a unique id will be generated.
Tags:
$message_type = ''
[line 271]
Tags:
$Password = ''
[line 217]
Sets SMTP password.
Tags:
$PluginDir = ''
[line 145]
Path to PHPMailer plugins. Useful if the SMTP class is in a different directory than the PHP include path.
Tags:
$Port = 25
[line 186]
Sets the default SMTP server port.
Tags:
$Priority = 3
[line 53]
Email priority (1 = High, 3 = Normal, 5 = low).
Tags:
$ReplyTo = array()
[line 267]
Tags:
$Sender = ''
[line 97]
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 138]
Sets the path of the sendmail program.
Tags:
$sign_cert_file = ""
[line 275]
Tags:
$sign_key_file = ""
[line 276]
Tags:
$sign_key_pass = ""
[line 277]
Tags:
$SingleTo = false
[line 245]
Provides the ability to have the TO field process individual emails, instead of sending to entire TO addresses
Tags:
$smtp = NULL
[line 263]
Tags:
$SMTPAuth = false
[line 205]
Sets SMTP authentication. Utilizes the Username and Password variables.
Tags:
$SMTPDebug = false
[line 230]
Sets SMTP class debugging on or off.
Tags:
$SMTPKeepAlive = false
[line 238]
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 199]
Sets connection prefix. Options are "", "ssl" or "tls"
Tags:
$Subject = ''
[line 103]
Sets the Subject of the message.
Tags:
$Timeout = 10
[line 224]
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
Tags:
$to = array()
[line 264]
Tags:
$Username = ''
[line 211]
Sets SMTP username.
Tags:
$Version = '5.0.2'
[line 257]
Sets the PHPMailer Version number
Tags:
$WordWrap = 0
[line 126]
Sets word wrapping on the body of the message to a given number of characters.
Tags:
Class Methods
static method RFCDate [line 1803]
Returns the proper RFC 822 formatted date.
Tags:
static method ValidateAddress [line 469]
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:
Parameters:
static method _mime_types [line 1920]
static string _mime_types(
[string
$ext = ''])
|
|
Gets the MIME type of the embedded or inline image
Tags:
Parameters:
constructor __construct [line 296]
PHPMailer __construct(
[boolean
$exceptions = false])
|
|
Constructor
Tags:
Parameters:
method AddAddress [line 361]
boolean AddAddress(
string
$address, [string
$name = ''])
|
|
Adds a "To" address.
Tags:
Parameters:
method AddAnAddress [line 406]
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 1223]
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 383]
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 372]
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 1873]
void AddCustomHeader(
$custom_header)
|
|
Adds a custom header.
Tags:
Parameters:
method AddEmbeddedImage [line 1662]
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 782]
string AddrAppend(
$type,
$addr)
|
|
Creates recipient headers.
Tags:
Parameters:
method AddReplyTo [line 393]
boolean AddReplyTo(
string
$address, [string
$name = ''])
|
|
Adds a "Reply-to" address.
Tags:
Parameters:
method AddrFormat [line 799]
string AddrFormat(
$addr)
|
|
Formats an address correctly.
Tags:
Parameters:
method AddStringAttachment [line 1635]
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 1271]
Attaches all fs, string, and binary attachments to the message. Returns an empty string on failure.
Tags:
method Base64EncodeWrapMB [line 1478]
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 1711]
Clears all recipients assigned in the TO array. Returns void.
Tags:
method ClearAllRecipients [line 1753]
void ClearAllRecipients(
)
|
|
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
Tags:
method ClearAttachments [line 1765]
Clears all previously set filesystem, string, and binary attachments. Returns void.
Tags:
method ClearBCCs [line 1733]
Clears all recipients assigned in the BCC array. Returns void.
Tags:
method ClearCCs [line 1722]
Clears all recipients assigned in the CC array. Returns void.
Tags:
method ClearCustomHeaders [line 1773]
void ClearCustomHeaders(
)
|
|
Clears all custom headers. Returns void.
Tags:
method ClearReplyTos [line 1744]
Clears all recipients assigned in the ReplyTo array. Returns void.
Tags:
method CreateBody [line 1069]
Assembles the message body. Returns an empty string on failure.
Tags:
method CreateHeader [line 958]
Assembles message header.
Tags:
method EncodeFile [line 1338]
string EncodeFile(
string
$path, [string
$encoding = 'base64'])
|
|
Encodes attachment in requested format. Returns an empty string on failure.
Tags:
Parameters:
method EncodeHeader [line 1401]
string EncodeHeader(
$str, [
$position = 'text'])
|
|
Encode a header string to best (shortest) of Q, B, quoted or none.
Tags:
Parameters:
method EncodeQ [line 1600]
string EncodeQ(
string
$str, [string
$position = 'text'])
|
|
Encode string to q encoding.
Tags:
Parameters:
method EncodeQP [line 1571]
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 1518]
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 1370]
string EncodeString(
string
$str, [string
$encoding = 'base64'])
|
|
Encodes string to requested format. Returns an empty string on failure.
Tags:
Parameters:
method EndBoundary [line 1166]
void EndBoundary(
$boundary)
|
|
Returns the end of a message boundary.
Tags:
Parameters:
method FixEOL [line 1861]
Changes every end of line from CR or LF to CRLF.
Tags:
Parameters:
method GetAttachments [line 1261]
Return the current array of attachments
Tags:
method GetBoundary [line 1142]
void GetBoundary(
$boundary,
$charSet,
$contentType,
$encoding)
|
|
Returns the start of a message boundary.
Tags:
Parameters:
method GetMailMIME [line 1035]
Returns the message MIME.
Tags:
method GetTranslations [line 769]
Return the current array of language strings
Tags:
method HasMultiBytes [line 1462]
bool HasMultiBytes(
string
$str)
|
|
Checks if a string contains multibyte characters.
Tags:
Parameters:
method HeaderLine [line 1196]
string HeaderLine(
$name,
$value)
|
|
Returns a formatted header line.
Tags:
Parameters:
method InlineImageExists [line 1694]
bool InlineImageExists(
)
|
|
Returns true if an inline attachment is present.
Tags:
method IsError [line 1852]
Returns true if an error occurred.
Tags:
method IsHTML [line 305]
void IsHTML(
[bool
$ishtml = true])
|
|
Sets message type to HTML.
Tags:
Parameters:
method IsMail [line 325]
Sets Mailer to send message using PHP mail() function.
Tags:
method IsQmail [line 344]
Sets Mailer to send message using the qmail MTA.
Tags:
method IsSendmail [line 333]
Sets Mailer to send message using the $Sendmail program.
Tags:
method IsSMTP [line 317]
Sets Mailer to send message using SMTP.
Tags:
method Lang [line 1835]
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 564]
bool MailSend(
string
$header, string
$body)
|
|
Sends mail using the PHP mail() function.
Tags:
Parameters:
method MsgHTML [line 1882]
$message MsgHTML(
$message, [
$basedir = ''])
|
|
Evaluates the message and returns modifications for inline images and backgrounds
Tags:
Parameters:
method SecureHeader [line 2047]
string SecureHeader(
string
$str)
|
|
Strips newlines to prevent header injection.
Tags:
Parameters:
method Send [line 491]
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 539]
bool SendmailSend(
string
$header, string
$body)
|
|
Sends mail using the $Sendmail program.
Tags:
Parameters:
method ServerHostname [line 1818]
Returns the server hostname or 'localhost.localdomain' if unknown.
Tags:
method set [line 2025]
void set(
string
$name, [mixed
$value = ''])
|
|
Set (or reset) Class Objects (variables) Usage Example: $page->set('X-Priority', '3');
Tags:
Parameters:
method SetError [line 1786]
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 442]
boolean SetFrom(
string
$address, [string
$name = ''])
|
|
Set the From and FromName properties
Tags:
Parameters:
method SetLanguage [line 735]
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 1175]
Sets the message type.
Tags:
method SetWordWrap [line 937]
Set the body wrapping.
Tags:
method Sign [line 2060]
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 719]
Closes the active SMTP session if one exists.
Tags:
method SmtpConnect [line 657]
Initiates a connection to an SMTP server. Returns false if the operation failed.
Tags:
method SmtpSend [line 609]
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 1205]
Returns a formatted mail line.
Tags:
Parameters:
method UTF8CharBoundary [line 899]
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 817]
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:
Class Constants
|
|