PHPMailer Class Reference

Collaboration diagram for PHPMailer:

Public Member Functions
	__construct ($exceptions=false)
	__destruct ()
	isHTML ($isHtml=true)
	isSMTP ()
	isMail ()
	isSendmail ()
	isQmail ()
	addAddress ($address, $name= '')
	addCC ($address, $name= '')
	addBCC ($address, $name= '')
	addReplyTo ($address, $name= '')
	parseAddresses ($addrstr, $useimap=true)
	setFrom ($address, $name= '', $auto=true)
	getLastMessageID ()
	idnSupported ()
	punyencodeAddress ($address)
	send ()
	preSend ()
	postSend ()
	getSMTPInstance ()
	smtpConnect ($options=array())
	smtpClose ()
	setLanguage ($langcode= 'en', $lang_path= '')
	getTranslations ()
	addrAppend ($type, $addr)
	addrFormat ($addr)
	wrapText ($message, $length, $qp_mode=false)
	utf8CharBoundary ($encodedText, $maxLength)
	setWordWrap ()
	createHeader ()
	getMailMIME ()
	getSentMIMEMessage ()
	createBody ()
	headerLine ($name, $value)
	textLine ($value)
	addAttachment ($path, $name= '', $encoding= 'base64', $type= '', $disposition= 'attachment')
	getAttachments ()
	encodeString ($str, $encoding= 'base64')
	encodeHeader ($str, $position= 'text')
	hasMultiBytes ($str)
	has8bitChars ($text)
	base64EncodeWrapMB ($str, $linebreak=null)
	encodeQP ($string, $line_max=76)
	encodeQPphp ($string, $line_max=76, $space_conv=false)
	encodeQ ($str, $position= 'text')
	addStringAttachment ($string, $filename, $encoding= 'base64', $type= '', $disposition= 'attachment')
	addEmbeddedImage ($path, $cid, $name= '', $encoding= 'base64', $type= '', $disposition= 'inline')
	addStringEmbeddedImage ($string, $cid, $name= '', $encoding= 'base64', $type= '', $disposition= 'inline')
	inlineImageExists ()
	attachmentExists ()
	alternativeExists ()
	clearQueuedAddresses ($kind)
	clearAddresses ()
	clearCCs ()
	clearBCCs ()
	clearReplyTos ()
	clearAllRecipients ()
	clearAttachments ()
	clearCustomHeaders ()
	isError ()
	fixEOL ($str)
	addCustomHeader ($name, $value=null)
	getCustomHeaders ()
	msgHTML ($message, $basedir= '', $advanced=false)
	html2text ($html, $advanced=false)
	set ($name, $value= '')
	secureHeader ($str)
	sign ($cert_filename, $key_filename, $key_pass, $extracerts_filename= '')
	DKIM_QP ($txt)
	DKIM_Sign ($signHeader)
	DKIM_HeaderC ($signHeader)
	DKIM_BodyC ($body)
	DKIM_Add ($headers_line, $subject, $body)
	getToAddresses ()
	getCcAddresses ()
	getBccAddresses ()
	getReplyToAddresses ()
	getAllRecipientAddresses ()

Static Public Member Functions
static	validateAddress ($address, $patternselect= 'auto')
static	rfcDate ()
static	_mime_types ($ext= '')
static	filenameToType ($filename)
static	mb_pathinfo ($path, $options=null)
static	normalizeBreaks ($text, $breaktype="\r\n")
static	hasLineLongerThanMax ($str)

Data Fields
	$Version = '5.2.14'
	$Priority = null
	$CharSet = 'iso-8859-1'
	$ContentType = 'text/plain'
	$Encoding = '8bit'
	$ErrorInfo = ''
	$From = 'root@localhost'
	$FromName = 'Root User'
	$Sender = ''
	$ReturnPath = ''
	$Subject = ''
	$Body = ''
	$AltBody = ''
	$Ical = ''
	$WordWrap = 0
	$Mailer = 'mail'
	$Sendmail = '/usr/sbin/sendmail'
	$UseSendmailOptions = true
	$PluginDir = ''
	$ConfirmReadingTo = ''
	$Hostname = ''
	$MessageID = ''
	$MessageDate = ''
	$Host = 'localhost'
	$Port = 25
	$Helo = ''
	$SMTPSecure = ''
	$SMTPAutoTLS = true
	$SMTPAuth = false
	$SMTPOptions = array()
	$Username = ''
	$Password = ''
	$AuthType = ''
	$Realm = ''
	$Workstation = ''
	$Timeout = 300
	$SMTPDebug = 0
	$Debugoutput = 'echo'
	$SMTPKeepAlive = false
	$SingleTo = false
	$SingleToArray = array()
	$do_verp = false
	$AllowEmpty = false
	$LE = "\n"
	$DKIM_selector = ''
	$DKIM_identity = ''
	$DKIM_passphrase = ''
	$DKIM_domain = ''
	$DKIM_private = ''
	$action_function = ''
	$XMailer = ''
