PHPMailer Class Reference

Inheritance diagram for PHPMailer:

Collaboration diagram for PHPMailer:

Public Member Functions
	__construct ($exceptions=null)
	Constructor. More...
	__destruct ()
	Destructor. More...
	isHTML ($isHtml=true)
	Sets message type to HTML or plain. More...
	isSMTP ()
	Send messages using SMTP. More...
	isMail ()
	Send messages using PHP's mail() function. More...
	isSendmail ()
	Send messages using $Sendmail. More...
	isQmail ()
	Send messages using qmail. More...
	addAddress ($address, $name='')
	Add a "To" address. More...
	addCC ($address, $name='')
	Add a "CC" address. More...
	addBCC ($address, $name='')
	Add a "BCC" address. More...
	addReplyTo ($address, $name='')
	Add a "Reply-To" address. More...
	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. More...
	setFrom ($address, $name='', $auto=true)
	Set the From and FromName properties. More...
	getLastMessageID ()
	Return the Message-ID header of the last email. More...
	idnSupported ()
	Tells whether IDNs (Internationalized Domain Names) are supported or not. More...
	punyencodeAddress ($address)
	Converts IDN in given email address to its ASCII form, also known as punycode, if possible. More...
	send ()
	Create a message and send it. More...
	preSend ()
	Prepare a message for sending. More...
	postSend ()
	Actually send a message. More...
	getSMTPInstance ()
	Get an instance to use for SMTP operations. More...
	smtpConnect ($options=null)
	Initiate a connection to an SMTP server. More...
	smtpClose ()
	Close the active SMTP session if one exists. More...
	setLanguage ($langcode='en', $lang_path='')
	Set the language for error messages. More...
	getTranslations ()
	Get the array of strings for the current language. More...
	addrAppend ($type, $addr)
	Create recipient headers. More...
	addrFormat ($addr)
	Format an address for use in a message header. More...
	wrapText ($message, $length, $qp_mode=false)
	Word-wrap message. More...
	utf8CharBoundary ($encodedText, $maxLength)
	Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string. More...
	setWordWrap ()
	Apply word wrapping to the message body. More...
	createHeader ()
	Assemble message headers. More...
	getMailMIME ()
	Get the message MIME type headers. More...
	getSentMIMEMessage ()
	Returns the whole MIME message. More...
	createBody ()
	Assemble the message body. More...
	headerLine ($name, $value)
	Format a header line. More...
	textLine ($value)
	Return a formatted mail line. More...
	addAttachment ($path, $name='', $encoding='base64', $type='', $disposition='attachment')
	Add an attachment from a path on the filesystem. More...
	getAttachments ()
	Return the array of attachments. More...
	encodeString ($str, $encoding='base64')
	Encode a string in requested format. More...
	encodeHeader ($str, $position='text')
	Encode a header string optimally. More...
	hasMultiBytes ($str)
	Check if a string contains multi-byte characters. More...
	has8bitChars ($text)
	Does a string contain any 8-bit chars (in any charset)? More...
	base64EncodeWrapMB ($str, $linebreak=null)
	Encode and wrap long multibyte strings for mail headers without breaking lines within a character. More...
	encodeQP ($string, $line_max=76)
	Encode a string in quoted-printable format. More...
	encodeQPphp ( $string, $line_max=76, $space_conv=false)
	Backward compatibility wrapper for an old QP encoding function that was removed. More...
	encodeQ ($str, $position='text')
	Encode a string using Q encoding. More...
	addStringAttachment ( $string, $filename, $encoding='base64', $type='', $disposition='attachment')
	Add a string or binary attachment (non-filesystem). More...
	addEmbeddedImage ($path, $cid, $name='', $encoding='base64', $type='', $disposition='inline')
	Add an embedded (inline) attachment from a file. More...
	addStringEmbeddedImage ( $string, $cid, $name='', $encoding='base64', $type='', $disposition='inline')
	Add an embedded stringified attachment. More...
	inlineImageExists ()
	Check if an inline attachment is present. More...
	attachmentExists ()
	Check if an attachment (non-inline) is present. More...
	alternativeExists ()
	Check if this message has an alternative body set. More...
	clearQueuedAddresses ($kind)
	Clear queued addresses of given kind. More...
	clearAddresses ()
	Clear all To recipients. More...
	clearCCs ()
	Clear all CC recipients. More...
	clearBCCs ()
	Clear all BCC recipients. More...
	clearReplyTos ()
	Clear all ReplyTo recipients. More...
	clearAllRecipients ()
	Clear all recipient types. More...
	clearAttachments ()
	Clear all filesystem, string, and binary attachments. More...
	clearCustomHeaders ()
	Clear all custom headers. More...
	isError ()
	Check if an error occurred. More...
	fixEOL ($str)
	Ensure consistent line endings in a string. More...
	addCustomHeader ($name, $value=null)
	Add a custom header. More...
	getCustomHeaders ()
	Returns all custom headers. More...
	msgHTML ($message, $basedir='', $advanced=false)
	Create a message body from an HTML string. More...
	html2text ($html, $advanced=false)
	Convert an HTML string into plain text. More...
	set ($name, $value='')
	Set or reset instance properties. More...
	secureHeader ($str)
	Strip newlines to prevent header injection. More...
	sign ($cert_filename, $key_filename, $key_pass, $extracerts_filename='')
	Set the public and private key files and password for S/MIME signing. More...
	DKIM_QP ($txt)
	Quoted-Printable-encode a DKIM header. More...
	DKIM_Sign ($signHeader)
	Generate a DKIM signature. More...
	DKIM_HeaderC ($signHeader)
	Generate a DKIM canonicalization header. More...
	DKIM_BodyC ($body)
	Generate a DKIM canonicalization body. More...
	DKIM_Add ($headers_line, $subject, $body)
	Create the DKIM header and body in a new message header. More...
	getToAddresses ()
	Allows for public read access to 'to' property. More...
	getCcAddresses ()
	Allows for public read access to 'cc' property. More...
	getBccAddresses ()
	Allows for public read access to 'bcc' property. More...
	getReplyToAddresses ()
	Allows for public read access to 'ReplyTo' property. More...
	getAllRecipientAddresses ()
	Allows for public read access to 'all_recipients' property. More...

Static Public Member Functions
static	validateAddress ($address, $patternselect=null)
	Check that a string looks like an email address. More...
static	rfcDate ()
	Return an RFC 822 formatted date. More...
static	_mime_types ($ext='')
	Get the MIME type for a file extension. More...
static	filenameToType ($filename)
	Map a file name to a MIME type. More...
static	mb_pathinfo ($path, $options=null)
	Multi-byte-safe pathinfo replacement. More...
static	normalizeBreaks ($text, $breaktype="\r\n")
	Normalize line breaks in a string. More...
static	hasLineLongerThanMax ($str)
	Detect if a string contains a line longer than the maximum line length allowed. More...

Data Fields
	$Version = '5.2.22'
	$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 = ''
	$DKIM_private_string = ''
	$action_function = ''
	$XMailer = ''
const	STOP_MESSAGE = 0
	Error severity: message only, continue processing. More...
const	STOP_CONTINUE = 1
	Error severity: message, likely ok to continue processing. More...
const	STOP_CRITICAL = 2
	Error severity: message, plus full stop, critical error reached. More...
const	CRLF = "\r\n"
	SMTP RFC standard line ending. More...
const	MAX_LINE_LENGTH = 998

Static Public Attributes
static	$validator = 'auto'

Protected Member Functions
	edebug ($str)
	Output debugging info via user-defined method. More...
	addOrEnqueueAnAddress ($kind, $address, $name)
	Add an address to one of the recipient arrays or to the ReplyTo array. More...
	addAnAddress ($kind, $address, $name='')
	Add an address to one of the recipient arrays or to the ReplyTo array. More...
	sendmailSend ($header, $body)
	Send mail using the $Sendmail program. More...
	mailSend ($header, $body)
	Send mail using the PHP mail() function. More...
	smtpSend ($header, $body)
	Send mail via SMTP. More...
	generateId ()
	Create unique ID. More...
	getBoundary ($boundary, $charSet, $contentType, $encoding)
	Return the start of a message boundary. More...
	endBoundary ($boundary)
	Return the end of a message boundary. More...
	setMessageType ()
	Set the message type. More...
	attachAll ($disposition_type, $boundary)
	Attach all file, string, and binary attachments to the message. More...
	encodeFile ($path, $encoding='base64')
	Encode a file attachment in requested format. More...
	setError ($msg)
	Add an error message to the error container. More...
	serverHostname ()
	Get the server hostname. More...
	lang ($key)
	Get an error message in the current language. More...
	doCallback ($isSent, $to, $cc, $bcc, $subject, $body, $from)
	Perform a callback. More...

Static Protected Member Functions
static	isShellSafe ($string)
	Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. More...

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

Private Member Functions
	mailPassthru ($to, $subject, $body, $header, $params)
	Call mail() in a safe_mode-aware fashion. More...

Detailed Description

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

Constructor & Destructor Documentation

__construct()

PHPMailer::__construct

(

$exceptions = null

)

Constructor.

Parameters

boolean

$exceptions

Should we throw external exceptions?

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

    {
        if ($exceptions !== null) {
            $this->exceptions = (boolean)$exceptions;
        }
    }

References $exceptions.

__destruct()

PHPMailer::__destruct

(

)

Destructor.

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

    {
        //Close any open SMTP connection nicely
        $this->smtpClose();
    }

References smtpClose().

Here is the call graph for this function:

Member Function Documentation

_mime_types()

static PHPMailer::_mime_types (   $ext = '' )

static

Get the MIME type for a file extension.

Parameters

string

$ext

File extension @access public

Returns

string MIME type of file.

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

    {
        $mimes = array(
            'xl'    => 'application/excel',
            'js'    => 'application/javascript',
            'hqx'   => 'application/mac-binhex40',
            'cpt'   => 'application/mac-compactpro',
            'bin'   => 'application/macbinary',
            'doc'   => 'application/msword',
            'word'  => 'application/msword',
            'xlsx'  => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
            'xltx'  => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template',
            'potx'  => 'application/vnd.openxmlformats-officedocument.presentationml.template',
            'ppsx'  => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow',
            'pptx'  => 'application/vnd.openxmlformats-officedocument.presentationml.presentation',
            'sldx'  => 'application/vnd.openxmlformats-officedocument.presentationml.slide',
            'docx'  => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
            'dotx'  => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template',
            'xlam'  => 'application/vnd.ms-excel.addin.macroEnabled.12',
            'xlsb'  => 'application/vnd.ms-excel.sheet.binary.macroEnabled.12',
            'class' => 'application/octet-stream',
            'dll'   => 'application/octet-stream',
            'dms'   => 'application/octet-stream',
            'exe'   => 'application/octet-stream',
            'lha'   => 'application/octet-stream',
            'lzh'   => 'application/octet-stream',
            'psd'   => 'application/octet-stream',
            'sea'   => 'application/octet-stream',
            'so'    => 'application/octet-stream',
            'oda'   => 'application/oda',
            'pdf'   => 'application/pdf',
            'ai'    => 'application/postscript',
            'eps'   => 'application/postscript',
            'ps'    => 'application/postscript',
            'smi'   => 'application/smil',
            'smil'  => 'application/smil',
            'mif'   => 'application/vnd.mif',
            'xls'   => 'application/vnd.ms-excel',
            'ppt'   => 'application/vnd.ms-powerpoint',
            'wbxml' => 'application/vnd.wap.wbxml',
            'wmlc'  => 'application/vnd.wap.wmlc',
            'dcr'   => 'application/x-director',
            'dir'   => 'application/x-director',
            'dxr'   => 'application/x-director',
            'dvi'   => 'application/x-dvi',
            'gtar'  => 'application/x-gtar',
            'php3'  => 'application/x-httpd-php',
            'php4'  => 'application/x-httpd-php',
            'php'   => 'application/x-httpd-php',
            'phtml' => 'application/x-httpd-php',
            'phps'  => 'application/x-httpd-php-source',
            'swf'   => 'application/x-shockwave-flash',
            'sit'   => 'application/x-stuffit',
            'tar'   => 'application/x-tar',
            'tgz'   => 'application/x-tar',
            'xht'   => 'application/xhtml+xml',
            'xhtml' => 'application/xhtml+xml',
            'zip'   => 'application/zip',
            'mid'   => 'audio/midi',
            'midi'  => 'audio/midi',
            'mp2'   => 'audio/mpeg',
            'mp3'   => 'audio/mpeg',
            'mpga'  => 'audio/mpeg',
            'aif'   => 'audio/x-aiff',
            'aifc'  => 'audio/x-aiff',
            'aiff'  => 'audio/x-aiff',
            'ram'   => 'audio/x-pn-realaudio',
            'rm'    => 'audio/x-pn-realaudio',
            'rpm'   => 'audio/x-pn-realaudio-plugin',
            'ra'    => 'audio/x-realaudio',
            'wav'   => 'audio/x-wav',
            'bmp'   => 'image/bmp',
            'gif'   => 'image/gif',
            'jpeg'  => 'image/jpeg',
            'jpe'   => 'image/jpeg',
            'jpg'   => 'image/jpeg',
            'png'   => 'image/png',
            'tiff'  => 'image/tiff',
            'tif'   => 'image/tiff',
            'eml'   => 'message/rfc822',
            'css'   => 'text/css',
            'html'  => 'text/html',
            'htm'   => 'text/html',
            'shtml' => 'text/html',
            'log'   => 'text/plain',
            'text'  => 'text/plain',
            'txt'   => 'text/plain',
            'rtx'   => 'text/richtext',
            'rtf'   => 'text/rtf',
            'vcf'   => 'text/vcard',
            'vcard' => 'text/vcard',
            'xml'   => 'text/xml',
            'xsl'   => 'text/xml',
            'mpeg'  => 'video/mpeg',
            'mpe'   => 'video/mpeg',
            'mpg'   => 'video/mpeg',
            'mov'   => 'video/quicktime',
            'qt'    => 'video/quicktime',
            'rv'    => 'video/vnd.rn-realvideo',
            'avi'   => 'video/x-msvideo',
            'movie' => 'video/x-sgi-movie'
        );
        if (array_key_exists(strtolower($ext), $mimes)) {
            return $mimes[strtolower($ext)];
        }
        return 'application/octet-stream';
    }

Referenced by filenameToType().

Here is the caller graph for this function:

addAddress()

PHPMailer::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 823 of file class.phpmailer.php.

    {
        return $this->addOrEnqueueAnAddress('to', $address, $name);
    }

References addOrEnqueueAnAddress().

Here is the call graph for this function:

addAnAddress()

