VERSION
VERSION
The PHPMailer Version number.
\PHPMailer\PHPMailerPHPMailer
PHPMailer - PHP email creation and transport class.
Summary
__destruct()
isHTML()
isSMTP()
isMail()
isSendmail()
isQmail()
addAddress()
addCC()
addBCC()
addReplyTo()
parseAddresses()
setFrom()
getLastMessageID()
validateAddress()
idnSupported()
punyencodeAddress()
send()
preSend()
postSend()
getSMTPInstance()
setSMTPInstance()
smtpConnect()
smtpClose()
setLanguage()
getTranslations()
addrAppend()
addrFormat()
wrapText()
utf8CharBoundary()
setWordWrap()
createHeader()
getMailMIME()
getSentMIMEMessage()
createBody()
headerLine()
textLine()
addAttachment()
getAttachments()
encodeString()
encodeHeader()
hasMultiBytes()
has8bitChars()
base64EncodeWrapMB()
encodeQP()
encodeQ()
addStringAttachment()
addEmbeddedImage()
addStringEmbeddedImage()
inlineImageExists()
attachmentExists()
alternativeExists()
clearQueuedAddresses()
clearAddresses()
clearCCs()
clearBCCs()
clearReplyTos()
clearAllRecipients()
clearAttachments()
clearCustomHeaders()
rfcDate()
isValidHost()
isError()
addCustomHeader()
getCustomHeaders()
msgHTML()
html2text()
_mime_types()
filenameToType()
mb_pathinfo()
set()
secureHeader()
normalizeBreaks()
getLE()
sign()
DKIM_QP()
DKIM_Sign()
DKIM_HeaderC()
DKIM_BodyC()
DKIM_Add()
hasLineLongerThanMax()
getToAddresses()
getCcAddresses()
getBccAddresses()
getReplyToAddresses()
getAllRecipientAddresses()
getOAuth()
setOAuth()
$CharSet
$ContentType
$Encoding
$ErrorInfo
$From
$FromName
$Sender
$Subject
$Body
$AltBody
$Ical
$WordWrap
$Mailer
$Sendmail
$UseSendmailOptions
$ConfirmReadingTo
$Hostname
$MessageID
$MessageDate
$Host
$Port
$Helo
$SMTPSecure
$SMTPAutoTLS
$SMTPAuth
$SMTPOptions
$Username
$Password
$AuthType
$Timeout
$SMTPDebug
$Debugoutput
$SMTPKeepAlive
$SingleTo
$do_verp
$AllowEmpty
$DKIM_selector
$DKIM_identity
$DKIM_passphrase
$DKIM_domain
$DKIM_private
$DKIM_private_string
$action_function
$XMailer
$validator
STOP_MESSAGE
STOP_CONTINUE
STOP_CRITICAL
MAX_LINE_LENGTH
STD_LINE_LENGTH
addOrEnqueueAnAddress()
addAnAddress()
sendmailSend()
isShellSafe()
mailSend()
smtpSend()
generateId()
getBoundary()
endBoundary()
setMessageType()
attachAll()
encodeFile()
cidExists()
setError()
serverHostname()
lang()
setLE()
doCallback()
$MIMEHeader
$mailHeader
$oauth
$SingleToArray
$smtp
$to
$cc
$bcc
$ReplyTo
$all_recipients
$RecipientsQueue
$ReplyToQueue
$attachment
$CustomHeader
$lastMessageID
$message_type
$boundary
$language
$error_count
$sign_cert_file
$sign_key_file
$sign_extracerts_file
$sign_key_pass
$exceptions
$uniqueid
$LE
Constants
Properties
$MessageID
$MessageID : string
An ID to be used in the Message-ID header.
If empty, a unique id will be generated. You can set your own, but it must be in the format "id@domain", as defined in RFC5322 section 3.6.4 or it will be ignored.
Type
string$Host
$Host : string
SMTP hosts.
Either a single hostname or multiple semicolon-delimited hostnames. 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"). You can also specify encryption type, for example: (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465"). Hosts will be tried in order.
Type
string$Debugoutput
$Debugoutput : string|callable|\Psr\Log\LoggerInterface
How to handle debug output.
Options:
echoOutput plain-text as-is, appropriate for CLIhtmlOutput escaped, line breaks converted to<br>, appropriate for browser outputerror_logOutput to error log as configured in php.ini By default PHPMailer will useechoif run from acliorcli-serverSAPI,htmlotherwise. Alternatively, you can provide a callable expecting two params: a message string and the debug level:
$mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only debug
level output is used:
$mail->Debugoutput = new myPsr3Logger;Type
string|callable|\Psr\Log\LoggerInterface$action_function
$action_function : string
Callback Action function name.
The function that handles the result of the send email action. It is called out by send() for each email sent.
Value can be any php callable: http://www.php.net/is_callable
Parameters: bool $result result of the send action array $to email addresses of the recipients array $cc cc email addresses array $bcc bcc email addresses string $subject the subject string $body the email body string $from email address of sender string $extra extra information of possible use "smtp_transaction_id' => last smtp transaction id
Type
string$oauth
$oauth : \PHPMailer\PHPMailer\OAuth
An instance of the PHPMailer OAuth class.
Type
\PHPMailer\PHPMailer\OAuth$smtp
$smtp : \PHPMailer\PHPMailer\SMTP
An instance of the SMTP sender class.
Type
\PHPMailer\PHPMailer\SMTPMethods
parseAddresses()
parseAddresses(string $addrstr, boolean $useimap = true) : array
Parse and validate a string containing one or more RFC822-style comma-separated email addresses of the form "display name <address>" into an array of name/address pairs.
Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. Note that quotes in the name part are removed.
Parameters
| string | $addrstr | The address list string |
| boolean | $useimap | Whether to use the IMAP extension to parse the list |
Returns
arrayvalidateAddress()
validateAddress(string $address, string|callable $patternselect = null) : boolean
Check that a string looks like an email address.
Validation patterns supported:
autoPick best pattern automatically;pcre8Use the squiloople.com pattern, requires PCRE > 8.0;pcreUse old PCRE implementation;phpUse PHP built-in FILTER_VALIDATE_EMAIL;html5Use the pattern given by the HTML5 spec for 'email' type form input elements.noregexDon't use a regex: super fast, really dumb. Alternatively you may pass in a callable to inject your own validator, for example:
PHPMailer::validateAddress('user@example.com', function($address) {
return (strpos($address, '@') !== false);
});You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.
Parameters
| string | $address | The email address to check |
| string|callable | $patternselect | Which pattern to use |
Returns
booleanpunyencodeAddress()
punyencodeAddress(string $address) : string
Converts IDN in given email address to its ASCII form, also known as punycode, if possible.
Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet. This function silently returns unmodified address if:
- No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form)
- Conversion to punycode is impossible (e.g. required PHP functions are not available) or fails for any reason (e.g. domain contains characters not allowed in an IDN).
Parameters
| string | $address | The email address to convert |
Returns
string —The encoded address in ASCII form
getSMTPInstance()
getSMTPInstance() : \PHPMailer\PHPMailer\SMTP
Get an instance to use for SMTP operations.
Override this function to load your own SMTP implementation, or set one with setSMTPInstance.
Returns
\PHPMailer\PHPMailer\SMTPsetSMTPInstance()
setSMTPInstance(\PHPMailer\PHPMailer\SMTP $smtp) : \PHPMailer\PHPMailer\SMTP
Provide an instance to use for SMTP operations.
Parameters
| \PHPMailer\PHPMailer\SMTP | $smtp |
Returns
\PHPMailer\PHPMailer\SMTPsetLanguage()
setLanguage(string $langcode = 'en', string $lang_path = '') : boolean
Set the language for error messages.
Returns false if it cannot load the language file. The default language is English.
Parameters
| string | $langcode | ISO 639-1 2-character language code (e.g. French is "fr") |
| string | $lang_path | Path to the language file directory, with trailing separator (slash) |
Returns
booleanaddrAppend()
addrAppend(string $type, array $addr) : string
Create recipient headers.
Parameters
| string | $type | |
| array | $addr | An array of recipients, where each recipient is a 2-element indexed array with element 0 containing an address and element 1 containing a name, like: [['joe@example.com', 'Joe User'], ['zoe@example.com', 'Zoe User']] |
Returns
stringwrapText()
wrapText(string $message, integer $length, boolean $qp_mode = false) : string
Word-wrap message.
For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.
Parameters
| string | $message | The message to wrap |
| integer | $length | The line length to wrap to |
| boolean | $qp_mode | Whether to run in Quoted-Printable mode |
Returns
stringutf8CharBoundary()
utf8CharBoundary(string $encodedText, integer $maxLength) : integer
Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string.
Original written by Colin Brown.
Parameters
| string | $encodedText | utf-8 QP text |
| integer | $maxLength | Find the last character boundary prior to this length |
Returns
integersetWordWrap()
setWordWrap()
Apply word wrapping to the message body.
Wraps the message body to the number of chars set in the WordWrap property. You should only do this to plain-text bodies as wrapping HTML tags may break them. This is called automatically by createBody(), so you don't need to call it yourself.
addAttachment()
addAttachment(string $path, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'attachment') : boolean
Add an attachment from a path on the filesystem.
Never use a user-supplied path to a file! Returns false if the file could not be found or read.
Parameters
| string | $path | Path to the attachment |
| string | $name | Overrides the attachment name |
| string | $encoding | File encoding (see $Encoding) |
| string | $type | File extension (MIME) type |
| string | $disposition | Disposition to use |
Throws
- \PHPMailer\PHPMailer\Exception
Returns
booleanencodeString()
encodeString(string $str, string $encoding = 'base64') : string
Encode a string in requested format.
Returns an empty string on failure.
Parameters
| string | $str | The text to encode |
| string | $encoding | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable |
Returns
stringencodeHeader()
encodeHeader(string $str, string $position = 'text') : string
Encode a header value (not including its label) optimally.
Picks shortest of Q, B, or none. Result includes folding if needed. See RFC822 definitions for phrase, comment and text positions.
Parameters
| string | $str | The header value to encode |
| string | $position | What context the string will be used in |
Returns
stringbase64EncodeWrapMB()
base64EncodeWrapMB(string $str, string $linebreak = null) : string
Encode and wrap long multibyte strings for mail headers without breaking lines within a character.
Adapted from a function by paravoid.
Parameters
| string | $str | multi-byte text to wrap encode |
| string | $linebreak | string to use as linefeed/end-of-line |
Returns
stringaddStringAttachment()
addStringAttachment(string $string, string $filename, string $encoding = 'base64', string $type = '', string $disposition = 'attachment')
Add a string or binary attachment (non-filesystem).
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
Parameters
| string | $string | String attachment data |
| string | $filename | Name of the attachment |
| string | $encoding | File encoding (see $Encoding) |
| string | $type | File extension (MIME) type |
| string | $disposition | Disposition to use |
addEmbeddedImage()
addEmbeddedImage(string $path, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean
Add an embedded (inline) attachment from a file.
This can include images, sounds, and just about any other document type. These differ from 'regular' attachments in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the $cid value. Never use a user-supplied path to a file!
Parameters
| string | $path | Path to the attachment |
| string | $cid | Content ID of the attachment; Use this to reference the content when using an embedded image in HTML |
| string | $name | Overrides the attachment name |
| string | $encoding | File encoding (see $Encoding) |
| string | $type | File MIME type |
| string | $disposition | Disposition to use |
Returns
boolean —True on successfully adding an attachment
addStringEmbeddedImage()
addStringEmbeddedImage(string $string, string $cid, string $name = '', string $encoding = 'base64', string $type = '', string $disposition = 'inline') : boolean
Add an embedded stringified attachment.
This can include images, sounds, and just about any other document type. If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.
Parameters
| string | $string | The attachment binary data |
| string | $cid | Content ID of the attachment; Use this to reference the content when using an embedded image in HTML |
| string | $name | A filename for the attachment. If this contains an extension, PHPMailer will attempt to set a MIME type for the attachment. For example 'file.jpg' would get an 'image/jpeg' MIME type. |
| string | $encoding | File encoding (see $Encoding), defaults to 'base64' |
| string | $type | MIME type - will be used in preference to any automatically derived type |
| string | $disposition | Disposition to use |
Returns
boolean —True on successfully adding an attachment
msgHTML()
msgHTML(string $message, string $basedir = '', boolean|callable $advanced = false) : string
Create a message body from an HTML string.
Automatically inlines images and creates a plain-text version by converting the HTML,
overwriting any existing values in Body and AltBody.
Do not source $message content from user input!
$basedir is prepended when handling relative URLs, e.g. 
and must not be empty
will look for an image file in $basedir/images/a.png and convert it to inline.
If you don't provide a $basedir, relative paths will be left untouched (and thus probably break in email)
Converts data-uri images into embedded attachments.
If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.
Parameters
| string | $message | HTML message string |
| string | $basedir | Absolute path to a base directory to prepend to relative paths to images |
| boolean|callable | $advanced | Whether to use the internal HTML to text converter or your own custom converter @see PHPMailer::html2text() |
Returns
string —$message The transformed message Body
html2text()
html2text(string $html, boolean|callable $advanced = false) : string
Convert an HTML string into plain text.
This is used by msgHTML(). Note - older versions of this function used a bundled advanced converter which was removed for license reasons in #232. Example usage:
// Use default conversion
$plain = $mail->html2text($html);
// Use your own custom converter
$plain = $mail->html2text($html, function($html) {
$converter = new MyHtml2text($html);
return $converter->get_text();
});Parameters
| string | $html | The HTML text to convert |
| boolean|callable | $advanced | Any boolean value to use the internal converter, or provide your own callable for custom conversion |
Returns
stringmb_pathinfo()
mb_pathinfo(string $path, integer|string $options = null) : string|array
Multi-byte-safe pathinfo replacement.
Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.
Parameters
| string | $path | A filename or path, does not need to exist as a file |
| integer|string | $options | Either a PATHINFO_* constant, or a string name to return only the specified piece |
Returns
string|arrayset()
set(string $name, mixed $value = '') : boolean
Set or reset instance properties.
You should avoid this function - it's more verbose, less efficient, more error-prone and
harder to debug than setting properties directly.
Usage Example:
$mail->set('SMTPSecure', 'tls');
is the same as:
$mail->SMTPSecure = 'tls';.
Parameters
| string | $name | The property name to set |
| mixed | $value | The value to set the property to |
Returns
booleannormalizeBreaks()
normalizeBreaks(string $text, string $breaktype = null) : string
Normalize line breaks in a string.
Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. Defaults to CRLF (for message bodies) and preserves consecutive breaks.
Parameters
| string | $text | |
| string | $breaktype | What kind of line break to use; defaults to static::$LE |
Returns
stringsign()
sign(string $cert_filename, string $key_filename, string $key_pass, string $extracerts_filename = '')
Set the public and private key files and password for S/MIME signing.
Parameters
| string | $cert_filename | |
| string | $key_filename | |
| string | $key_pass | Password for private key |
| string | $extracerts_filename | Optional path to chain certificate |
getOAuth()
getOAuth() : \PHPMailer\PHPMailer\OAuth
Get the OAuth instance.
Returns
\PHPMailer\PHPMailer\OAuthsetOAuth()
setOAuth(\PHPMailer\PHPMailer\OAuth $oauth)
Set an OAuth instance.
Parameters
| \PHPMailer\PHPMailer\OAuth | $oauth |
addOrEnqueueAnAddress()
addOrEnqueueAnAddress(string $kind, string $address, string $name) : boolean
Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send().
Addresses that have been added already return false, but do not throw exceptions.
Parameters
| string | $kind | One of 'to', 'cc', 'bcc', or 'ReplyTo' |
| string | $address | The email address to send, resp. to reply to |
| string | $name |
Throws
- \PHPMailer\PHPMailer\Exception
Returns
boolean —true on success, false if address already used or invalid in some way
addAnAddress()
addAnAddress(string $kind, string $address, string $name = '') : boolean
Add an address to one of the recipient arrays or to the ReplyTo array.
Addresses that have been added already return false, but do not throw exceptions.
Parameters
| string | $kind | One of 'to', 'cc', 'bcc', or 'ReplyTo' |
| string | $address | The email address to send, resp. to reply to |
| string | $name |
Throws
- \PHPMailer\PHPMailer\Exception
Returns
boolean —true on success, false if address already used or invalid in some way
isShellSafe()
isShellSafe(string $string) : boolean
Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters.
Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.
Parameters
| string | $string | The string to be validated |
Returns
booleanencodeFile()
encodeFile(string $path, string $encoding = 'base64') : string
Encode a file attachment in requested format.
Returns an empty string on failure.
Parameters
| string | $path | The full path to the file |
| string | $encoding | The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable' |
Throws
- \PHPMailer\PHPMailer\Exception
Returns
stringmailPassthru()
mailPassthru(string $to, string $subject, string $body, string $header, string|null $params) : boolean
Call mail() in a safe_mode-aware fashion.
Also, unless sendmail_path points to sendmail (or something that claims to be sendmail), don't pass params (not a perfect fix, but it will do).
Parameters
| string | $to | To |
| string | $subject | Subject |
| string | $body | Message Body |
| string | $header | Additional Header(s) |
| string|null | $params | Params |