const	STOP_MESSAGE = 0
const	STOP_CONTINUE = 1
const	STOP_CRITICAL = 2
const	CRLF = "\r\n"
const	MAX_LINE_LENGTH = 998

Protected Member Functions
	edebug ($str)
	addOrEnqueueAnAddress ($kind, $address, $name)
	addAnAddress ($kind, $address, $name= '')
	sendmailSend ($header, $body)
	mailSend ($header, $body)
	smtpSend ($header, $body)
	getBoundary ($boundary, $charSet, $contentType, $encoding)
	endBoundary ($boundary)
	setMessageType ()
	attachAll ($disposition_type, $boundary)
	encodeFile ($path, $encoding= 'base64')
	setError ($msg)
	serverHostname ()
	lang ($key)
	doCallback ($isSent, $to, $cc, $bcc, $subject, $body, $from)

Static Protected Member Functions
static	isShellSafe ($string)

Protected Attributes
	$MIMEBody = ''
	$MIMEHeader = ''
	$mailHeader = ''
	$smtp = null
	$to = array()
	$cc = array()
	$bcc = array()
	$ReplyTo = array()
	$all_recipients = array()
	$RecipientsQueue = array()
	$ReplyToQueue = array()
	$attachment = array()
	$CustomHeader = array()
	$lastMessageID = ''
	$message_type = ''
	$boundary = array()
	$language = array()
	$error_count = 0
	$sign_cert_file = ''
	$sign_key_file = ''
	$sign_extracerts_file = ''
	$sign_key_pass = ''
	$exceptions = false
	$uniqueid = ''

Detailed Description

Definition at line 28 of file class.phpmailer.php.

Constructor & Destructor Documentation

__construct

(

$exceptions = false

)

Constructor.

Parameters

boolean

$exceptions

Should we throw external exceptions?

Definition at line 637 of file class.phpmailer.php.

__destruct

(

)

Destructor.

Definition at line 645 of file class.phpmailer.php.

Here is the call graph for this function:

Member Function Documentation

static _mime_types (   $ext = '' )

static

Get the MIME type for a file extension.

Parameters

string

$ext

File extension public

Returns

string MIME type of file.

Definition at line 3420 of file class.phpmailer.php.

addAddress	(		$address,
			$name = ''
	)

Add a "To" address.

Parameters

string	$address	The email address to send to
string	$name

Returns

boolean true on success, false if address already used or invalid in some way

Definition at line 795 of file class.phpmailer.php.

Here is the call graph for this function:

addAnAddress (   $kind,   $address,   $name = ''  )

protected

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

Exceptions

phpmailerException

Returns

boolean true on success, false if address already used or invalid in some way protected

Definition at line 891 of file class.phpmailer.php.

Here is the call graph for this function:

addAttachment	(		$path,
			$name = '',
			$encoding = 'base64',
			$type = '',
			$disposition = 'attachment'
	)

Add an attachment from a path on the filesystem. 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

Exceptions

phpmailerException

Returns

boolean

Definition at line 2430 of file class.phpmailer.php.

Here is the call graph for this function:

addBCC	(		$address,
			$name = ''
	)

Add a "BCC" address.

Note

: This function works with the SMTP mailer on win32, not with the "mail" mailer.

Parameters

string	$address	The email address to send to
string	$name

Returns

boolean true on success, false if address already used or invalid in some way

Definition at line 819 of file class.phpmailer.php.

Here is the call graph for this function:

addCC	(		$address,
			$name = ''
	)

Add a "CC" address.

Note

: This function works with the SMTP mailer on win32, not with the "mail" mailer.

Parameters

string	$address	The email address to send to
string	$name

Returns

boolean true on success, false if address already used or invalid in some way

Definition at line 807 of file class.phpmailer.php.

Here is the call graph for this function:

addCustomHeader	(		$name,
			$value = null
	)

Add a custom header. $name value can be overloaded to contain both header name and value (name:value) public

Parameters

string	$name	Custom header name
string	$value	Header value

Returns

void

Definition at line 3286 of file class.phpmailer.php.

addEmbeddedImage	(		$path,
			$cid,
			$name = '',
			$encoding = 'base64',
			$type = '',
			$disposition = 'inline'
	)

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.

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

Definition at line 2955 of file class.phpmailer.php.

Here is the call graph for this function:

addOrEnqueueAnAddress (   $kind,   $address,   $name  )

protected

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

Exceptions

phpmailerException

Returns

boolean true on success, false if address already used or invalid in some way protected