PHPMailer::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 @access protected

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

    {
        if (!in_array($kind, array('to', 'cc', 'bcc', 'Reply-To'))) {
            $error_message = $this->lang('Invalid recipient kind: ') . $kind;
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new phpmailerException($error_message);
            }
            return false;
        }
        if (!$this->validateAddress($address)) {
            $error_message = $this->lang('invalid_address') . " (addAnAddress $kind): $address";
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new phpmailerException($error_message);
            }
            return false;
        }
        if ($kind != 'Reply-To') {
            if (!array_key_exists(strtolower($address), $this->all_recipients)) {
                array_push($this->$kind, array($address, $name));
                $this->all_recipients[strtolower($address)] = true;
                return true;
            }
        } else {
            if (!array_key_exists(strtolower($address), $this->ReplyTo)) {
                $this->ReplyTo[strtolower($address)] = array($address, $name);
                return true;
            }
        }
        return false;
    }

References edebug(), lang(), setError(), and validateAddress().

Here is the call graph for this function:

addAttachment()

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

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

Exceptions

phpmailerException

Returns

boolean

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

    {
        try {
            if (!@is_file($path)) {
                throw new phpmailerException($this->lang('file_access') . $path, self::STOP_CONTINUE);
            }
 
            // If a MIME type is not specified, try to work it out from the file name
            if ($type == '') {
                $type = self::filenameToType($path);
            }
 
            $filename = basename($path);
            if ($name == '') {
                $name = $filename;
            }
 
            $this->attachment[] = array(
                0 => $path,
                1 => $filename,
                2 => $name,
                3 => $encoding,
                4 => $type,
                5 => false, // isStringAttachment
                6 => $disposition,
                7 => 0
            );
 
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }
            return false;
        }
        return true;
    }

References $filename, $path, edebug(), filenameToType(), lang(), and setError().

Here is the call graph for this function:

addBCC()

PHPMailer::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 847 of file class.phpmailer.php.

    {
        return $this->addOrEnqueueAnAddress('bcc', $address, $name);
    }

References addOrEnqueueAnAddress().

Here is the call graph for this function:

addCC()

PHPMailer::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 835 of file class.phpmailer.php.

    {
        return $this->addOrEnqueueAnAddress('cc', $address, $name);
    }

References addOrEnqueueAnAddress().

Here is the call graph for this function:

addCustomHeader()

PHPMailer::addCustomHeader	(		$name,
			$value = null
	)

Add a custom header.

$name value can be overloaded to contain both header name and value (name:value) @access public

Parameters

string	$name	Custom header name
string	$value	Header value

Returns

void

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

    {
        if ($value === null) {
            // Value passed in as name:value
            $this->CustomHeader[] = explode(':', $name, 2);
        } else {
            $this->CustomHeader[] = array($name, $value);
        }
    }

addEmbeddedImage()

PHPMailer::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. 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

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

    {
        if (!@is_file($path)) {
            $this->setError($this->lang('file_access') . $path);
            return false;
        }
 
        // If a MIME type is not specified, try to work it out from the file name
        if ($type == '') {
            $type = self::filenameToType($path);
        }
 
        $filename = basename($path);
        if ($name == '') {
            $name = $filename;
        }
 
        // Append to $attachment array
        $this->attachment[] = array(
            0 => $path,
            1 => $filename,
            2 => $name,
            3 => $encoding,
            4 => $type,
            5 => false, // isStringAttachment
            6 => $disposition,
            7 => $cid
        );
        return true;
    }

References $filename, $path, filenameToType(), lang(), and setError().

Referenced by msgHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

addOrEnqueueAnAddress()

PHPMailer::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 @access protected

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

    {
        $address = trim($address);
        $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
        if (($pos = strrpos($address, '@')) === false) {
            // At-sign is misssing.
            $error_message = $this->lang('invalid_address') . " (addAnAddress $kind): $address";
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new phpmailerException($error_message);
            }
            return false;
        }
        $params = array($kind, $address, $name);
        // Enqueue addresses with IDN until we know the PHPMailer::$CharSet.
        if ($this->has8bitChars(substr($address, ++$pos)) and $this->idnSupported()) {
            if ($kind != 'Reply-To') {
                if (!array_key_exists($address, $this->RecipientsQueue)) {
                    $this->RecipientsQueue[$address] = $params;
                    return true;
                }
            } else {
                if (!array_key_exists($address, $this->ReplyToQueue)) {
                    $this->ReplyToQueue[$address] = $params;
                    return true;
                }
            }
            return false;
        }
        // Immediately add standard addresses without IDN.
        return call_user_func_array(array($this, 'addAnAddress'), $params);
    }

References $params, edebug(), has8bitChars(), idnSupported(), lang(), and setError().

Referenced by addAddress(), addBCC(), addCC(), and addReplyTo().

Here is the call graph for this function:

Here is the caller graph for this function:

addrAppend()

PHPMailer::addrAppend	(		$type,
			$addr
	)

Create recipient headers.

@access 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 1823 of file class.phpmailer.php.

    {
        $addresses = array();
        foreach ($addr as $address) {
            $addresses[] = $this->addrFormat($address);
        }
        return $type . ': ' . implode(', ', $addresses) . $this->LE;
    }

References $LE, and addrFormat().

Referenced by createHeader(), and preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

addReplyTo()

PHPMailer::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 858 of file class.phpmailer.php.

    {
        return $this->addOrEnqueueAnAddress('Reply-To', $address, $name);
    }

References addOrEnqueueAnAddress().

Here is the call graph for this function:

addrFormat()

PHPMailer::addrFormat

(

$addr

)

Format an address for use in a message header.

@access 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 1839 of file class.phpmailer.php.

    {
        if (empty($addr[1])) { // No name provided
            return $this->secureHeader($addr[0]);
        } else {
            return $this->encodeHeader($this->secureHeader($addr[1]), 'phrase') . ' <' . $this->secureHeader(
                $addr[0]
            ) . '>';
        }
    }

References encodeHeader(), and secureHeader().

Referenced by addrAppend(), createHeader(), and mailSend().

Here is the call graph for this function:

Here is the caller graph for this function:

addStringAttachment()

PHPMailer::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 2996 of file class.phpmailer.php.

      {
        // If a MIME type is not specified, try to work it out from the file name
        if ($type == '') {
            $type = self::filenameToType($filename);
        }
        // Append to $attachment array
        $this->attachment[] = array(
            0 => $string,
            1 => $filename,
            2 => basename($filename),
            3 => $encoding,
            4 => $type,
            5 => true, // isStringAttachment
            6 => $disposition,
            7 => 0
        );
    }

References $filename, and filenameToType().

Here is the call graph for this function:

addStringEmbeddedImage()

PHPMailer::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 3082 of file class.phpmailer.php.

      {
        // If a MIME type is not specified, try to work it out from the name
        if ($type == '' and !empty($name)) {
            $type = self::filenameToType($name);
        }
 
        // Append to $attachment array
        $this->attachment[] = array(
            0 => $string,
            1 => $name,
            2 => $name,
            3 => $encoding,
            4 => $type,
            5 => true, // isStringAttachment
            6 => $disposition,
            7 => $cid
        );
        return true;
    }

References filenameToType().

Referenced by msgHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

alternativeExists()

PHPMailer::alternativeExists

(

)

Check if this message has an alternative body set.

Returns

boolean

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

    {
        return !empty($this->AltBody);
    }

Referenced by msgHTML(), preSend(), and setMessageType().

Here is the caller graph for this function:

attachAll()

PHPMailer::attachAll (   $disposition_type,   $boundary  )

protected

Attach all file, string, and binary attachments to the message.

Returns an empty string on failure. @access protected

Parameters

string	$disposition_type
string	$boundary

Returns

string

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

    {
        // Return text of body
        $mime = array();
        $cidUniq = array();
        $incl = array();
 
        // Add all attachments
        foreach ($this->attachment as $attachment) {
            // Check if it is a valid disposition_filter
            if ($attachment[6] == $disposition_type) {
                // Check for string attachment
                $string = '';
                $path = '';
                $bString = $attachment[5];
                if ($bString) {
                    $string = $attachment[0];
                } else {
                    $path = $attachment[0];
                }
 
                $inclhash = md5(serialize($attachment));
                if (in_array($inclhash, $incl)) {
                    continue;
                }
                $incl[] = $inclhash;
                $name = $attachment[2];
                $encoding = $attachment[3];
                $type = $attachment[4];
                $disposition = $attachment[6];
                $cid = $attachment[7];
                if ($disposition == 'inline' && array_key_exists($cid, $cidUniq)) {
                    continue;
                }
                $cidUniq[$cid] = true;
 
                $mime[] = sprintf('--%s%s', $boundary, $this->LE);
                //Only include a filename property if we have one
                if (!empty($name)) {
                    $mime[] = sprintf(
                        'Content-Type: %s; name="%s"%s',
                        $type,
                        $this->encodeHeader($this->secureHeader($name)),
                        $this->LE
                    );
                } else {
                    $mime[] = sprintf(
                        'Content-Type: %s%s',
                        $type,
                        $this->LE
                    );
                }
                // RFC1341 part 5 says 7bit is assumed if not specified
                if ($encoding != '7bit') {
                    $mime[] = sprintf('Content-Transfer-Encoding: %s%s', $encoding, $this->LE);
                }
 
                if ($disposition == 'inline') {
                    $mime[] = sprintf('Content-ID: <%s>%s', $cid, $this->LE);
                }
 
                // If a filename contains any of these chars, it should be quoted,
                // but not otherwise: RFC2183 & RFC2045 5.1
                // Fixes a warning in IETF's msglint MIME checker
                // Allow for bypassing the Content-Disposition header totally
                if (!(empty($disposition))) {
                    $encoded_name = $this->encodeHeader($this->secureHeader($name));
                    if (preg_match('/[ \‍(\‍)<>@,;:\\"\/\[\]\?=]/', $encoded_name)) {
                        $mime[] = sprintf(
                            'Content-Disposition: %s; filename="%s"%s',
                            $disposition,
                            $encoded_name,
                            $this->LE . $this->LE
                        );
                    } else {
                        if (!empty($encoded_name)) {
                            $mime[] = sprintf(
                                'Content-Disposition: %s; filename=%s%s',
                                $disposition,
                                $encoded_name,
                                $this->LE . $this->LE
                            );
                        } else {
                            $mime[] = sprintf(
                                'Content-Disposition: %s%s',
                                $disposition,
                                $this->LE . $this->LE
                            );
                        }
                    }
                } else {
                    $mime[] = $this->LE;
                }
 
                // Encode as string attachment
                if ($bString) {
                    $mime[] = $this->encodeString($string, $encoding);
                    if ($this->isError()) {
                        return '';
                    }
                    $mime[] = $this->LE . $this->LE;
                } else {
                    $mime[] = $this->encodeFile($path, $encoding);
                    if ($this->isError()) {
                        return '';
                    }
                    $mime[] = $this->LE . $this->LE;
                }
            }
        }
 
        $mime[] = sprintf('--%s--%s', $boundary, $this->LE);
 
        return implode('', $mime);
    }

References $attachment, $boundary, $LE, $path, encodeFile(), encodeHeader(), encodeString(), isError(), and secureHeader().

Referenced by createBody().

Here is the call graph for this function:

Here is the caller graph for this function:

attachmentExists()

PHPMailer::attachmentExists

(

)

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

Returns

boolean

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

    {
        foreach ($this->attachment as $attachment) {
            if ($attachment[6] == 'attachment') {
                return true;
            }
        }
        return false;
    }

References $attachment.

Referenced by setMessageType().

Here is the caller graph for this function:

base64EncodeWrapMB()

PHPMailer::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 2862 of file class.phpmailer.php.

    {
        $start = '=?' . $this->CharSet . '?B?';
        $end = '?=';
        $encoded = '';
        if ($linebreak === null) {
            $linebreak = $this->LE;
        }
 
        $mb_length = mb_strlen($str, $this->CharSet);
        // Each line must have length <= 75, including $start and $end
        $length = 75 - strlen($start) - strlen($end);
        // Average multi-byte ratio
        $ratio = $mb_length / strlen($str);
        // Base64 has a 4:3 ratio
        $avgLength = floor($length * $ratio * .75);
 
        for ($i = 0; $i < $mb_length; $i += $offset) {
            $lookBack = 0;
            do {
                $offset = $avgLength - $lookBack;
                $chunk = mb_substr($str, $i, $offset, $this->CharSet);
                $chunk = base64_encode($chunk);
                $lookBack++;
            } while (strlen($chunk) > $length);
            $encoded .= $chunk . $linebreak;
        }
 
        // Chomp the last linefeed
        $encoded = substr($encoded, 0, -strlen($linebreak));
        return $encoded;
    }

References $LE.

Referenced by encodeHeader().

Here is the caller graph for this function:

clearAddresses()

PHPMailer::clearAddresses

(

)

Clear all To recipients.

Returns

void

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

    {
        foreach ($this->to as $to) {
            unset($this->all_recipients[strtolower($to[0])]);
        }
        $this->to = array();
        $this->clearQueuedAddresses('to');
    }

References $to, and clearQueuedAddresses().

Here is the call graph for this function:

clearAllRecipients()

PHPMailer::clearAllRecipients

(

)

Clear all recipient types.

Returns

void

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

    {
        $this->to = array();
        $this->cc = array();
        $this->bcc = array();
        $this->all_recipients = array();
        $this->RecipientsQueue = array();
    }

clearAttachments()

PHPMailer::clearAttachments

(

)

Clear all filesystem, string, and binary attachments.

Returns

void

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

    {
        $this->attachment = array();
    }

clearBCCs()

PHPMailer::clearBCCs

(

)

Clear all BCC recipients.

Returns

void

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

    {
        foreach ($this->bcc as $bcc) {
            unset($this->all_recipients[strtolower($bcc[0])]);
        }
        $this->bcc = array();
        $this->clearQueuedAddresses('bcc');
    }

References $bcc, and clearQueuedAddresses().

Here is the call graph for this function:

clearCCs()

PHPMailer::clearCCs

(

)

Clear all CC recipients.

Returns

void

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

    {
        foreach ($this->cc as $cc) {
            unset($this->all_recipients[strtolower($cc[0])]);
        }
        $this->cc = array();
        $this->clearQueuedAddresses('cc');
    }

References $cc, and clearQueuedAddresses().

Here is the call graph for this function:

clearCustomHeaders()

PHPMailer::clearCustomHeaders

(

)

Clear all custom headers.

Returns

void

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

    {
        $this->CustomHeader = array();
    }

clearQueuedAddresses()

PHPMailer::clearQueuedAddresses

(

$kind

)

Clear queued addresses of given kind.

@access protected

Parameters

string

$kind

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

Returns

void

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

    {
        $RecipientsQueue = $this->RecipientsQueue;
        foreach ($RecipientsQueue as $address => $params) {
            if ($params[0] == $kind) {
                unset($this->RecipientsQueue[$address]);
            }
        }
    }

References $params, and $RecipientsQueue.