Definition at line 847 of file class.phpmailer.php.

Here is the call graph for this function:

addrAppend	(		$type,
			$addr
	)

Create recipient headers. public

Parameters

string	$type
array	$addr	An array of recipient, where each recipient is a 2-element indexed array with element 0 containing an address and element 1 containing a name, like: array(array('joe@e.nosp@m.xamp.nosp@m.le.co.nosp@m.m', 'Joe User'), array('zoe@e.nosp@m.xamp.nosp@m.le.co.nosp@m.m', 'Zoe User'))

Returns

string

Definition at line 1757 of file class.phpmailer.php.

Here is the call graph for this function:

addReplyTo	(		$address,
			$name = ''
	)

Add a "Reply-To" address.

Parameters

string	$address	The email address to reply to
string	$name

Returns

boolean true on success, false if address already used or invalid in some way

Definition at line 830 of file class.phpmailer.php.

Here is the call graph for this function:

addrFormat

(

$addr

)

Format an address for use in a message header. public

Parameters

array

$addr

A 2-element indexed array, element 0 containing an address, element 1 containing a name like array('joe@e.nosp@m.xamp.nosp@m.le.co.nosp@m.m', 'Joe User')

Returns

string

Definition at line 1773 of file class.phpmailer.php.

Here is the call graph for this function:

addStringAttachment	(		$string,
			$filename,
			$encoding = 'base64',
			$type = '',
			$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

Returns

void

Definition at line 2915 of file class.phpmailer.php.

addStringEmbeddedImage	(		$string,
			$cid,
			$name = '',
			$encoding = 'base64',
			$type = '',
			$disposition = 'inline'
	)

Add an embedded stringified attachment. This can include images, sounds, and just about any other document type. Be sure to set the $type to an image type for images: JPEG images use 'image/jpeg', GIF uses 'image/gif', PNG uses 'image/png'.

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
string	$encoding	File encoding (see $Encoding).
string	$type	MIME type.
string	$disposition	Disposition to use

Returns

boolean True on successfully adding an attachment

Definition at line 3000 of file class.phpmailer.php.

alternativeExists

(

)

Check if this message has an alternative body set.

Returns

boolean

Definition at line 3060 of file class.phpmailer.php.

attachAll (   $disposition_type,   $boundary  )

protected

Attach all file, string, and binary attachments to the message. Returns an empty string on failure. protected

Parameters

string	$disposition_type
string	$boundary

Returns

string

Definition at line 2486 of file class.phpmailer.php.

Here is the call graph for this function:

attachmentExists

(

)

Check if an attachment (non-inline) is present.

Returns

boolean

Definition at line 3046 of file class.phpmailer.php.

base64EncodeWrapMB	(		$str,
			$linebreak = null
	)

Encode and wrap long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid public string $str multi-byte text to wrap encode string $linebreak string to use as linefeed/end-of-line string

Definition at line 2781 of file class.phpmailer.php.

clearAddresses

(

)

Clear all To recipients.

Returns

void

Definition at line 3085 of file class.phpmailer.php.

Here is the call graph for this function:

clearAllRecipients

(

)

Clear all recipient types.

Returns

void

Definition at line 3134 of file class.phpmailer.php.

clearAttachments

(

)

Clear all filesystem, string, and binary attachments.

Returns

void

Definition at line 3147 of file class.phpmailer.php.

clearBCCs

(

)

Clear all BCC recipients.

Returns

void

Definition at line 3111 of file class.phpmailer.php.

Here is the call graph for this function:

clearCCs

(

)

Clear all CC recipients.

Returns

void

Definition at line 3098 of file class.phpmailer.php.

Here is the call graph for this function:

clearCustomHeaders

(

)

Clear all custom headers.

Returns

void

Definition at line 3156 of file class.phpmailer.php.

clearQueuedAddresses

(

$kind

)

Clear queued addresses of given kind. protected

Parameters

string

$kind

'to', 'cc', or 'bcc'

Returns

void

Definition at line 3071 of file class.phpmailer.php.

clearReplyTos

(

)

Clear all ReplyTo recipients.

Returns

void

Definition at line 3124 of file class.phpmailer.php.

createBody

(

)

Assemble the message body. Returns an empty string on failure. public

Exceptions

phpmailerException

Returns

string The assembled message body

Definition at line 2126 of file class.phpmailer.php.

Here is the call graph for this function:

createHeader

(

)

Assemble message headers. public

Returns

string The assembled headers

Definition at line 1963 of file class.phpmailer.php.

Here is the call graph for this function:

DKIM_Add	(		$headers_line,
			$subject,
			$body
	)

Create the DKIM header and body in a new message header. public

Parameters

string	$headers_line	Header lines
string	$subject	Subject
string	$body	Body

Returns

string

Definition at line 3756 of file class.phpmailer.php.

Here is the call graph for this function:

DKIM_BodyC

(

$body

)

Generate a DKIM canonicalization body. public

Parameters

string

$body

Message Body

Returns

string

Definition at line 3733 of file class.phpmailer.php.

DKIM_HeaderC

(

$signHeader

)

Generate a DKIM canonicalization header. public

Parameters

string

$signHeader

Header

Returns

string

Definition at line 3713 of file class.phpmailer.php.

DKIM_QP

(

$txt

)

Quoted-Printable-encode a DKIM header. public

Parameters

string

$txt

Returns

string

Definition at line 3666 of file class.phpmailer.php.

DKIM_Sign

(

$signHeader

)

Generate a DKIM signature. public

Parameters

string

$signHeader

Exceptions

phpmailerException

Returns

string

Definition at line 3687 of file class.phpmailer.php.

Here is the call graph for this function:

doCallback (   $isSent,   $to,   $cc,   $bcc,   $subject,   $body,   $from  )

protected

Perform a callback.

Parameters

boolean	$isSent
array	$to
array	$cc
array	$bcc
string	$subject
string	$body
string	$from

Definition at line 3898 of file class.phpmailer.php.

edebug (   $str )

protected

Output debugging info via user-defined method. Only generates output if SMTP debug output is enabled (

See Also

SMTP::$do_debug).

PHPMailer::$Debugoutput

PHPMailer::$SMTPDebug

Parameters

string

$str

Definition at line 689 of file class.phpmailer.php.

encodeFile (   $path,   $encoding = 'base64'  )

protected

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'

Exceptions

phpmailerException

protected

Returns

string

Definition at line 2611 of file class.phpmailer.php.

Here is the call graph for this function:

encodeHeader	(		$str,
			$position = 'text'
	)

Encode a header string optimally. Picks shortest of Q, B, quoted-printable or none. public

Parameters

string	$str
string	$position

Returns

string

PhpMissingBreakStatementInspection

Definition at line 2688 of file class.phpmailer.php.

Here is the call graph for this function:

encodeQ	(		$str,
			$position = 'text'
	)

Encode a string using Q encoding. string $str the text to encode string $position Where the text is going to be used, see the RFC for what that means public string

PhpMissingBreakStatementInspection

Definition at line 2864 of file class.phpmailer.php.

encodeQP	(		$string,
			$line_max = 76
	)

Encode a string in quoted-printable format. According to RFC2045 section 6.7. public

Parameters

string	$string	The text to encode
integer	$line_max	Number of chars allowed on a line before wrapping

Returns

string Adapted from this comment

Definition at line 2823 of file class.phpmailer.php.

encodeQPphp	(		$string,
			$line_max = 76,
			$space_conv = false
	)

Backward compatibility wrapper for an old QP encoding function that was removed.

See Also

PHPMailer::encodeQP() public

Parameters

string	$string
integer	$line_max
boolean	$space_conv

Returns

string

Deprecated:

Use encodeQP instead.

Parameters

$space_conv

PhpUnusedParameterInspection

Definition at line 2848 of file class.phpmailer.php.

Here is the call graph for this function:

encodeString	(		$str,
			$encoding = 'base64'
	)

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' public

Returns

string

Definition at line 2652 of file class.phpmailer.php.

Here is the call graph for this function:

endBoundary (   $boundary )

protected

Return the end of a message boundary. protected

Parameters

string

$boundary

Returns

string

Definition at line 2366 of file class.phpmailer.php.

static filenameToType (   $filename )

static

Map a file name to a MIME type. Defaults to 'application/octet-stream', i.e.. arbitrary binary data.

Parameters

string

$filename

A file name or full path, does not need to exist as a file

Returns

string

Definition at line 3535 of file class.phpmailer.php.

fixEOL

(

$str

)

Ensure consistent line endings in a string. Changes every end of line from CRLF, CR or LF to $this->LE. public

Parameters

string

$str

String to fixEOL

Returns

string

Definition at line 3266 of file class.phpmailer.php.

getAllRecipientAddresses

(

)

Allows for public read access to 'all_recipients' property.

Note

: Before the send() call, queued addresses (i.e. with IDN) are not yet included. public

Returns

array

Definition at line 3883 of file class.phpmailer.php.

getAttachments

(

)

Return the array of attachments.

Returns

array

Definition at line 2473 of file class.phpmailer.php.

getBccAddresses

(

)

Allows for public read access to 'bcc' property.

Note

: Before the send() call, queued addresses (i.e. with IDN) are not yet included. public

Returns

array

Definition at line 3861 of file class.phpmailer.php.

getBoundary (   $boundary,   $charSet,   $contentType,   $encoding  )

protected

Return the start of a message boundary. protected

Parameters

string	$boundary
string	$charSet
string	$contentType
string	$encoding

Returns

string

Definition at line 2336 of file class.phpmailer.php.

Here is the call graph for this function:

getCcAddresses

(

)

Allows for public read access to 'cc' property.

Note

: Before the send() call, queued addresses (i.e. with IDN) are not yet included. public

Returns

array

Definition at line 3850 of file class.phpmailer.php.

getCustomHeaders

(

)

Returns all custom headers.

Returns

array

Definition at line 3300 of file class.phpmailer.php.

getLastMessageID

(

)

Return the Message-ID header of the last email. Technically this is the value from the last time the headers were created, but it's also the message ID of the last sent message except in pathological cases.

Returns

string

Definition at line 1022 of file class.phpmailer.php.

getMailMIME

(

)

Get the message MIME type headers. public

Returns

string

Definition at line 2059 of file class.phpmailer.php.

Here is the call graph for this function:

getReplyToAddresses

(

)

Allows for public read access to 'ReplyTo' property.

Note

: Before the send() call, queued addresses (i.e. with IDN) are not yet included. public

Returns

array

Definition at line 3872 of file class.phpmailer.php.

getSentMIMEMessage

(

)

Returns the whole MIME message. Includes complete headers and body. Only valid post preSend().

See Also

PHPMailer::preSend() public

Returns

string

Definition at line 2114 of file class.phpmailer.php.

getSMTPInstance

(

)

Get an instance to use for SMTP operations. Override this function to load your own SMTP implementation

Returns

SMTP

Definition at line 1479 of file class.phpmailer.php.

getToAddresses

(

)

Allows for public read access to 'to' property.

Note

: Before the send() call, queued addresses (i.e. with IDN) are not yet included. public

Returns

array

Definition at line 3839 of file class.phpmailer.php.

getTranslations

(

)

Get the array of strings for the current language.

Returns

array

Definition at line 1742 of file class.phpmailer.php.

has8bitChars

(

$text

)

Does a string contain any 8-bit chars (in any charset)?

Parameters

string

$text

Returns

boolean

Definition at line 2766 of file class.phpmailer.php.

static hasLineLongerThanMax (   $str )

static

Detect if a string contains a line longer than the maximum line length allowed.

Parameters

string

$str

Returns

boolean

Definition at line 3827 of file class.phpmailer.php.

hasMultiBytes

(

$str

)

Check if a string contains multi-byte characters. public

Parameters

string

$str

multi-byte text to wrap encode

Returns

boolean

Definition at line 2752 of file class.phpmailer.php.

headerLine	(		$name,
			$value
	)

Format a header line. public

Parameters

string	$name
string	$value

Returns

string

Definition at line 2403 of file class.phpmailer.php.

html2text	(		$html,
			$advanced = false
	)

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 been 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

string

Definition at line 3401 of file class.phpmailer.php.

idnSupported

(

)

Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the "intl" and "mbstring" PHP extensions.

Returns

bool "true" if required functions for IDN support are present

Definition at line 1131 of file class.phpmailer.php.

inlineImageExists

(

)

Check if an inline attachment is present. public

Returns

boolean

Definition at line 3032 of file class.phpmailer.php.

isError

(

)

Check if an error occurred. public

Returns

boolean True if an error did occur.

Definition at line 3254 of file class.phpmailer.php.

isHTML

(

$isHtml = true

)

Sets message type to HTML or plain.

Parameters

boolean

$isHtml

True for HTML mode.

Returns

void

Definition at line 730 of file class.phpmailer.php.

isMail

(

)

Send messages using PHP's mail() function.

Returns

void

Definition at line 752 of file class.phpmailer.php.

isQmail

(

)

Send messages using qmail.

Returns

void

Definition at line 777 of file class.phpmailer.php.

isSendmail

(

)

Send messages using $Sendmail.

Returns

void

Definition at line 761 of file class.phpmailer.php.

static isShellSafe (   $string )

staticprotected

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

See Also

https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report protected

Returns

boolean

Definition at line 1404 of file class.phpmailer.php.

isSMTP

(

)

Send messages using SMTP.

Returns

void

Definition at line 743 of file class.phpmailer.php.

lang (   $key )

protected

Get an error message in the current language. protected

Parameters

string

$key

Returns

string

Definition at line 3229 of file class.phpmailer.php.

Here is the call graph for this function:

mailSend (   $header,   $body  )

protected

Send mail using the PHP mail() function.

Parameters

string	$header	The message headers
string	$body	The message body phpmailerException protected boolean

Definition at line 1436 of file class.phpmailer.php.

Here is the call graph for this function:

static mb_pathinfo (   $path,   $options = null  )

static

Multi-byte-safe pathinfo replacement. Drop-in replacement for pathinfo(), but multibyte-safe, cross-platform-safe, old-version-safe. Works similarly to the one in PHP >= 5.2.0 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, allows 'filename' to work on PHP < 5.2 string|array

Definition at line 3557 of file class.phpmailer.php.

msgHTML	(		$message,
			$basedir = '',
			$advanced = false
	)

Create a message from an HTML string. Automatically makes modifications for inline images and backgrounds and creates a plain-text version by converting the HTML. Overwrites any existing values in $this->Body and $this->AltBody public

Parameters

string	$message	HTML message string
string	$basedir	baseline directory for path
boolean | callable	$advanced	Whether to use the internal HTML to text converter or your own custom converter

See Also

PHPMailer::html2text()

Returns

string $message

Definition at line 3317 of file class.phpmailer.php.

Here is the call graph for this function:

static normalizeBreaks (   $text,   $breaktype = "\r\n"  )

static

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 CRLF

Returns

string public

Definition at line 3639 of file class.phpmailer.php.

parseAddresses	(		$addrstr,
			$useimap = true
	)

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
bool	$useimap	Whether to use the IMAP extension to parse the list

Returns

array A more careful implementation

Definition at line 936 of file class.phpmailer.php.

Here is the call graph for this function:

postSend

(

)

Actually send a message. Send the email via the selected mechanism

Exceptions

phpmailerException

Returns

boolean

Definition at line 1291 of file class.phpmailer.php.

Here is the call graph for this function:

preSend

(

)

Prepare a message for sending.

Exceptions

phpmailerException

Returns

boolean

Definition at line 1196 of file class.phpmailer.php.

Here is the call graph for this function:

punyencodeAddress

(

$address

)

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 has characters not allowed in an IDN)

  See Also

  PHPMailer::$CharSet

  Parameters

  string

  $address

  The email address to convert

  Returns

  string The encoded address in ASCII form