Referenced by clearAddresses(), clearBCCs(), and clearCCs().

Here is the caller graph for this function:

clearReplyTos()

PHPMailer::clearReplyTos

(

)

Clear all ReplyTo recipients.

Returns

void

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

    {
        $this->ReplyTo = array();
        $this->ReplyToQueue = array();
    }

createBody()

PHPMailer::createBody

(

)

Assemble the message body.

Returns an empty string on failure. @access public

Exceptions

phpmailerException

Returns

string The assembled message body

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

    {
        $body = '';
        //Create unique IDs and preset boundaries
        $this->uniqueid = $this->generateId();
        $this->boundary[1] = 'b1_' . $this->uniqueid;
        $this->boundary[2] = 'b2_' . $this->uniqueid;
        $this->boundary[3] = 'b3_' . $this->uniqueid;
 
        if ($this->sign_key_file) {
            $body .= $this->getMailMIME() . $this->LE;
        }
 
        $this->setWordWrap();
 
        $bodyEncoding = $this->Encoding;
        $bodyCharSet = $this->CharSet;
        //Can we do a 7-bit downgrade?
        if ($bodyEncoding == '8bit' and !$this->has8bitChars($this->Body)) {
            $bodyEncoding = '7bit';
            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
            $bodyCharSet = 'us-ascii';
        }
        //If lines are too long, and we're not already using an encoding that will shorten them,
        //change to quoted-printable transfer encoding for the body part only
        if ('base64' != $this->Encoding and self::hasLineLongerThanMax($this->Body)) {
            $bodyEncoding = 'quoted-printable';
        }
 
        $altBodyEncoding = $this->Encoding;
        $altBodyCharSet = $this->CharSet;
        //Can we do a 7-bit downgrade?
        if ($altBodyEncoding == '8bit' and !$this->has8bitChars($this->AltBody)) {
            $altBodyEncoding = '7bit';
            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
            $altBodyCharSet = 'us-ascii';
        }
        //If lines are too long, and we're not already using an encoding that will shorten them,
        //change to quoted-printable transfer encoding for the alt body part only
        if ('base64' != $altBodyEncoding and self::hasLineLongerThanMax($this->AltBody)) {
            $altBodyEncoding = 'quoted-printable';
        }
        //Use this as a preamble in all multipart message types
        $mimepre = "This is a multi-part message in MIME format." . $this->LE . $this->LE;
        switch ($this->message_type) {
            case 'inline':
                $body .= $mimepre;
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[1]);
                break;
            case 'attach':
                $body .= $mimepre;
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'inline_attach':
                $body .= $mimepre;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'alt':
                $body .= $mimepre;
                $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                if (!empty($this->Ical)) {
                    $body .= $this->getBoundary($this->boundary[1], '', 'text/calendar; method=REQUEST', '');
                    $body .= $this->encodeString($this->Ical, $this->Encoding);
                    $body .= $this->LE . $this->LE;
                }
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_inline':
                $body .= $mimepre;
                $body .= $this->getBoundary($this->boundary[1], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_attach':
                $body .= $mimepre;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'alt_inline_attach':
                $body .= $mimepre;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[2] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[2], $altBodyCharSet, 'text/plain', $altBodyEncoding);
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->textLine('--' . $this->boundary[2]);
                $body .= $this->headerLine('Content-Type', 'multipart/related;');
                $body .= $this->textLine("\tboundary=\"" . $this->boundary[3] . '"');
                $body .= $this->LE;
                $body .= $this->getBoundary($this->boundary[3], $bodyCharSet, 'text/html', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= $this->LE . $this->LE;
                $body .= $this->attachAll('inline', $this->boundary[3]);
                $body .= $this->LE;
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= $this->LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            default:
                // Catch case 'plain' and case '', applies to simple `text/plain` and `text/html` body content types
                //Reset the `Encoding` property in case we changed it for line length reasons
                $this->Encoding = $bodyEncoding;
                $body .= $this->encodeString($this->Body, $this->Encoding);
                break;
        }
 
        if ($this->isError()) {
            $body = '';
        } elseif ($this->sign_key_file) {
            try {
                if (!defined('PKCS7_TEXT')) {
                    throw new phpmailerException($this->lang('extension_missing') . 'openssl');
                }
                // @TODO would be nice to use php://temp streams here, but need to wrap for PHP < 5.1
                $file = tempnam(sys_get_temp_dir(), 'mail');
                if (false === file_put_contents($file, $body)) {
                    throw new phpmailerException($this->lang('signing') . ' Could not write temp file');
                }
                $signed = tempnam(sys_get_temp_dir(), 'signed');
                //Workaround for PHP bug https://bugs.php.net/bug.php?id=69197
                if (empty($this->sign_extracerts_file)) {
                    $sign = @openssl_pkcs7_sign(
                        $file,
                        $signed,
                        'file://' . realpath($this->sign_cert_file),
                        array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
                        null
                    );
                } else {
                    $sign = @openssl_pkcs7_sign(
                        $file,
                        $signed,
                        'file://' . realpath($this->sign_cert_file),
                        array('file://' . realpath($this->sign_key_file), $this->sign_key_pass),
                        null,
                        PKCS7_DETACHED,
                        $this->sign_extracerts_file
                    );
                }
                if ($sign) {
                    @unlink($file);
                    $body = file_get_contents($signed);
                    @unlink($signed);
                    //The message returned by openssl contains both headers and body, so need to split them up
                    $parts = explode("\n\n", $body, 2);
                    $this->MIMEHeader .= $parts[0] . $this->LE . $this->LE;
                    $body = $parts[1];
                } else {
                    @unlink($file);
                    @unlink($signed);
                    throw new phpmailerException($this->lang('signing') . openssl_error_string());
                }
            } catch (phpmailerException $exc) {
                $body = '';
                if ($this->exceptions) {
                    throw $exc;
                }
            }
        }
        return $body;
    }

References $CharSet, $Encoding, $file, $LE, $uniqueid, attachAll(), encodeString(), endBoundary(), generateId(), getBoundary(), getMailMIME(), has8bitChars(), headerLine(), isError(), lang(), setWordWrap(), and textLine().

Referenced by preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

createHeader()

PHPMailer::createHeader

(

)

Assemble message headers.

@access public

Returns

string The assembled headers

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

    {
        $result = '';
 
        if ($this->MessageDate == '') {
            $this->MessageDate = self::rfcDate();
        }
        $result .= $this->headerLine('Date', $this->MessageDate);
 
        // To be created automatically by mail()
        if ($this->SingleTo) {
            if ($this->Mailer != 'mail') {
                foreach ($this->to as $toaddr) {
                    $this->SingleToArray[] = $this->addrFormat($toaddr);
                }
            }
        } else {
            if (count($this->to) > 0) {
                if ($this->Mailer != 'mail') {
                    $result .= $this->addrAppend('To', $this->to);
                }
            } elseif (count($this->cc) == 0) {
                $result .= $this->headerLine('To', 'undisclosed-recipients:;');
            }
        }
 
        $result .= $this->addrAppend('From', array(array(trim($this->From), $this->FromName)));
 
        // sendmail and mail() extract Cc from the header before sending
        if (count($this->cc) > 0) {
            $result .= $this->addrAppend('Cc', $this->cc);
        }
 
        // sendmail and mail() extract Bcc from the header before sending
        if ((
                $this->Mailer == 'sendmail' or $this->Mailer == 'qmail' or $this->Mailer == 'mail'
            )
            and count($this->bcc) > 0
        ) {
            $result .= $this->addrAppend('Bcc', $this->bcc);
        }
 
        if (count($this->ReplyTo) > 0) {
            $result .= $this->addrAppend('Reply-To', $this->ReplyTo);
        }
 
        // mail() sets the subject itself
        if ($this->Mailer != 'mail') {
            $result .= $this->headerLine('Subject', $this->encodeHeader($this->secureHeader($this->Subject)));
        }
 
        // Only allow a custom message ID if it conforms to RFC 5322 section 3.6.4
        // https://tools.ietf.org/html/rfc5322#section-3.6.4
        if ('' != $this->MessageID and preg_match('/^<.*@.*>$/', $this->MessageID)) {
            $this->lastMessageID = $this->MessageID;
        } else {
            $this->lastMessageID = sprintf('<%s@%s>', $this->uniqueid, $this->serverHostname());
        }
        $result .= $this->headerLine('Message-ID', $this->lastMessageID);
        if (!is_null($this->Priority)) {
            $result .= $this->headerLine('X-Priority', $this->Priority);
        }
        if ($this->XMailer == '') {
            $result .= $this->headerLine(
                'X-Mailer',
                'PHPMailer ' . $this->Version . ' (https://github.com/PHPMailer/PHPMailer)'
            );
        } else {
            $myXmailer = trim($this->XMailer);
            if ($myXmailer) {
                $result .= $this->headerLine('X-Mailer', $myXmailer);
            }
        }
 
        if ($this->ConfirmReadingTo != '') {
            $result .= $this->headerLine('Disposition-Notification-To', '<' . $this->ConfirmReadingTo . '>');
        }
 
        // Add custom headers
        foreach ($this->CustomHeader as $header) {
            $result .= $this->headerLine(
                trim($header[0]),
                $this->encodeHeader(trim($header[1]))
            );
        }
        if (!$this->sign_key_file) {
            $result .= $this->headerLine('MIME-Version', '1.0');
            $result .= $this->getMailMIME();
        }
 
        return $result;
    }

References $header, $MessageID, $result, addrAppend(), addrFormat(), encodeHeader(), getMailMIME(), headerLine(), rfcDate(), secureHeader(), and serverHostname().

Referenced by preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

DKIM_Add()

PHPMailer::DKIM_Add	(		$headers_line,
			$subject,
			$body
	)

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

@access public

Parameters

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

Returns

string

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

    {
        $DKIMsignatureType = 'rsa-sha256'; // Signature & hash algorithms
        $DKIMcanonicalization = 'relaxed/simple'; // Canonicalization of header/body
        $DKIMquery = 'dns/txt'; // Query method
        $DKIMtime = time(); // Signature Timestamp = seconds since 00:00:00 - Jan 1, 1970 (UTC time zone)
        $subject_header = "Subject: $subject";
        $headers = explode($this->LE, $headers_line);
        $from_header = '';
        $to_header = '';
        $date_header = '';
        $current = '';
        foreach ($headers as $header) {
            if (strpos($header, 'From:') === 0) {
                $from_header = $header;
                $current = 'from_header';
            } elseif (strpos($header, 'To:') === 0) {
                $to_header = $header;
                $current = 'to_header';
            } elseif (strpos($header, 'Date:') === 0) {
                $date_header = $header;
                $current = 'date_header';
            } else {
                if (!empty($$current) && strpos($header, ' =?') === 0) {
                    $$current .= $header;
                } else {
                    $current = '';
                }
            }
        }
        $from = str_replace('|', '=7C', $this->DKIM_QP($from_header));
        $to = str_replace('|', '=7C', $this->DKIM_QP($to_header));
        $date = str_replace('|', '=7C', $this->DKIM_QP($date_header));
        $subject = str_replace(
            '|',
            '=7C',
            $this->DKIM_QP($subject_header)
        ); // Copied header fields (dkim-quoted-printable)
        $body = $this->DKIM_BodyC($body);
        $DKIMlen = strlen($body); // Length of body
        $DKIMb64 = base64_encode(pack('H*', hash('sha256', $body))); // Base64 of packed binary SHA-256 hash of body
        if ('' == $this->DKIM_identity) {
            $ident = '';
        } else {
            $ident = ' i=' . $this->DKIM_identity . ';';
        }
        $dkimhdrs = 'DKIM-Signature: v=1; a=' .
            $DKIMsignatureType . '; q=' .
            $DKIMquery . '; l=' .
            $DKIMlen . '; s=' .
            $this->DKIM_selector .
            ";\r\n" .
            "\tt=" . $DKIMtime . '; c=' . $DKIMcanonicalization . ";\r\n" .
            "\th=From:To:Date:Subject;\r\n" .
            "\td=" . $this->DKIM_domain . ';' . $ident . "\r\n" .
            "\tz=$from\r\n" .
            "\t|$to\r\n" .
            "\t|$date\r\n" .
            "\t|$subject;\r\n" .
            "\tbh=" . $DKIMb64 . ";\r\n" .
            "\tb=";
        $toSign = $this->DKIM_HeaderC(
            $from_header . "\r\n" .
            $to_header . "\r\n" .
            $date_header . "\r\n" .
            $subject_header . "\r\n" .
            $dkimhdrs
        );
        $signed = $this->DKIM_Sign($toSign);
        return $dkimhdrs . $signed . "\r\n";
    }

References $header, $to, DKIM_BodyC(), DKIM_HeaderC(), DKIM_QP(), and DKIM_Sign().

Referenced by preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

DKIM_BodyC()

PHPMailer::DKIM_BodyC

(

$body

)

Generate a DKIM canonicalization body.

@access public

Parameters

string

$body

Message Body

Returns

string

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

    {
        if ($body == '') {
            return "\r\n";
        }
        // stabilize line endings
        $body = str_replace("\r\n", "\n", $body);
        $body = str_replace("\n", "\r\n", $body);
        // END stabilize line endings
        while (substr($body, strlen($body) - 4, 4) == "\r\n\r\n") {
            $body = substr($body, 0, strlen($body) - 2);
        }
        return $body;
    }

Referenced by DKIM_Add().

Here is the caller graph for this function:

DKIM_HeaderC()

PHPMailer::DKIM_HeaderC

(

$signHeader

)

Generate a DKIM canonicalization header.

@access public

Parameters

string

$signHeader

Header

Returns

string

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

    {
        $signHeader = preg_replace('/\r\n\s+/', ' ', $signHeader);
        $lines = explode("\r\n", $signHeader);
        foreach ($lines as $key => $line) {
            list($heading, $value) = explode(':', $line, 2);
            $heading = strtolower($heading);
            $value = preg_replace('/\s{2,}/', ' ', $value); // Compress useless spaces
            $lines[$key] = $heading . ':' . trim($value); // Don't forget to remove WSP around the value
        }
        $signHeader = implode("\r\n", $lines);
        return $signHeader;
    }

Referenced by DKIM_Add().

Here is the caller graph for this function:

DKIM_QP()

PHPMailer::DKIM_QP

(

$txt

)

Quoted-Printable-encode a DKIM header.

@access public

Parameters

string

$txt

Returns

string

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

    {
        $line = '';
        for ($i = 0; $i < strlen($txt); $i++) {
            $ord = ord($txt[$i]);
            if (((0x21 <= $ord) && ($ord <= 0x3A)) || $ord == 0x3C || ((0x3E <= $ord) && ($ord <= 0x7E))) {
                $line .= $txt[$i];
            } else {
                $line .= '=' . sprintf('%02X', $ord);
            }
        }
        return $line;
    }

References $txt.

Referenced by DKIM_Add().

Here is the caller graph for this function:

DKIM_Sign()

PHPMailer::DKIM_Sign

(

$signHeader

)

Generate a DKIM signature.

@access public

Parameters

string

$signHeader

Exceptions

phpmailerException

Returns

string The DKIM signature value

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

    {
        if (!defined('PKCS7_TEXT')) {
            if ($this->exceptions) {
                throw new phpmailerException($this->lang('extension_missing') . 'openssl');
            }
            return '';
        }
        $privKeyStr = !empty($this->DKIM_private_string) ? $this->DKIM_private_string : file_get_contents($this->DKIM_private);
        if ('' != $this->DKIM_passphrase) {
            $privKey = openssl_pkey_get_private($privKeyStr, $this->DKIM_passphrase);
        } else {
            $privKey = openssl_pkey_get_private($privKeyStr);
        }
        //Workaround for missing digest algorithms in old PHP & OpenSSL versions
        //@link http://stackoverflow.com/a/11117338/333340
        if (version_compare(PHP_VERSION, '5.3.0') >= 0 and
            in_array('sha256WithRSAEncryption', openssl_get_md_methods(true))) {
            if (openssl_sign($signHeader, $signature, $privKey, 'sha256WithRSAEncryption')) {
                openssl_pkey_free($privKey);
                return base64_encode($signature);
            }
        } else {
            $pinfo = openssl_pkey_get_details($privKey);
            $hash = hash('sha256', $signHeader);
            //'Magic' constant for SHA256 from RFC3447
            //@link https://tools.ietf.org/html/rfc3447#page-43
            $t = '3031300d060960864801650304020105000420' . $hash;
            $pslen = $pinfo['bits'] / 8 - (strlen($t) / 2 + 3);
            $eb = pack('H*', '0001' . str_repeat('FF', $pslen) . '00' . $t);
 
            if (openssl_private_encrypt($eb, $signature, $privKey, OPENSSL_NO_PADDING)) {
                openssl_pkey_free($privKey);
                return base64_encode($signature);
            }
        }
        openssl_pkey_free($privKey);
        return '';
    }

References $t, and lang().

Referenced by DKIM_Add().

Here is the call graph for this function:

Here is the caller graph for this function:

doCallback()

PHPMailer::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 4021 of file class.phpmailer.php.

    {
        if (!empty($this->action_function) && is_callable($this->action_function)) {
            $params = array($isSent, $to, $cc, $bcc, $subject, $body, $from);
            call_user_func_array($this->action_function, $params);
        }
    }

References $bcc, $cc, $params, and $to.

Referenced by mailSend(), sendmailSend(), and smtpSend().

Here is the caller graph for this function:

edebug()

PHPMailer::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 717 of file class.phpmailer.php.

    {
        if ($this->SMTPDebug <= 0) {
            return;
        }
        //Avoid clash with built-in function names
        if (!in_array($this->Debugoutput, array('error_log', 'html', 'echo')) and is_callable($this->Debugoutput)) {
            call_user_func($this->Debugoutput, $str, $this->SMTPDebug);
            return;
        }
        switch ($this->Debugoutput) {
            case 'error_log':
                //Don't output, just log
                error_log($str);
                break;
            case 'html':
                //Cleans up output a bit for a better looking, HTML-safe output
                echo htmlentities(
                    preg_replace('/[\r\n]+/', '', $str),
                    ENT_QUOTES,
                    'UTF-8'
                )
                . "<br>\n";
                break;
            case 'echo':
            default:
                //Normalize line breaks
                $str = preg_replace('/\r\n?/ms', "\n", $str);
                echo gmdate('Y-m-d H:i:s') . "\t" . str_replace(
                    "\n",
                    "\n                   \t                  ",
                    trim($str)
                ) . "\n";
        }
    }

References Monolog\Handler\error_log().

Referenced by addAnAddress(), addAttachment(), addOrEnqueueAnAddress(), postSend(), preSend(), setFrom(), PHPMailerOAuth\smtpConnect(), and smtpConnect().

Here is the call graph for this function:

Here is the caller graph for this function:

encodeFile()

PHPMailer::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

@access protected

Returns

string

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

    {
        try {
            if (!is_readable($path)) {
                throw new phpmailerException($this->lang('file_open') . $path, self::STOP_CONTINUE);
            }
            $magic_quotes = get_magic_quotes_runtime();
            if ($magic_quotes) {
                if (version_compare(PHP_VERSION, '5.3.0', '<')) {
                    set_magic_quotes_runtime(false);
                } else {
                    //Doesn't exist in PHP 5.4, but we don't need to check because
                    //get_magic_quotes_runtime always returns false in 5.4+
                    //so it will never get here
                    ini_set('magic_quotes_runtime', false);
                }
            }
            $file_buffer = file_get_contents($path);
            $file_buffer = $this->encodeString($file_buffer, $encoding);
            if ($magic_quotes) {
                if (version_compare(PHP_VERSION, '5.3.0', '<')) {
                    set_magic_quotes_runtime($magic_quotes);
                } else {
                    ini_set('magic_quotes_runtime', $magic_quotes);
                }
            }
            return $file_buffer;
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            return '';
        }
    }

References $path, encodeString(), lang(), and setError().

Referenced by attachAll().

Here is the call graph for this function:

Here is the caller graph for this function:

encodeHeader()

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

Encode a header string optimally.

Picks shortest of Q, B, quoted-printable or none. @access public

Parameters

string	$str
string	$position

Returns

string

@noinspection PhpMissingBreakStatementInspection

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

    {
        $matchcount = 0;
        switch (strtolower($position)) {
            case 'phrase':
                if (!preg_match('/[\200-\377]/', $str)) {
                    // Can't use addslashes as we don't know the value of magic_quotes_sybase
                    $encoded = addcslashes($str, "\0..\37\177\\\"");
                    if (($str == $encoded) && !preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $str)) {
                        return ($encoded);
                    } else {
                        return ("\"$encoded\"");
                    }
                }
                $matchcount = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
                break;
            case 'comment':
                $matchcount = preg_match_all('/[()"]/', $str, $matches);
                // Intentional fall-through
            case 'text':
            default:
                $matchcount += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
                break;
        }
 
        //There are no chars that need encoding
        if ($matchcount == 0) {
            return ($str);
        }
 
        $maxlen = 75 - 7 - strlen($this->CharSet);
        // Try to select the encoding which should produce the shortest output
        if ($matchcount > strlen($str) / 3) {
            // More than a third of the content will need encoding, so B encoding will be most efficient
            $encoding = 'B';
            if (function_exists('mb_strlen') && $this->hasMultiBytes($str)) {
                // Use a custom function which correctly encodes and wraps long
                // multibyte strings without breaking lines within a character
                $encoded = $this->base64EncodeWrapMB($str, "\n");
            } else {
                $encoded = base64_encode($str);
                $maxlen -= $maxlen % 4;
                $encoded = trim(chunk_split($encoded, $maxlen, "\n"));
            }
        } else {
            $encoding = 'Q';
            $encoded = $this->encodeQ($str, $position);
            $encoded = $this->wrapText($encoded, $maxlen, true);
            $encoded = str_replace('=' . self::CRLF, "\n", trim($encoded));
        }
 
        $encoded = preg_replace('/^(.*)$/m', ' =?' . $this->CharSet . "?$encoding?\\1?=", $encoded);
        $encoded = trim(str_replace("\n", $this->LE, $encoded));
 
        return $encoded;
    }

References base64EncodeWrapMB(), encodeQ(), hasMultiBytes(), and wrapText().

Referenced by addrFormat(), attachAll(), createHeader(), mailPassthru(), and preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

encodeQ()

PHPMailer::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

@noinspection PhpMissingBreakStatementInspection

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

    {
        // There should not be any EOL in the string
        $pattern = '';
        $encoded = str_replace(array("\r", "\n"), '', $str);
        switch (strtolower($position)) {
            case 'phrase':
                // RFC 2047 section 5.3
                $pattern = '^A-Za-z0-9!*+\/ -';
                break;
            case 'comment':
                // RFC 2047 section 5.2
                $pattern = '\‍(\‍)"';
                // intentional fall-through
                // for this reason we build the $pattern without including delimiters and []
            case 'text':
            default:
                // RFC 2047 section 5.1
                // Replace every high ascii, control, =, ? and _ characters
                $pattern = '\000-\011\013\014\016-\037\075\077\137\177-\377' . $pattern;
                break;
        }
        $matches = array();
        if (preg_match_all("/[{$pattern}]/", $encoded, $matches)) {
            // If the string contains an '=', make sure it's the first thing we replace
            // so as to avoid double-encoding
            $eqkey = array_search('=', $matches[0]);
            if (false !== $eqkey) {
                unset($matches[0][$eqkey]);
                array_unshift($matches[0], '=');
            }
            foreach (array_unique($matches[0]) as $char) {
                $encoded = str_replace($char, '=' . sprintf('%02X', ord($char)), $encoded);
            }
        }
        // Replace every spaces to _ (more readable than =20)
        return str_replace(' ', '_', $encoded);
    }

Referenced by encodeHeader().

Here is the caller graph for this function:

encodeQP()

PHPMailer::encodeQP	(		$string,
			$line_max = 76
	)

Encode a string in quoted-printable format.

According to RFC2045 section 6.7. @access 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 2904 of file class.phpmailer.php.

    {
        // Use native function if it's available (>= PHP5.3)
        if (function_exists('quoted_printable_encode')) {
            return quoted_printable_encode($string);
        }
        // Fall back to a pure PHP implementation
        $string = str_replace(
            array('%20', '%0D%0A.', '%0D%0A', '%'),
            array(' ', "\r\n=2E", "\r\n", '='),
            rawurlencode($string)
        );
        return preg_replace('/[^\r\n]{' . ($line_max - 3) . '}[^=\r\n]{2}/', "$0=\r\n", $string);
    }

Referenced by encodeQPphp(), and encodeString().

Here is the caller graph for this function:

encodeQPphp()

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

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

See also

PHPMailer::encodeQP() @access User interface

Parameters

string	$string
integer	$line_max
boolean	$space_conv

Returns

string

Deprecated:

Use encodeQP instead.

Parameters

$space_conv

@noinspection PhpUnusedParameterInspection

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

      {
        return $this->encodeQP($string, $line_max);
    }

References encodeQP().

Here is the call graph for this function:

encodeString()

PHPMailer::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' @access public

Returns

string

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

    {
        $encoded = '';
        switch (strtolower($encoding)) {
            case 'base64':
                $encoded = chunk_split(base64_encode($str), 76, $this->LE);
                break;
            case '7bit':
            case '8bit':
                $encoded = $this->fixEOL($str);
                // Make sure it ends with a line break
                if (substr($encoded, -(strlen($this->LE))) != $this->LE) {
                    $encoded .= $this->LE;
                }
                break;
            case 'binary':
                $encoded = $str;
                break;
            case 'quoted-printable':
                $encoded = $this->encodeQP($str);
                break;
            default:
                $this->setError($this->lang('encoding') . $encoding);
                break;
        }
        return $encoded;
    }

References $LE, encodeQP(), fixEOL(), lang(), and setError().

Referenced by attachAll(), createBody(), and encodeFile().

Here is the call graph for this function:

Here is the caller graph for this function:

endBoundary()

PHPMailer::endBoundary (   $boundary )

protected

Return the end of a message boundary.

@access protected

Parameters

string

$boundary

Returns

string

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

    {
        return $this->LE . '--' . $boundary . '--' . $this->LE;
    }

References $boundary, and $LE.

Referenced by createBody().

Here is the caller graph for this function:

filenameToType()

static PHPMailer::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 3631 of file class.phpmailer.php.

    {
        // In case the path is a URL, strip any query string before getting extension
        $qpos = strpos($filename, '?');
        if (false !== $qpos) {
            $filename = substr($filename, 0, $qpos);
        }
        $pathinfo = self::mb_pathinfo($filename);
        return self::_mime_types($pathinfo['extension']);
    }

References $filename, _mime_types(), and mb_pathinfo().

Referenced by addAttachment(), addEmbeddedImage(), addStringAttachment(), and addStringEmbeddedImage().

Here is the call graph for this function:

Here is the caller graph for this function:

fixEOL()

PHPMailer::fixEOL

(

$str

)

Ensure consistent line endings in a string.

Changes every end of line from CRLF, CR or LF to $this->LE. @access public

Parameters

string

$str

String to fixEOL

Returns

string

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

    {
        // Normalise to \n
        $nstr = str_replace(array("\r\n", "\r"), "\n", $str);
        // Now convert LE as needed
        if ($this->LE !== "\n") {
            $nstr = str_replace("\n", $this->LE, $nstr);
        }
        return $nstr;
    }

Referenced by encodeString(), and wrapText().

Here is the caller graph for this function:

generateId()

PHPMailer::generateId ( )

protected

Create unique ID.

Returns

string

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

                                    {
        return md5(uniqid(time()));
    }

Referenced by createBody().

Here is the caller graph for this function:

getAllRecipientAddresses()

PHPMailer::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. @access public

Returns

array

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

    {
        return $this->all_recipients;
    }

References $all_recipients.

getAttachments()

PHPMailer::getAttachments

(

)

Return the array of attachments.

Returns

array

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

    {
        return $this->attachment;
    }

References $attachment.

getBccAddresses()

PHPMailer::getBccAddresses

(

)

Allows for public read access to 'bcc' property.

Note

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

Returns

array

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

    {
        return $this->bcc;
    }

References $bcc.

getBoundary()

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

protected

Return the start of a message boundary.

@access protected

Parameters

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

Returns

string

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

    {
        $result = '';
        if ($charSet == '') {
            $charSet = $this->CharSet;
        }
        if ($contentType == '') {
            $contentType = $this->ContentType;
        }
        if ($encoding == '') {
            $encoding = $this->Encoding;
        }
        $result .= $this->textLine('--' . $boundary);
        $result .= sprintf('Content-Type: %s; charset=%s', $contentType, $charSet);
        $result .= $this->LE;
        // RFC1341 part 5 says 7bit is assumed if not specified
        if ($encoding != '7bit') {
            $result .= $this->headerLine('Content-Transfer-Encoding', $encoding);
        }
        $result .= $this->LE;
 
        return $result;
    }

References $boundary, $CharSet, $ContentType, $Encoding, $LE, $result, headerLine(), and textLine().

Referenced by createBody().

Here is the call graph for this function:

Here is the caller graph for this function:

getCcAddresses()

PHPMailer::getCcAddresses

(

)

Allows for public read access to 'cc' property.

Note

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

Returns

array

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

    {
        return $this->cc;
    }

References $cc.

getCustomHeaders()

PHPMailer::getCustomHeaders

(

)

Returns all custom headers.

Returns