Definition at line 1148 of file class.phpmailer.php.

Here is the call graph for this function:

static rfcDate ( )

static

Return an RFC 822 formatted date. public

Returns

string

Definition at line 3194 of file class.phpmailer.php.

secureHeader

(

$str

)

Strip newlines to prevent header injection. public

Parameters

string

$str

Returns

string

Definition at line 3624 of file class.phpmailer.php.

send

(

)

Create a message and send it. Uses the sending method specified by $Mailer.

Exceptions

phpmailerException

Returns

boolean false on error - See the ErrorInfo property for details of the error.

Definition at line 1174 of file class.phpmailer.php.

Here is the call graph for this function:

sendmailSend (   $header,   $body  )

protected

Send mail using the $Sendmail program.

Parameters

string	$header	The message headers
string	$body	The message body

See Also

PHPMailer::$Sendmail

Exceptions

phpmailerException

protected

Returns

boolean

Definition at line 1330 of file class.phpmailer.php.

Here is the call graph for this function:

serverHostname ( )

protected

Get the server hostname. Returns 'localhost.localdomain' if unknown. protected

Returns

string

Definition at line 3208 of file class.phpmailer.php.

set	(		$name,
			$value = ''
	)

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';` public

Parameters

string	$name	The property name to set
mixed	$value	The value to set the property to

Returns

boolean Should this not be using the __set() magic function?

Definition at line 3607 of file class.phpmailer.php.

Here is the call graph for this function:

setError (   $msg )

protected

Add an error message to the error container. protected

Parameters

string

$msg

Returns

void

Definition at line 3167 of file class.phpmailer.php.

Here is the call graph for this function:

setFrom	(		$address,
			$name = '',
			$auto = true
	)

Set the From and FromName properties.

Parameters

string	$address
string	$name
boolean	$auto	Whether to also set the Sender address, defaults to true

Exceptions

phpmailerException

Returns

boolean

Definition at line 989 of file class.phpmailer.php.

Here is the call graph for this function:

setLanguage	(		$langcode = 'en',
			$lang_path = ''
	)

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

boolean public

Definition at line 1693 of file class.phpmailer.php.

setMessageType ( )

protected

Set the message type. PHPMailer only supports some preset message types, not arbitrary MIME structures. protected

Returns

void

Definition at line 2378 of file class.phpmailer.php.

Here is the call graph for this function:

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. public

Returns

void

Definition at line 1939 of file class.phpmailer.php.

Here is the call graph for this function:

sign	(		$cert_filename,
			$key_filename,
			$key_pass,
			$extracerts_filename = ''
	)

Set the public and private key files and password for S/MIME signing. public

Parameters

string	$cert_filename
string	$key_filename
string	$key_pass	Password for private key
string	$extracerts_filename	Optional path to chain certificate