array

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

    {
        return $this->CustomHeader;
    }

References $CustomHeader.

getLastMessageID()

PHPMailer::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 1050 of file class.phpmailer.php.

    {
        return $this->lastMessageID;
    }

References $lastMessageID.

getMailMIME()

PHPMailer::getMailMIME

(

)

Get the message MIME type headers.

@access public

Returns

string

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

    {
        $result = '';
        $ismultipart = true;
        switch ($this->message_type) {
            case 'inline':
                $result .= $this->headerLine('Content-Type', 'multipart/related;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            case 'attach':
            case 'inline_attach':
            case 'alt_attach':
            case 'alt_inline_attach':
                $result .= $this->headerLine('Content-Type', 'multipart/mixed;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            case 'alt':
            case 'alt_inline':
                $result .= $this->headerLine('Content-Type', 'multipart/alternative;');
                $result .= $this->textLine("\tboundary=\"" . $this->boundary[1] . '"');
                break;
            default:
                // Catches case 'plain': and case '':
                $result .= $this->textLine('Content-Type: ' . $this->ContentType . '; charset=' . $this->CharSet);
                $ismultipart = false;
                break;
        }
        // RFC1341 part 5 says 7bit is assumed if not specified
        if ($this->Encoding != '7bit') {
            // RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE
            if ($ismultipart) {
                if ($this->Encoding == '8bit') {
                    $result .= $this->headerLine('Content-Transfer-Encoding', '8bit');
                }
                // The only remaining alternatives are quoted-printable and base64, which are both 7bit compatible
            } else {
                $result .= $this->headerLine('Content-Transfer-Encoding', $this->Encoding);
            }
        }
 
        if ($this->Mailer != 'mail') {
            $result .= $this->LE;
        }
 
        return $result;
    }

References $LE, $result, headerLine(), and textLine().

Referenced by createBody(), and createHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

getReplyToAddresses()

PHPMailer::getReplyToAddresses

(

)

Allows for public read access to 'ReplyTo' property.

Note

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

Returns

array

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

    {
        return $this->ReplyTo;
    }

References $ReplyTo.

getSentMIMEMessage()

PHPMailer::getSentMIMEMessage

(

)

Returns the whole MIME message.

Includes complete headers and body. Only valid post preSend().

See also

PHPMailer::preSend() @access User interface

Returns

string

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

    {
        return rtrim($this->MIMEHeader . $this->mailHeader, "\n\r") . self::CRLF . self::CRLF . $this->MIMEBody;
    }

References $MIMEBody.

getSMTPInstance()

PHPMailer::getSMTPInstance

(

)

Get an instance to use for SMTP operations.

Override this function to load your own SMTP implementation

Returns

SMTP

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

    {
        if (!is_object($this->smtp)) {
            $this->smtp = new SMTP;
        }
        return $this->smtp;
    }

References $smtp.

Referenced by PHPMailerOAuth\smtpConnect(), and smtpConnect().

Here is the caller graph for this function:

getToAddresses()

PHPMailer::getToAddresses

(

)

Allows for public read access to 'to' property.

Note

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

Returns

array

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

    {
        return $this->to;
    }

References $to.

getTranslations()

PHPMailer::getTranslations

(

)

Get the array of strings for the current language.

Returns

array

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

    {
        return $this->language;
    }

References $language.

has8bitChars()

PHPMailer::has8bitChars

(

$text

)

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

Parameters

string

$text

Returns

boolean

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

    {
        return (boolean)preg_match('/[\x80-\xFF]/', $text);
    }

References $text.

Referenced by addOrEnqueueAnAddress(), createBody(), punyencodeAddress(), and setFrom().

Here is the caller graph for this function:

hasLineLongerThanMax()

static PHPMailer::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 3950 of file class.phpmailer.php.

    {
        //+2 to include CRLF line break for a 1000 total
        return (boolean)preg_match('/^(.{'.(self::MAX_LINE_LENGTH + 2).',})/m', $str);
    }

hasMultiBytes()

PHPMailer::hasMultiBytes

(

$str

)

Check if a string contains multi-byte characters.

@access public

Parameters

string

$str

multi-byte text to wrap encode

Returns

boolean

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

    {
        if (function_exists('mb_strlen')) {
            return (strlen($str) > mb_strlen($str, $this->CharSet));
        } else { // Assume no multibytes (we can't handle without mbstring functions anyway)
            return false;
        }
    }

Referenced by encodeHeader().

Here is the caller graph for this function:

headerLine()

PHPMailer::headerLine	(		$name,
			$value
	)

Format a header line.

@access public

Parameters

string	$name
string	$value

Returns

string

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

    {
        return $name . ': ' . $value . $this->LE;
    }

References $LE.

Referenced by createBody(), createHeader(), getBoundary(), getMailMIME(), and preSend().

Here is the caller graph for this function:

html2text()

PHPMailer::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 3497 of file class.phpmailer.php.

    {
        if (is_callable($advanced)) {
            return call_user_func($advanced, $html);
        }
        return html_entity_decode(
            trim(strip_tags(preg_replace('/<(head|title|style|script)[^>]*>.*?<\/\\1>/si', '', $html))),
            ENT_QUOTES,
            $this->CharSet
        );
    }

References $html.

Referenced by msgHTML().

Here is the caller graph for this function:

idnSupported()

PHPMailer::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 1170 of file class.phpmailer.php.

    {
        // @TODO: Write our own "idn_to_ascii" function for PHP <= 5.2.
        return function_exists('idn_to_ascii') and function_exists('mb_convert_encoding');
    }

Referenced by addOrEnqueueAnAddress(), punyencodeAddress(), and setFrom().

Here is the caller graph for this function:

inlineImageExists()

PHPMailer::inlineImageExists

(

)

Check if an inline attachment is present.

@access public

Returns

boolean

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

    {
        foreach ($this->attachment as $attachment) {
            if ($attachment[6] == 'inline') {
                return true;
            }
        }
        return false;
    }

References $attachment.

Referenced by setMessageType().

Here is the caller graph for this function:

isError()

PHPMailer::isError

(

)

Check if an error occurred.

@access public

Returns

boolean True if an error did occur.

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

    {
        return ($this->error_count > 0);
    }

Referenced by attachAll(), and createBody().

Here is the caller graph for this function:

isHTML()

PHPMailer::isHTML

(

$isHtml = true

)

Sets message type to HTML or plain.

Parameters

boolean

$isHtml

True for HTML mode.

Returns

void

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

    {
        if ($isHtml) {
            $this->ContentType = 'text/html';
        } else {
            $this->ContentType = 'text/plain';
        }
    }

Referenced by msgHTML().

Here is the caller graph for this function:

isMail()

PHPMailer::isMail

(

)

Send messages using PHP's mail() function.

Returns

void

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

    {
        $this->Mailer = 'mail';
    }

isQmail()

PHPMailer::isQmail

(

)

Send messages using qmail.

Returns

void

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

    {
        $ini_sendmail_path = ini_get('sendmail_path');
 
        if (!stristr($ini_sendmail_path, 'qmail')) {
            $this->Sendmail = '/var/qmail/bin/qmail-inject';
        } else {
            $this->Sendmail = $ini_sendmail_path;
        }
        $this->Mailer = 'qmail';
    }

isSendmail()

PHPMailer::isSendmail

(

)

Send messages using $Sendmail.

Returns

void

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

    {
        $ini_sendmail_path = ini_get('sendmail_path');
 
        if (!stristr($ini_sendmail_path, 'sendmail')) {
            $this->Sendmail = '/usr/sbin/sendmail';
        } else {
            $this->Sendmail = $ini_sendmail_path;
        }
        $this->Mailer = 'sendmail';
    }

isShellSafe()

static PHPMailer::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 @access protected

Returns

boolean

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

    {
        // Future-proof
        if (escapeshellcmd($string) !== $string
            or !in_array(escapeshellarg($string), array("'$string'", "\"$string\""))
        ) {
            return false;
        }
 
        $length = strlen($string);
 
        for ($i = 0; $i < $length; $i++) {
            $c = $string[$i];
 
            // All other characters have a special meaning in at least one common shell, including = and +.
            // Full stop (.) has a special meaning in cmd.exe, but its impact should be negligible here.
            // Note that this does permit non-Latin alphanumeric characters based on the current locale.
            if (!ctype_alnum($c) && strpos('@_-.', $c) === false) {
                return false;
            }
        }
 
        return true;
    }

isSMTP()

PHPMailer::isSMTP

(

)

Send messages using SMTP.

Returns

void

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

    {
        $this->Mailer = 'smtp';
    }

lang()

PHPMailer::lang (   $key )

protected

Get an error message in the current language.

@access protected

Parameters

string

$key

Returns

string

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

    {
        if (count($this->language) < 1) {
            $this->setLanguage('en'); // set the default language
        }
 
        if (array_key_exists($key, $this->language)) {
            if ($key == 'smtp_connect_failed') {
                //Include a link to troubleshooting docs on SMTP connection failure
                //this is by far the biggest cause of support questions
                //but it's usually not PHPMailer's fault.
                return $this->language[$key] . ' https://github.com/PHPMailer/PHPMailer/wiki/Troubleshooting';
            }
            return $this->language[$key];
        } else {
            //Return the key as a fallback
            return $key;
        }
    }

References setLanguage().

Referenced by addAnAddress(), addAttachment(), addEmbeddedImage(), addOrEnqueueAnAddress(), createBody(), DKIM_Sign(), encodeFile(), encodeString(), mailSend(), preSend(), sendmailSend(), set(), setError(), setFrom(), PHPMailerOAuth\smtpConnect(), smtpConnect(), and smtpSend().

Here is the call graph for this function:

Here is the caller graph for this function:

mailPassthru()

PHPMailer::mailPassthru (   $to,   $subject,   $body,   $header,   $params  )

private

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	$params	Params @access private

Returns

boolean

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

    {
        //Check overloading of mail function to avoid double-encoding
        if (ini_get('mbstring.func_overload') & 1) {
            $subject = $this->secureHeader($subject);
        } else {
            $subject = $this->encodeHeader($this->secureHeader($subject));
        }
                // patch-mjansen: begin #20376
                if(0 == strlen($to) && strpos($header, 'To: undisclosed-recipients:;') !== false)
                {
                        $to     = 'undisclosed-recipients:;';
                        $header = preg_replace('/To: undisclosed-recipients:;(\s*)/', '', $header);
                }
                // patch-mjansen: end
        //Can't use additional_parameters in safe_mode, calling mail() with null params breaks
        //@link http://php.net/manual/en/function.mail.php
        if (ini_get('safe_mode') or !$this->UseSendmailOptions or is_null($params)) {
            $result = @mail($to, $subject, $body, $header);
        } else {
            $result = @mail($to, $subject, $body, $header, $params);
        }
        return $result;
    }

References $header, $params, $result, $to, encodeHeader(), and secureHeader().

Referenced by mailSend().

Here is the call graph for this function:

Here is the caller graph for this function:

mailSend()

PHPMailer::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 1479 of file class.phpmailer.php.

    {
        $toArr = array();
        foreach ($this->to as $toaddr) {
            $toArr[] = $this->addrFormat($toaddr);
        }
        $to = implode(', ', $toArr);
 
        $params = null;
        //This sets the SMTP envelope sender which gets turned into a return-path header by the receiver
        if (!empty($this->Sender) and $this->validateAddress($this->Sender)) {
            // CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.
            if (self::isShellSafe($this->Sender)) {
                $params = sprintf('-f%s', $this->Sender);
            }
        }
        if (!empty($this->Sender) and !ini_get('safe_mode') and $this->validateAddress($this->Sender)) {
            $old_from = ini_get('sendmail_from');
            ini_set('sendmail_from', $this->Sender);
        }
        $result = false;
        if ($this->SingleTo and count($toArr) > 1) {
            foreach ($toArr as $toAddr) {
                $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);
                $this->doCallback($result, array($toAddr), $this->cc, $this->bcc, $this->Subject, $body, $this->From);
            }
        } else {
            $result = $this->mailPassthru($to, $this->Subject, $body, $header, $params);
            $this->doCallback($result, $this->to, $this->cc, $this->bcc, $this->Subject, $body, $this->From);
        }
        if (isset($old_from)) {
            ini_set('sendmail_from', $old_from);
        }
        if (!$result) {
            throw new phpmailerException($this->lang('instantiate'), self::STOP_CRITICAL);
        }
        return true;
    }

References $header, $params, $result, $to, addrFormat(), doCallback(), lang(), mailPassthru(), and validateAddress().

Referenced by postSend().

Here is the call graph for this function:

Here is the caller graph for this function:

mb_pathinfo()

static PHPMailer::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 3653 of file class.phpmailer.php.

    {
        $ret = array('dirname' => '', 'basename' => '', 'extension' => '', 'filename' => '');
        $pathinfo = array();
        if (preg_match('%^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^\.\\\\/]+?)|))[\\\\/\.]*$%im', $path, $pathinfo)) {
            if (array_key_exists(1, $pathinfo)) {
                $ret['dirname'] = $pathinfo[1];
            }
            if (array_key_exists(2, $pathinfo)) {
                $ret['basename'] = $pathinfo[2];
            }
            if (array_key_exists(5, $pathinfo)) {
                $ret['extension'] = $pathinfo[5];
            }
            if (array_key_exists(3, $pathinfo)) {
                $ret['filename'] = $pathinfo[3];
            }
        }
        switch ($options) {
            case PATHINFO_DIRNAME:
            case 'dirname':
                return $ret['dirname'];
            case PATHINFO_BASENAME:
            case 'basename':
                return $ret['basename'];
            case PATHINFO_EXTENSION:
            case 'extension':
                return $ret['extension'];
            case PATHINFO_FILENAME:
            case 'filename':
                return $ret['filename'];
            default:
                return $ret;
        }
    }

References $options, $path, and $ret.

Referenced by filenameToType().

Here is the caller graph for this function:

msgHTML()

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

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) If you don't want to apply these transformations to your HTML, just set Body and AltBody directly. @access public

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 also

PHPMailer::html2text()

Returns