Definition at line 3652 of file class.phpmailer.php.

smtpClose

(

)

Close the active SMTP session if one exists.

Returns

void

Definition at line 1674 of file class.phpmailer.php.

smtpConnect

(

$options = array()

)

Initiate a connection to an SMTP server. Returns false if the operation failed.

Parameters

array

$options

An array of options compatible with stream_context_create() SMTP public

Exceptions

phpmailerException

Returns

boolean

Definition at line 1562 of file class.phpmailer.php.

Here is the call graph for this function:

smtpSend (   $header,   $body  )

protected

Send mail via SMTP. Returns false if there is a bad MAIL FROM, RCPT, or DATA input. Uses the PHPMailerSMTP class by default.

See Also

PHPMailer::getSMTPInstance() to use a different class.

Parameters

string	$header	The message headers
string	$body	The message body

Exceptions

phpmailerException

SMTP protected

Returns

boolean

Definition at line 1499 of file class.phpmailer.php.

Here is the call graph for this function:

textLine

(

$value

)

Return a formatted mail line. public

Parameters

string

$value

Returns

string

Definition at line 2414 of file class.phpmailer.php.

utf8CharBoundary	(		$encodedText,
			$maxLength
	)

Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string. Original written by Colin Brown. public

Parameters

string	$encodedText	utf-8 QP text
integer	$maxLength	Find the last character boundary prior to this length

Returns

integer

Definition at line 1894 of file class.phpmailer.php.

static validateAddress (   $address,   $patternselect = 'auto'  )

static

Check that a string looks like an email address.

Parameters

string	$address	The email address to check
string	$patternselect	A selector for the validation pattern to use : auto Pick best pattern automatically; pcre8 Use the squiloople.com pattern, requires PCRE > 8.0, PHP >= 5.3.2, 5.2.14; pcre Use old PCRE implementation; php Use PHP built-in FILTER_VALIDATE_EMAIL; html5 Use the pattern given by the HTML5 spec for 'email' type form input elements. noregex Don't use a regex: super fast, really dumb.

Returns

boolean

public

Uses the same RFC5322 regex on which FILTER_VALIDATE_EMAIL is based, but allows dotless domains. 2009-2010 Michael Rushton Feel free to use and redistribute this code. But please keep this copyright notice. This is the pattern used in the HTML5 spec for validation of 'email' type form input elements. http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email)

Definition at line 1041 of file class.phpmailer.php.

wrapText	(		$message,
			$length,
			$qp_mode = false
	)

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 public

Returns

string

Definition at line 1795 of file class.phpmailer.php.

Here is the call graph for this function:

Field Documentation

$action_function = ''

Definition at line 440 of file class.phpmailer.php.

$all_recipients = array()

protected

Definition at line 491 of file class.phpmailer.php.

$AllowEmpty = false

Definition at line 379 of file class.phpmailer.php.

$AltBody = ''

Definition at line 118 of file class.phpmailer.php.

$attachment = array()

protected

Definition at line 520 of file class.phpmailer.php.

$AuthType = ''

Definition at line 291 of file class.phpmailer.php.

$bcc = array()

protected

Definition at line 475 of file class.phpmailer.php.

$Body = ''

Definition at line 109 of file class.phpmailer.php.

$boundary = array()

protected

Definition at line 548 of file class.phpmailer.php.

$cc = array()

protected

Definition at line 468 of file class.phpmailer.php.

$CharSet = 'iso-8859-1'

Definition at line 48 of file class.phpmailer.php.

$ConfirmReadingTo = ''

Definition at line 190 of file class.phpmailer.php.

$ContentType = 'text/plain'

Definition at line 54 of file class.phpmailer.php.

$CustomHeader = array()

protected

Definition at line 527 of file class.phpmailer.php.

$Debugoutput = 'echo'

Definition at line 342 of file class.phpmailer.php.

$DKIM_domain = ''

Definition at line 414 of file class.phpmailer.php.

$DKIM_identity = ''

Definition at line 400 of file class.phpmailer.php.

$DKIM_passphrase = ''

Definition at line 407 of file class.phpmailer.php.

$DKIM_private = ''

Definition at line 420 of file class.phpmailer.php.

$DKIM_selector = ''

Definition at line 393 of file class.phpmailer.php.

$do_verp = false

Definition at line 373 of file class.phpmailer.php.

$Encoding = '8bit'

Definition at line 61 of file class.phpmailer.php.

$error_count = 0

protected

Definition at line 562 of file class.phpmailer.php.

$ErrorInfo = ''

Definition at line 67 of file class.phpmailer.php.

$exceptions = false

protected

Definition at line 598 of file class.phpmailer.php.

$From = 'root@localhost'