string $message The transformed message Body

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

    {
        preg_match_all('/(src|background)=["\'](.*)["\']/Ui', $message, $images);
        if (array_key_exists(2, $images)) {
            if (strlen($basedir) > 1 && substr($basedir, -1) != '/') {
                // Ensure $basedir has a trailing /
                $basedir .= '/';
            }
            foreach ($images[2] as $imgindex => $url) {
                // Convert data URIs into embedded images
                if (preg_match('#^data:(image[^;,]*)(;base64)?,#', $url, $match)) {
                    $data = substr($url, strpos($url, ','));
                    if ($match[2]) {
                        $data = base64_decode($data);
                    } else {
                        $data = rawurldecode($data);
                    }
                    $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
                    if ($this->addStringEmbeddedImage($data, $cid, 'embed' . $imgindex, 'base64', $match[1])) {
                        $message = str_replace(
                            $images[0][$imgindex],
                            $images[1][$imgindex] . '="cid:' . $cid . '"',
                            $message
                        );
                    }
                    continue;
                }
                if (
                    // Only process relative URLs if a basedir is provided (i.e. no absolute local paths)
                    !empty($basedir)
                    // Ignore URLs containing parent dir traversal (..)
                    && (strpos($url, '..') === false)
                    // Do not change urls that are already inline images
                    && substr($url, 0, 4) !== 'cid:'
                    // Do not change absolute URLs, including anonymous protocol
                    && !preg_match('#^[a-z][a-z0-9+.-]*:?//#i', $url)
                ) {
                    $filename = basename($url);
                    $directory = dirname($url);
                    if ($directory == '.') {
                        $directory = '';
                    }
                    $cid = md5($url) . '@phpmailer.0'; // RFC2392 S 2
                    if (strlen($directory) > 1 && substr($directory, -1) != '/') {
                        $directory .= '/';
                    }
                    if ($this->addEmbeddedImage(
                        $basedir . $directory . $filename,
                        $cid,
                        $filename,
                        'base64',
                        self::_mime_types((string)self::mb_pathinfo($filename, PATHINFO_EXTENSION))
                    )
                    ) {
                        $message = preg_replace(
                            '/' . $images[1][$imgindex] . '=["\']' . preg_quote($url, '/') . '["\']/Ui',
                            $images[1][$imgindex] . '="cid:' . $cid . '"',
                            $message
                        );
                    }
                }
            }
        }
        $this->isHTML(true);
        // Convert all message body line breaks to CRLF, makes quoted-printable encoding work much better
        $this->Body = $this->normalizeBreaks($message);
        $this->AltBody = $this->normalizeBreaks($this->html2text($message, $advanced));
        if (!$this->alternativeExists()) {
            $this->AltBody = 'To view this email message, open it in a program that understands HTML!' .
                self::CRLF . self::CRLF;
        }
        return $this->Body;
    }

References $Body, $data, $filename, $url, addEmbeddedImage(), addStringEmbeddedImage(), alternativeExists(), CRLF, html2text(), isHTML(), and normalizeBreaks().

Here is the call graph for this function:

normalizeBreaks()

static PHPMailer::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 @access public

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

    {
        return preg_replace('/(\r\n|\r|\n)/ms', $breaktype, $text);
    }

References $text.

Referenced by msgHTML().

Here is the caller graph for this function:

parseAddresses()

PHPMailer::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 964 of file class.phpmailer.php.

    {
        $addresses = array();
        if ($useimap and function_exists('imap_rfc822_parse_adrlist')) {
            //Use this built-in parser if it's available
            $list = imap_rfc822_parse_adrlist($addrstr, '');
            foreach ($list as $address) {
                if ($address->host != '.SYNTAX-ERROR.') {
                    if ($this->validateAddress($address->mailbox . '@' . $address->host)) {
                        $addresses[] = array(
                            'name' => (property_exists($address, 'personal') ? $address->personal : ''),
                            'address' => $address->mailbox . '@' . $address->host
                        );
                    }
                }
            }
        } else {
            //Use this simpler parser
            $list = explode(',', $addrstr);
            foreach ($list as $address) {
                $address = trim($address);
                //Is there a separate name part?
                if (strpos($address, '<') === false) {
                    //No separate name, just use the whole thing
                    if ($this->validateAddress($address)) {
                        $addresses[] = array(
                            'name' => '',
                            'address' => $address
                        );
                    }
                } else {
                    list($name, $email) = explode('<', $address);
                    $email = trim(str_replace('>', '', $email));
                    if ($this->validateAddress($email)) {
                        $addresses[] = array(
                            'name' => trim(str_replace(array('"', "'"), '', $name)),
                            'address' => $email
                        );
                    }
                }
            }
        }
        return $addresses;
    }

References validateAddress().

Here is the call graph for this function:

postSend()

PHPMailer::postSend

(

)

Actually send a message.

Send the email via the selected mechanism

Exceptions

phpmailerException

Returns

boolean

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

    {
        try {
            // Choose the mailer and send through it
            switch ($this->Mailer) {
                case 'sendmail':
                case 'qmail':
                    return $this->sendmailSend($this->MIMEHeader, $this->MIMEBody);
                case 'smtp':
                    return $this->smtpSend($this->MIMEHeader, $this->MIMEBody);
                case 'mail':
                    return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
                default:
                    $sendMethod = $this->Mailer.'Send';
                    if (method_exists($this, $sendMethod)) {
                        return $this->$sendMethod($this->MIMEHeader, $this->MIMEBody);
                    }
 
                    return $this->mailSend($this->MIMEHeader, $this->MIMEBody);
            }
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }
        }
        return false;
    }

References edebug(), mailSend(), sendmailSend(), setError(), and smtpSend().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

preSend()

PHPMailer::preSend

(

)

Prepare a message for sending.

Exceptions

phpmailerException

Returns

boolean

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

    {
        try {
            $this->error_count = 0; // Reset errors
            $this->mailHeader = '';
 
            // Dequeue recipient and Reply-To addresses with IDN
            foreach (array_merge($this->RecipientsQueue, $this->ReplyToQueue) as $params) {
                $params[1] = $this->punyencodeAddress($params[1]);
                call_user_func_array(array($this, 'addAnAddress'), $params);
            }
            if ((count($this->to) + count($this->cc) + count($this->bcc)) < 1) {
                throw new phpmailerException($this->lang('provide_address'), self::STOP_CRITICAL);
            }
 
            // Validate From, Sender, and ConfirmReadingTo addresses
            foreach (array('From', 'Sender', 'ConfirmReadingTo') as $address_kind) {
                $this->$address_kind = trim($this->$address_kind);
                if (empty($this->$address_kind)) {
                    continue;
                }
                $this->$address_kind = $this->punyencodeAddress($this->$address_kind);
                if (!$this->validateAddress($this->$address_kind)) {
                    $error_message = $this->lang('invalid_address') . ' (punyEncode) ' . $this->$address_kind;
                    $this->setError($error_message);
                    $this->edebug($error_message);
                    if ($this->exceptions) {
                        throw new phpmailerException($error_message);
                    }
                    return false;
                }
            }
 
            // Set whether the message is multipart/alternative
            if ($this->alternativeExists()) {
                $this->ContentType = 'multipart/alternative';
            }
 
            $this->setMessageType();
            // Refuse to send an empty message unless we are specifically allowing it
            if (!$this->AllowEmpty and empty($this->Body)) {
                throw new phpmailerException($this->lang('empty_message'), self::STOP_CRITICAL);
            }
 
            // Create body before headers in case body makes changes to headers (e.g. altering transfer encoding)
            $this->MIMEHeader = '';
            $this->MIMEBody = $this->createBody();
            // createBody may have added some headers, so retain them
            $tempheaders = $this->MIMEHeader;
            $this->MIMEHeader = $this->createHeader();
            $this->MIMEHeader .= $tempheaders;
 
            // To capture the complete message when using mail(), create
            // an extra header list which createHeader() doesn't fold in
            if ($this->Mailer == 'mail') {
                if (count($this->to) > 0) {
                    $this->mailHeader .= $this->addrAppend('To', $this->to);
                } else {
                    $this->mailHeader .= $this->headerLine('To', 'undisclosed-recipients:;');
                }
                $this->mailHeader .= $this->headerLine(
                    'Subject',
                    $this->encodeHeader($this->secureHeader(trim($this->Subject)))
                );
            }
 
            // Sign with DKIM if enabled
            if (!empty($this->DKIM_domain)
                && !empty($this->DKIM_selector)
                && (!empty($this->DKIM_private_string)
                   || (!empty($this->DKIM_private) && file_exists($this->DKIM_private))
                )
            ) {
                $header_dkim = $this->DKIM_Add(
                    $this->MIMEHeader . $this->mailHeader,
                    $this->encodeHeader($this->secureHeader($this->Subject)),
                    $this->MIMEBody
                );
                $this->MIMEHeader = rtrim($this->MIMEHeader, "\r\n ") . self::CRLF .
                    str_replace("\r\n", "\n", $header_dkim) . self::CRLF;
            }
            return true;
        } catch (phpmailerException $exc) {
            $this->setError($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }
            return false;
        }
    }

References $MIMEHeader, $params, addrAppend(), alternativeExists(), createBody(), createHeader(), CRLF, DKIM_Add(), edebug(), encodeHeader(), headerLine(), lang(), punyencodeAddress(), secureHeader(), setError(), setMessageType(), and validateAddress().

Referenced by send().

Here is the call graph for this function:

Here is the caller graph for this function:

punyencodeAddress()

PHPMailer::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 1187 of file class.phpmailer.php.

    {
        // Verify we have required functions, CharSet, and at-sign.
        if ($this->idnSupported() and
            !empty($this->CharSet) and
            ($pos = strrpos($address, '@')) !== false) {
            $domain = substr($address, ++$pos);
            // Verify CharSet string is a valid one, and domain properly encoded in this CharSet.
            if ($this->has8bitChars($domain) and @mb_check_encoding($domain, $this->CharSet)) {
                $domain = mb_convert_encoding($domain, 'UTF-8', $this->CharSet);
                if (($punycode = defined('INTL_IDNA_VARIANT_UTS46') ?
                    idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46) :
                    idn_to_ascii($domain)) !== false) {
                    return substr($address, 0, $pos) . $punycode;
                }
            }
        }
        return $address;
    }

References has8bitChars(), and idnSupported().

Referenced by preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

rfcDate()

static PHPMailer::rfcDate ( )

static

Return an RFC 822 formatted date.

@access public

Returns

string

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

    {
        // Set the time zone to whatever the default is to avoid 500 errors
        // Will default to UTC if it's not set properly in php.ini
        date_default_timezone_set(@date_default_timezone_get());
        return date('D, j M Y H:i:s O');
    }

Referenced by createHeader().

Here is the caller graph for this function:

secureHeader()

PHPMailer::secureHeader

(

$str

)

Strip newlines to prevent header injection.

@access public

Parameters

string

$str

Returns

string

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

    {
        return trim(str_replace(array("\r", "\n"), '', $str));
    }

Referenced by addrFormat(), attachAll(), createHeader(), mailPassthru(), and preSend().

Here is the caller graph for this function:

send()

PHPMailer::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 1213 of file class.phpmailer.php.

    {
        try {
            if (!$this->preSend()) {
                return false;
            }
            return $this->postSend();
        } catch (phpmailerException $exc) {
            $this->mailHeader = '';
            $this->setError($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }
            return false;
        }
    }

References postSend(), preSend(), and setError().

Here is the call graph for this function:

sendmailSend()

PHPMailer::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

@access protected

Returns