Definition at line 73 of file class.phpmailer.php.

$FromName = 'Root User'

Definition at line 79 of file class.phpmailer.php.

$Helo = ''

Definition at line 242 of file class.phpmailer.php.

$Host = 'localhost'

Definition at line 226 of file class.phpmailer.php.

$Hostname = ''

Definition at line 199 of file class.phpmailer.php.

$Ical = ''

Definition at line 128 of file class.phpmailer.php.

$language = array()

protected

Definition at line 555 of file class.phpmailer.php.

$lastMessageID = ''

protected

Definition at line 534 of file class.phpmailer.php.

$LE = "\n"

Definition at line 387 of file class.phpmailer.php.

$Mailer = 'mail'

Definition at line 163 of file class.phpmailer.php.

$mailHeader = ''

protected

Definition at line 149 of file class.phpmailer.php.

$message_type = ''

protected

Definition at line 541 of file class.phpmailer.php.

$MessageDate = ''

Definition at line 213 of file class.phpmailer.php.

$MessageID = ''

Definition at line 206 of file class.phpmailer.php.

$MIMEBody = ''

protected

Definition at line 135 of file class.phpmailer.php.

$MIMEHeader = ''

protected

Definition at line 142 of file class.phpmailer.php.

$Password = ''

Definition at line 284 of file class.phpmailer.php.

$PluginDir = ''

Definition at line 184 of file class.phpmailer.php.

$Port = 25

Definition at line 233 of file class.phpmailer.php.

$Priority = null

Definition at line 42 of file class.phpmailer.php.

$Realm = ''

Definition at line 298 of file class.phpmailer.php.

$RecipientsQueue = array()

protected

Definition at line 503 of file class.phpmailer.php.

$ReplyTo = array()

protected

Definition at line 482 of file class.phpmailer.php.

$ReplyToQueue = array()

protected

Definition at line 513 of file class.phpmailer.php.

$ReturnPath = ''

Definition at line 96 of file class.phpmailer.php.

$Sender = ''

Definition at line 86 of file class.phpmailer.php.

$Sendmail = '/usr/sbin/sendmail'

Definition at line 169 of file class.phpmailer.php.

$sign_cert_file = ''

protected

Definition at line 569 of file class.phpmailer.php.

$sign_extracerts_file = ''

protected

Definition at line 583 of file class.phpmailer.php.

$sign_key_file = ''

protected

Definition at line 576 of file class.phpmailer.php.

$sign_key_pass = ''

protected

Definition at line 591 of file class.phpmailer.php.

$SingleTo = false

Definition at line 357 of file class.phpmailer.php.

$SingleToArray = array()

Definition at line 364 of file class.phpmailer.php.

$smtp = null

protected

Definition at line 454 of file class.phpmailer.php.

$SMTPAuth = false

Definition at line 266 of file class.phpmailer.php.

$SMTPAutoTLS = true

Definition at line 257 of file class.phpmailer.php.

$SMTPDebug = 0

Definition at line 326 of file class.phpmailer.php.

$SMTPKeepAlive = false

Definition at line 350 of file class.phpmailer.php.

$SMTPOptions = array()

Definition at line 272 of file class.phpmailer.php.

$SMTPSecure = ''

Definition at line 249 of file class.phpmailer.php.

$Subject = ''

Definition at line 102 of file class.phpmailer.php.

$Timeout = 300

Definition at line 312 of file class.phpmailer.php.

$to = array()

protected

Definition at line 461 of file class.phpmailer.php.

$uniqueid = ''

protected

Definition at line 605 of file class.phpmailer.php.

$Username = ''

Definition at line 278 of file class.phpmailer.php.

$UseSendmailOptions = true

Definition at line 176 of file class.phpmailer.php.

$Version = '5.2.14'

Definition at line 34 of file class.phpmailer.php.

$WordWrap = 0

Definition at line 156 of file class.phpmailer.php.

$Workstation = ''

Definition at line 305 of file class.phpmailer.php.

$XMailer = ''

Definition at line 447 of file class.phpmailer.php.

const CRLF = "\r\n"

SMTP RFC standard line ending.

Definition at line 625 of file class.phpmailer.php.

const MAX_LINE_LENGTH = 998

Definition at line 631 of file class.phpmailer.php.

const STOP_CONTINUE = 1

Error severity: message, likely ok to continue processing.

Definition at line 615 of file class.phpmailer.php.

const STOP_CRITICAL = 2

Error severity: message, plus full stop, critical error reached.

Definition at line 620 of file class.phpmailer.php.

const STOP_MESSAGE = 0

Error severity: message only, continue processing.

Definition at line 610 of file class.phpmailer.php.

---

The documentation for this class was generated from the following file:

• class.phpmailer.php