boolean

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

    {
        // CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.
        if (!empty($this->Sender) and self::isShellSafe($this->Sender)) {
            if ($this->Mailer == 'qmail') {
                $sendmailFmt = '%s -f%s';
            } else {
                $sendmailFmt = '%s -oi -f%s -t';
            }
        } else {
            if ($this->Mailer == 'qmail') {
                $sendmailFmt = '%s';
            } else {
                $sendmailFmt = '%s -oi -t';
            }
        }
 
        // TODO: If possible, this should be changed to escapeshellarg.  Needs thorough testing.
        $sendmail = sprintf($sendmailFmt, escapeshellcmd($this->Sendmail), $this->Sender);
 
        if ($this->SingleTo) {
            foreach ($this->SingleToArray as $toAddr) {
                if (!@$mail = popen($sendmail, 'w')) {
                    throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
                fputs($mail, 'To: ' . $toAddr . "\n");
                fputs($mail, $header);
                fputs($mail, $body);
                $result = pclose($mail);
                $this->doCallback(
                    ($result == 0),
                    array($toAddr),
                    $this->cc,
                    $this->bcc,
                    $this->Subject,
                    $body,
                    $this->From
                );
                if ($result != 0) {
                    throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
            }
        } else {
            if (!@$mail = popen($sendmail, 'w')) {
                throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
            fputs($mail, $header);
            fputs($mail, $body);
            $result = pclose($mail);
            $this->doCallback(
                ($result == 0),
                $this->to,
                $this->cc,
                $this->bcc,
                $this->Subject,
                $body,
                $this->From
            );
            if ($result != 0) {
                throw new phpmailerException($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
        }
        return true;
    }

References $header, $result, doCallback(), and lang().

Referenced by postSend().

Here is the call graph for this function:

Here is the caller graph for this function:

serverHostname()

PHPMailer::serverHostname ( )

protected

Get the server hostname.

Returns 'localhost.localdomain' if unknown. @access protected

Returns

string

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

    {
        $result = 'localhost.localdomain';
        if (!empty($this->Hostname)) {
            $result = $this->Hostname;
        } elseif (isset($_SERVER) and array_key_exists('SERVER_NAME', $_SERVER) and !empty($_SERVER['SERVER_NAME'])) {
            $result = $_SERVER['SERVER_NAME'];
        } elseif (function_exists('gethostname') && gethostname() !== false) {
            $result = gethostname();
        } elseif (php_uname('n') !== false) {
            $result = php_uname('n');
        }
        return $result;
    }

References $_SERVER, $Hostname, and $result.

Referenced by createHeader(), PHPMailerOAuth\smtpConnect(), and smtpConnect().

Here is the caller graph for this function:

set()

PHPMailer::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’;` @access public

Parameters

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

Returns

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

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

    {
        if (property_exists($this, $name)) {
            $this->$name = $value;
            return true;
        } else {
            $this->setError($this->lang('variable_set') . $name);
            return false;
        }
    }

References lang(), and setError().

Here is the call graph for this function:

setError()

PHPMailer::setError (   $msg )

protected

Add an error message to the error container.

@access protected

Parameters

string

$msg

Returns

void

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

    {
        $this->error_count++;
        if ($this->Mailer == 'smtp' and !is_null($this->smtp)) {
            $lasterror = $this->smtp->getError();
            if (!empty($lasterror['error'])) {
                $msg .= $this->lang('smtp_error') . $lasterror['error'];
                if (!empty($lasterror['detail'])) {
                    $msg .= ' Detail: '. $lasterror['detail'];
                }
                if (!empty($lasterror['smtp_code'])) {
                    $msg .= ' SMTP code: ' . $lasterror['smtp_code'];
                }
                if (!empty($lasterror['smtp_code_ex'])) {
                    $msg .= ' Additional SMTP info: ' . $lasterror['smtp_code_ex'];
                }
            }
        }
        $this->ErrorInfo = $msg;
    }

References lang().

Referenced by addAnAddress(), addAttachment(), addEmbeddedImage(), addOrEnqueueAnAddress(), encodeFile(), encodeString(), postSend(), preSend(), send(), set(), setFrom(), and smtpSend().

Here is the call graph for this function:

Here is the caller graph for this function:

setFrom()

PHPMailer::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 1017 of file class.phpmailer.php.

    {
        $address = trim($address);
        $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
        // Don't validate now addresses with IDN. Will be done in send().
        if (($pos = strrpos($address, '@')) === false or
            (!$this->has8bitChars(substr($address, ++$pos)) or !$this->idnSupported()) and
            !$this->validateAddress($address)) {
            $error_message = $this->lang('invalid_address') . " (setFrom) $address";
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new phpmailerException($error_message);
            }
            return false;
        }
        $this->From = $address;
        $this->FromName = $name;
        if ($auto) {
            if (empty($this->Sender)) {
                $this->Sender = $address;
            }
        }
        return true;
    }

References edebug(), has8bitChars(), idnSupported(), lang(), setError(), and validateAddress().

Here is the call graph for this function:

setLanguage()

PHPMailer::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 @access public

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

    {
        // Backwards compatibility for renamed language codes
        $renamed_langcodes = array(
            'br' => 'pt_br',
            'cz' => 'cs',
            'dk' => 'da',
            'no' => 'nb',
            'se' => 'sv',
        );
 
        if (isset($renamed_langcodes[$langcode])) {
            $langcode = $renamed_langcodes[$langcode];
        }
 
        // Define full set of translatable strings in English
        $PHPMAILER_LANG = array(
            'authenticate' => 'SMTP Error: Could not authenticate.',
            'connect_host' => 'SMTP Error: Could not connect to SMTP host.',
            'data_not_accepted' => 'SMTP Error: data not accepted.',
            'empty_message' => 'Message body empty',
            'encoding' => 'Unknown encoding: ',
            'execute' => 'Could not execute: ',
            'file_access' => 'Could not access file: ',
            'file_open' => 'File Error: Could not open file: ',
            'from_failed' => 'The following From address failed: ',
            'instantiate' => 'Could not instantiate mail function.',
            'invalid_address' => 'Invalid address: ',
            'mailer_not_supported' => ' mailer is not supported.',
            'provide_address' => 'You must provide at least one recipient email address.',
            'recipients_failed' => 'SMTP Error: The following recipients failed: ',
            'signing' => 'Signing Error: ',
            'smtp_connect_failed' => 'SMTP connect() failed.',
            'smtp_error' => 'SMTP server error: ',
            'variable_set' => 'Cannot set or reset variable: ',
            'extension_missing' => 'Extension missing: '
        );
        if (empty($lang_path)) {
            // Calculate an absolute path so it can work if CWD is not here
            $lang_path = dirname(__FILE__). DIRECTORY_SEPARATOR . 'language'. DIRECTORY_SEPARATOR;
        }
        //Validate $langcode
        if (!preg_match('/^[a-z]{2}(?:_[a-zA-Z]{2})?$/', $langcode)) {
            $langcode = 'en';
        }
        $foundlang = true;
        $lang_file = $lang_path . 'phpmailer.lang-' . $langcode . '.php';
        // There is no English translation file
        if ($langcode != 'en') {
            // Make sure language file path is readable
            if (!is_readable($lang_file)) {
                $foundlang = false;
            } else {
                // Overwrite language-specific strings.
                // This way we'll never have missing translation keys.
                $foundlang = include $lang_file;
            }
        }
        $this->language = $PHPMAILER_LANG;
        return (boolean)$foundlang; // Returns false if language not found
    }

References $PHPMAILER_LANG.

Referenced by lang().

Here is the caller graph for this function:

setMessageType()

PHPMailer::setMessageType ( )

protected

Set the message type.

PHPMailer only supports some preset message types, not arbitrary MIME structures. @access protected

Returns

void

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

    {
        $type = array();
        if ($this->alternativeExists()) {
            $type[] = 'alt';
        }
        if ($this->inlineImageExists()) {
            $type[] = 'inline';
        }
        if ($this->attachmentExists()) {
            $type[] = 'attach';
        }
        $this->message_type = implode('_', $type);
        if ($this->message_type == '') {
            //The 'plain' message_type refers to the message having a single body element, not that it is plain-text
            $this->message_type = 'plain';
        }
    }

References alternativeExists(), attachmentExists(), and inlineImageExists().

Referenced by preSend().

Here is the call graph for this function:

Here is the caller graph for this function:

setWordWrap()

PHPMailer::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. @access public

Returns

void

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

    {
        if ($this->WordWrap < 1) {
            return;
        }
 
        switch ($this->message_type) {
            case 'alt':
            case 'alt_inline':
            case 'alt_attach':
            case 'alt_inline_attach':
                $this->AltBody = $this->wrapText($this->AltBody, $this->WordWrap);
                break;
            default:
                $this->Body = $this->wrapText($this->Body, $this->WordWrap);
                break;
        }
    }

References wrapText().

Referenced by createBody().

Here is the call graph for this function:

Here is the caller graph for this function:

sign()

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

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

@access 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 3748 of file class.phpmailer.php.

    {
        $this->sign_cert_file = $cert_filename;
        $this->sign_key_file = $key_filename;
        $this->sign_key_pass = $key_pass;
        $this->sign_extracerts_file = $extracerts_filename;
    }

smtpClose()

PHPMailer::smtpClose

(

)

Close the active SMTP session if one exists.

Returns

void

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

    {
        if (is_a($this->smtp, 'SMTP')) {
            if ($this->smtp->connected()) {
                $this->smtp->quit();
                $this->smtp->close();
            }
        }
    }

Referenced by __destruct().

Here is the caller graph for this function:

smtpConnect()

PHPMailer::smtpConnect

(

$options = null

)

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() @uses SMTP @access public

Exceptions

phpmailerException

Returns

boolean

Reimplemented in PHPMailerOAuth.

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

    {
        if (is_null($this->smtp)) {
            $this->smtp = $this->getSMTPInstance();
        }
 
        //If no options are provided, use whatever is set in the instance
        if (is_null($options)) {
            $options = $this->SMTPOptions;
        }
 
        // Already connected?
        if ($this->smtp->connected()) {
            return true;
        }
 
        $this->smtp->setTimeout($this->Timeout);
        $this->smtp->setDebugLevel($this->SMTPDebug);
        $this->smtp->setDebugOutput($this->Debugoutput);
        $this->smtp->setVerp($this->do_verp);
        $hosts = explode(';', $this->Host);
        $lastexception = null;
 
        foreach ($hosts as $hostentry) {
            $hostinfo = array();
            if (!preg_match('/^((ssl|tls):\/\/)*([a-zA-Z0-9\.-]*):?([0-9]*)$/', trim($hostentry), $hostinfo)) {
                // Not a valid host entry
                continue;
            }
            // $hostinfo[2]: optional ssl or tls prefix
            // $hostinfo[3]: the hostname
            // $hostinfo[4]: optional port number
            // The host string prefix can temporarily override the current setting for SMTPSecure
            // If it's not specified, the default value is used
            $prefix = '';
            $secure = $this->SMTPSecure;
            $tls = ($this->SMTPSecure == 'tls');
            if ('ssl' == $hostinfo[2] or ('' == $hostinfo[2] and 'ssl' == $this->SMTPSecure)) {
                $prefix = 'ssl://';
                $tls = false; // Can't have SSL and TLS at the same time
                $secure = 'ssl';
            } elseif ($hostinfo[2] == 'tls') {
                $tls = true;
                // tls doesn't use a prefix
                $secure = 'tls';
            }
            //Do we need the OpenSSL extension?
            $sslext = defined('OPENSSL_ALGO_SHA1');
            if ('tls' === $secure or 'ssl' === $secure) {
                //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled
                if (!$sslext) {
                    throw new phpmailerException($this->lang('extension_missing').'openssl', self::STOP_CRITICAL);
                }
            }
            $host = $hostinfo[3];
            $port = $this->Port;
            $tport = (integer)$hostinfo[4];
            if ($tport > 0 and $tport < 65536) {
                $port = $tport;
            }
            if ($this->smtp->connect($prefix . $host, $port, $this->Timeout, $options)) {
                try {
                    if ($this->Helo) {
                        $hello = $this->Helo;
                    } else {
                        $hello = $this->serverHostname();
                    }
                    $this->smtp->hello($hello);
                    //Automatically enable TLS encryption if:
                    // * it's not disabled
                    // * we have openssl extension
                    // * we are not already using SSL
                    // * the server offers STARTTLS
                    if ($this->SMTPAutoTLS and $sslext and $secure != 'ssl' and $this->smtp->getServerExt('STARTTLS')) {
                        $tls = true;
                    }
                    if ($tls) {
                        if (!$this->smtp->startTLS()) {
                            throw new phpmailerException($this->lang('connect_host'));
                        }
                        // We must resend EHLO after TLS negotiation
                        $this->smtp->hello($hello);
                    }
                    if ($this->SMTPAuth) {
                        if (!$this->smtp->authenticate(
                            $this->Username,
                            $this->Password,
                            $this->AuthType,
                            $this->Realm,
                            $this->Workstation
                        )
                        ) {
                            throw new phpmailerException($this->lang('authenticate'));
                        }
                    }
                    return true;
                } catch (phpmailerException $exc) {
                    $lastexception = $exc;
                    $this->edebug($exc->getMessage());
                    // We must have connected, but then failed TLS or Auth, so close connection nicely
                    $this->smtp->quit();
                }
            }
        }
        // If we get here, all connection attempts have failed, so close connection hard
        $this->smtp->close();
        // As we've caught all exceptions, just report whatever the last one was
        if ($this->exceptions and !is_null($lastexception)) {
            throw $lastexception;
        }
        return false;
    }

References $Helo, $options, $Port, $SMTPOptions, $SMTPSecure, edebug(), getSMTPInstance(), lang(), and serverHostname().

Referenced by smtpSend().

Here is the call graph for this function:

Here is the caller graph for this function:

smtpSend()

PHPMailer::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

@uses SMTP @access protected

Returns

boolean

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

    {
        $bad_rcpt = array();
        if (!$this->smtpConnect($this->SMTPOptions)) {
            throw new phpmailerException($this->lang('smtp_connect_failed'), self::STOP_CRITICAL);
        }
        if (!empty($this->Sender) and $this->validateAddress($this->Sender)) {
            $smtp_from = $this->Sender;
        } else {
            $smtp_from = $this->From;
        }
        if (!$this->smtp->mail($smtp_from)) {
            $this->setError($this->lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError()));
            throw new phpmailerException($this->ErrorInfo, self::STOP_CRITICAL);
        }
 
        // Attempt to send to all recipients
        foreach (array($this->to, $this->cc, $this->bcc) as $togroup) {
            foreach ($togroup as $to) {
                if (!$this->smtp->recipient($to[0])) {
                    $error = $this->smtp->getError();
                    $bad_rcpt[] = array('to' => $to[0], 'error' => $error['detail']);
                    $isSent = false;
                } else {
                    $isSent = true;
                }
                $this->doCallback($isSent, array($to[0]), array(), array(), $this->Subject, $body, $this->From);
            }
        }
 
        // Only send the DATA command if we have viable recipients
        if ((count($this->all_recipients) > count($bad_rcpt)) and !$this->smtp->data($header . $body)) {
            throw new phpmailerException($this->lang('data_not_accepted'), self::STOP_CRITICAL);
        }
        if ($this->SMTPKeepAlive) {
            $this->smtp->reset();
        } else {
            $this->smtp->quit();
            $this->smtp->close();
        }
        //Create error message for any bad addresses
        if (count($bad_rcpt) > 0) {
            $errstr = '';
            foreach ($bad_rcpt as $bad) {
                $errstr .= $bad['to'] . ': ' . $bad['error'];
            }
            throw new phpmailerException(
                $this->lang('recipients_failed') . $errstr,
                self::STOP_CONTINUE
            );
        }
        return true;
    }

References $From, $header, $Sender, $to, doCallback(), lang(), setError(), smtpConnect(), and validateAddress().

Referenced by postSend().

Here is the call graph for this function:

Here is the caller graph for this function:

textLine()

PHPMailer::textLine

(

$value

)

Return a formatted mail line.

@access public

Parameters

string

$value

Returns

string

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

    {
        return $value . $this->LE;
    }

References $LE.

Referenced by createBody(), getBoundary(), and getMailMIME().

Here is the caller graph for this function:

utf8CharBoundary()

PHPMailer::utf8CharBoundary	(		$encodedText,
			$maxLength
	)

Find the last character boundary prior to $maxLength in a utf-8 quoted-printable encoded string.

Original written by Colin Brown. @access public

Parameters

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

Returns

integer

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

    {
        $foundSplitPos = false;
        $lookBack = 3;
        while (!$foundSplitPos) {
            $lastChunk = substr($encodedText, $maxLength - $lookBack, $lookBack);
            $encodedCharPos = strpos($lastChunk, '=');
            if (false !== $encodedCharPos) {
                // Found start of encoded character byte within $lookBack block.
                // Check the encoded byte value (the 2 chars after the '=')
                $hex = substr($encodedText, $maxLength - $lookBack + $encodedCharPos + 1, 2);
                $dec = hexdec($hex);
                if ($dec < 128) {
                    // Single byte character.
                    // If the encoded char was found at pos 0, it will fit
                    // otherwise reduce maxLength to start of the encoded char
                    if ($encodedCharPos > 0) {
                        $maxLength = $maxLength - ($lookBack - $encodedCharPos);
                    }
                    $foundSplitPos = true;
                } elseif ($dec >= 192) {
                    // First byte of a multi byte character
                    // Reduce maxLength to split at start of character
                    $maxLength = $maxLength - ($lookBack - $encodedCharPos);
                    $foundSplitPos = true;
                } elseif ($dec < 192) {
                    // Middle byte of a multi byte character, look further back
                    $lookBack += 3;
                }
            } else {
                // No encoded character found
                $foundSplitPos = true;
            }
        }
        return $maxLength;
    }

Referenced by wrapText().

Here is the caller graph for this function:

validateAddress()

static PHPMailer::validateAddress (   $address,   $patternselect = null  )

static

Check that a string looks like an email address.

Parameters

string	$address	The email address to check
string | callable	$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. Alternatively you may pass in a callable to inject your own validator, for example: PHPMailer::validateAddress('user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om', 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.

Returns

boolean

@access 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 1074 of file class.phpmailer.php.

    {
        if (is_null($patternselect)) {
            $patternselect = self::$validator;
        }
        if (is_callable($patternselect)) {
            return call_user_func($patternselect, $address);
        }
        //Reject line breaks in addresses; it's valid RFC5322, but not RFC5321
        if (strpos($address, "\n") !== false or strpos($address, "\r") !== false) {
            return false;
        }
        if (!$patternselect or $patternselect == 'auto') {
            //Check this constant first so it works when extension_loaded() is disabled by safe mode
            //Constant was added in PHP 5.2.4
            if (defined('PCRE_VERSION')) {
                //This pattern can get stuck in a recursive loop in PCRE <= 8.0.2
                if (version_compare(PCRE_VERSION, '8.0.3') >= 0) {
                    $patternselect = 'pcre8';
                } else {
                    $patternselect = 'pcre';
                }
            } elseif (function_exists('extension_loaded') and extension_loaded('pcre')) {
                //Fall back to older PCRE
                $patternselect = 'pcre';
            } else {
                //Filter_var appeared in PHP 5.2.0 and does not require the PCRE extension
                if (version_compare(PHP_VERSION, '5.2.0') >= 0) {
                    $patternselect = 'php';
                } else {
                    $patternselect = 'noregex';
                }
            }
        }
        switch ($patternselect) {
            case 'pcre8':
                return (boolean)preg_match(
                    '/^(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){255,})(?!(?>(?1)"?(?>\\\[ -~]|[^"])"?(?1)){65,}@)' .
                    '((?>(?>(?>((?>(?>(?>\x0D\x0A)?[\t ])+|(?>[\t ]*\x0D\x0A)?[\t ]+)?)(\‍((?>(?2)' .
                    '(?>[\x01-\x08\x0B\x0C\x0E-\'*-\[\]-\x7F]|\\\[\x00-\x7F]|(?3)))*(?2)\‍)))+(?2))|(?2))?)' .
                    '([!#-\'*+\/-9=?^-~-]+|"(?>(?2)(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\x7F]))*' .
                    '(?2)")(?>(?1)\.(?1)(?4))*(?1)@(?!(?1)[a-z0-9-]{64,})(?1)(?>([a-z0-9](?>[a-z0-9-]*[a-z0-9])?)' .
                    '(?>(?1)\.(?!(?1)[a-z0-9-]{64,})(?1)(?5)){0,126}|\[(?:(?>IPv6:(?>([a-f0-9]{1,4})(?>:(?6)){7}' .
                    '|(?!(?:.*[a-f0-9][:\]]){8,})((?6)(?>:(?6)){0,6})?::(?7)?))|(?>(?>IPv6:(?>(?6)(?>:(?6)){5}:' .
                    '|(?!(?:.*[a-f0-9]:){6,})(?8)?::(?>((?6)(?>:(?6)){0,4}):)?))?(25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
                    '|[1-9]?[0-9])(?>\.(?9)){3}))\])(?1)$/isD',
                    $address
                );
            case 'pcre':
                //An older regex that doesn't need a recent PCRE
                return (boolean)preg_match(
                    '/^(?!(?>"?(?>\\\[ -~]|[^"])"?){255,})(?!(?>"?(?>\\\[ -~]|[^"])"?){65,}@)(?>' .
                    '[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*")' .
                    '(?>\.(?>[!#-\'*+\/-9=?^-~-]+|"(?>(?>[\x01-\x08\x0B\x0C\x0E-!#-\[\]-\x7F]|\\\[\x00-\xFF]))*"))*' .
                    '@(?>(?![a-z0-9-]{64,})(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)(?>\.(?![a-z0-9-]{64,})' .
                    '(?>[a-z0-9](?>[a-z0-9-]*[a-z0-9])?)){0,126}|\[(?:(?>IPv6:(?>(?>[a-f0-9]{1,4})(?>:' .
                    '[a-f0-9]{1,4}){7}|(?!(?:.*[a-f0-9][:\]]){8,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?' .
                    '::(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,6})?))|(?>(?>IPv6:(?>[a-f0-9]{1,4}(?>:' .
                    '[a-f0-9]{1,4}){5}:|(?!(?:.*[a-f0-9]:){6,})(?>[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4})?' .
                    '::(?>(?:[a-f0-9]{1,4}(?>:[a-f0-9]{1,4}){0,4}):)?))?(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}' .
                    '|[1-9]?[0-9])(?>\.(?>25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}))\])$/isD',
                    $address
                );
            case 'html5':
                return (boolean)preg_match(
                    '/^[a-zA-Z0-9.!#$%&\'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}' .
                    '[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/sD',
                    $address
                );
            case 'noregex':
                //No PCRE! Do something _very_ approximate!
                //Check the address is 3 chars or longer and contains an @ that's not the first or last char
                return (strlen($address) >= 3
                    and strpos($address, '@') >= 1
                    and strpos($address, '@') != strlen($address) - 1);
            case 'php':
            default:
                return (boolean)filter_var($address, FILTER_VALIDATE_EMAIL);
        }
    }

References $validator.

Referenced by addAnAddress(), mailSend(), parseAddresses(), preSend(), setFrom(), and smtpSend().

Here is the caller graph for this function:

wrapText()

PHPMailer::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 @access public

Returns

string

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

    {
        if ($qp_mode) {
            $soft_break = sprintf(' =%s', $this->LE);
        } else {
            $soft_break = $this->LE;
        }
        // If utf-8 encoding is used, we will need to make sure we don't
        // split multibyte characters when we wrap
        $is_utf8 = (strtolower($this->CharSet) == 'utf-8');
        $lelen = strlen($this->LE);
        $crlflen = strlen(self::CRLF);
 
        $message = $this->fixEOL($message);
        //Remove a trailing line break
        if (substr($message, -$lelen) == $this->LE) {
            $message = substr($message, 0, -$lelen);
        }
 
        //Split message into lines
        $lines = explode($this->LE, $message);
        //Message will be rebuilt in here
        $message = '';
        foreach ($lines as $line) {
            $words = explode(' ', $line);
            $buf = '';
            $firstword = true;
            foreach ($words as $word) {
                if ($qp_mode and (strlen($word) > $length)) {
                    $space_left = $length - strlen($buf) - $crlflen;
                    if (!$firstword) {
                        if ($space_left > 20) {
                            $len = $space_left;
                            if ($is_utf8) {
                                $len = $this->utf8CharBoundary($word, $len);
                            } elseif (substr($word, $len - 1, 1) == '=') {
                                $len--;
                            } elseif (substr($word, $len - 2, 1) == '=') {
                                $len -= 2;
                            }
                            $part = substr($word, 0, $len);
                            $word = substr($word, $len);
                            $buf .= ' ' . $part;
                            $message .= $buf . sprintf('=%s', self::CRLF);
                        } else {
                            $message .= $buf . $soft_break;
                        }
                        $buf = '';
                    }
                    while (strlen($word) > 0) {
                        if ($length <= 0) {
                            break;
                        }
                        $len = $length;
                        if ($is_utf8) {
                            $len = $this->utf8CharBoundary($word, $len);
                        } elseif (substr($word, $len - 1, 1) == '=') {
                            $len--;
                        } elseif (substr($word, $len - 2, 1) == '=') {
                            $len -= 2;
                        }
                        $part = substr($word, 0, $len);
                        $word = substr($word, $len);
 
                        if (strlen($word) > 0) {
                            $message .= $part . sprintf('=%s', self::CRLF);
                        } else {
                            $buf = $part;
                        }
                    }
                } else {
                    $buf_o = $buf;
                    if (!$firstword) {
                        $buf .= ' ';
                    }
                    $buf .= $word;
 
                    if (strlen($buf) > $length and $buf_o != '') {
                        $message .= $buf_o . $soft_break;
                        $buf = $word;
                    }
                }
                $firstword = false;
            }
            $message .= $buf . self::CRLF;
        }
 
        return $message;
    }

References $LE, CRLF, fixEOL(), and utf8CharBoundary().

Referenced by encodeHeader(), and setWordWrap().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_function

PHPMailer::$action_function = ''

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

$all_recipients

PHPMailer::$all_recipients = array()

protected

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

Referenced by getAllRecipientAddresses().

$AllowEmpty

PHPMailer::$AllowEmpty = false

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

$AltBody

PHPMailer::$AltBody = ''

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

$attachment

PHPMailer::$attachment = array()

protected

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

Referenced by attachAll(), attachmentExists(), getAttachments(), and inlineImageExists().

$AuthType

PHPMailer::$AuthType = ''

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

$bcc

PHPMailer::$bcc = array()

protected

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

Referenced by clearBCCs(), doCallback(), and getBccAddresses().

$Body

PHPMailer::$Body = ''

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

Referenced by msgHTML().

$boundary

PHPMailer::$boundary = array()

protected

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

Referenced by attachAll(), endBoundary(), and getBoundary().

$cc

PHPMailer::$cc = array()

protected

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

Referenced by clearCCs(), doCallback(), and getCcAddresses().

$CharSet

PHPMailer::$CharSet = 'iso-8859-1'

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

Referenced by createBody(), and getBoundary().

$ConfirmReadingTo

PHPMailer::$ConfirmReadingTo = ''

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

$ContentType

PHPMailer::$ContentType = 'text/plain'

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

Referenced by getBoundary().

$CustomHeader

PHPMailer::$CustomHeader = array()

protected

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

Referenced by getCustomHeaders().

$Debugoutput

PHPMailer::$Debugoutput = 'echo'

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

$DKIM_domain

PHPMailer::$DKIM_domain = ''

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

$DKIM_identity

PHPMailer::$DKIM_identity = ''

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

$DKIM_passphrase

PHPMailer::$DKIM_passphrase = ''

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

$DKIM_private

PHPMailer::$DKIM_private = ''

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

$DKIM_private_string

PHPMailer::$DKIM_private_string = ''

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

$DKIM_selector

PHPMailer::$DKIM_selector = ''

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

$do_verp

PHPMailer::$do_verp = false

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

$Encoding

PHPMailer::$Encoding = '8bit'

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

Referenced by createBody(), and getBoundary().

$error_count

PHPMailer::$error_count = 0

protected

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

$ErrorInfo

PHPMailer::$ErrorInfo = ''

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

$exceptions

PHPMailer::$exceptions = false

protected

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

Referenced by __construct().

$From

PHPMailer::$From = 'root@localhost'

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

Referenced by smtpSend().

$FromName

PHPMailer::$FromName = 'Root User'

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

$Helo

PHPMailer::$Helo = ''

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

Referenced by PHPMailerOAuth\smtpConnect(), and smtpConnect().

$Host

PHPMailer::$Host = 'localhost'

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

$Hostname

PHPMailer::$Hostname = ''

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

Referenced by serverHostname().

$Ical

PHPMailer::$Ical = ''

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

$language

PHPMailer::$language = array()

protected

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

Referenced by getTranslations().

$lastMessageID

PHPMailer::$lastMessageID = ''

protected

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

Referenced by getLastMessageID().

$LE

PHPMailer::$LE = "\n"

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

Referenced by addrAppend(), attachAll(), base64EncodeWrapMB(), createBody(), encodeString(), endBoundary(), getBoundary(), getMailMIME(), headerLine(), textLine(), and wrapText().

$Mailer

PHPMailer::$Mailer = 'mail'

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

$mailHeader

PHPMailer::$mailHeader = ''

protected

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

$message_type

PHPMailer::$message_type = ''

protected

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

$MessageDate

PHPMailer::$MessageDate = ''

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

$MessageID

PHPMailer::$MessageID = ''

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

Referenced by createHeader().

$MIMEBody

PHPMailer::$MIMEBody = ''

protected

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

Referenced by getSentMIMEMessage().

$MIMEHeader

PHPMailer::$MIMEHeader = ''

protected

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

Referenced by preSend().

$Password

PHPMailer::$Password = ''

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

$PluginDir

PHPMailer::$PluginDir = ''

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

$Port

PHPMailer::$Port = 25

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

Referenced by PHPMailerOAuth\smtpConnect(), and smtpConnect().

$Priority

PHPMailer::$Priority = null

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

$Realm

PHPMailer::$Realm = ''

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

$RecipientsQueue

PHPMailer::$RecipientsQueue = array()

protected

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

Referenced by clearQueuedAddresses().

$ReplyTo

PHPMailer::$ReplyTo = array()

protected

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

Referenced by getReplyToAddresses().

$ReplyToQueue

PHPMailer::$ReplyToQueue = array()

protected

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

$ReturnPath

PHPMailer::$ReturnPath = ''

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

$Sender

PHPMailer::$Sender = ''

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

Referenced by smtpSend().

$Sendmail

PHPMailer::$Sendmail = '/usr/sbin/sendmail'

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

$sign_cert_file

PHPMailer::$sign_cert_file = ''

protected

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

$sign_extracerts_file

PHPMailer::$sign_extracerts_file = ''

protected

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

$sign_key_file

PHPMailer::$sign_key_file = ''

protected

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

$sign_key_pass

PHPMailer::$sign_key_pass = ''

protected

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

$SingleTo

PHPMailer::$SingleTo = false

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

$SingleToArray

PHPMailer::$SingleToArray = array()

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

$smtp

PHPMailer::$smtp = null

protected

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

Referenced by getSMTPInstance().

$SMTPAuth

PHPMailer::$SMTPAuth = false

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

$SMTPAutoTLS

PHPMailer::$SMTPAutoTLS = true

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

$SMTPDebug

PHPMailer::$SMTPDebug = 0

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

$SMTPKeepAlive

PHPMailer::$SMTPKeepAlive = false

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

$SMTPOptions

PHPMailer::$SMTPOptions = array()

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

Referenced by smtpConnect().

$SMTPSecure

PHPMailer::$SMTPSecure = ''

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

Referenced by PHPMailerOAuth\smtpConnect(), and smtpConnect().

$Subject

PHPMailer::$Subject = ''

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

$Timeout

PHPMailer::$Timeout = 300

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

$to

PHPMailer::$to = array()

protected

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

Referenced by clearAddresses(), DKIM_Add(), doCallback(), getToAddresses(), mailPassthru(), mailSend(), and smtpSend().

$uniqueid

PHPMailer::$uniqueid = ''

protected

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

Referenced by createBody().

$Username

PHPMailer::$Username = ''

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

$UseSendmailOptions

PHPMailer::$UseSendmailOptions = true

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

$validator

PHPMailer::$validator = 'auto'

static

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

Referenced by validateAddress().

$Version

PHPMailer::$Version = '5.2.22'

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

$WordWrap

PHPMailer::$WordWrap = 0

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

$Workstation

PHPMailer::$Workstation = ''

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

$XMailer

PHPMailer::$XMailer = ''

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

CRLF

const PHPMailer::CRLF = "\r\n"

SMTP RFC standard line ending.

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

Referenced by msgHTML(), preSend(), and wrapText().

MAX_LINE_LENGTH

const PHPMailer::MAX_LINE_LENGTH = 998

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

STOP_CONTINUE

const PHPMailer::STOP_CONTINUE = 1

Error severity: message, likely ok to continue processing.

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

STOP_CRITICAL

const PHPMailer::STOP_CRITICAL = 2

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

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

STOP_MESSAGE

const PHPMailer::STOP_MESSAGE = 0

Error severity: message only, continue processing.

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

---

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

• Services/Mail/phpmailer/class.phpmailer.php