PHPMailer\PHPMailer\PHPMailer Class Reference

PHPMailer - PHP email creation and transport class. More...

Collaboration diagram for PHPMailer\PHPMailer\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...
	setFrom ($address, $name='', $auto=true)
	Set the From and FromName properties. More...
	getLastMessageID ()
	Return the Message-ID header of the last email. 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 via the selected mechanism. More...
	getSMTPInstance ()
	Get an instance to use for SMTP operations. More...
	setSMTPInstance (SMTP $smtp)
	Provide 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=self::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=self::ENCODING_BASE64)
	Encode a string in requested format. More...
	encodeHeader ($str, $position='text')
	Encode a header value (not including its label) 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)
	Encode a string in quoted-printable format. More...
	encodeQ ($str, $position='text')
	Encode a string using Q encoding. More...
	addStringAttachment ( $string, $filename, $encoding=self::ENCODING_BASE64, $type='', $disposition='attachment')
	Add a string or binary attachment (non-filesystem). More...
	addEmbeddedImage ( $path, $cid, $name='', $encoding=self::ENCODING_BASE64, $type='', $disposition='inline')
	Add an embedded (inline) attachment from a file. More...
	addStringEmbeddedImage ( $string, $cid, $name='', $encoding=self::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...
	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...
	getOAuth ()
	Get the OAuth instance. More...
	setOAuth (OAuth $oauth)
	Set an OAuth instance. More...

Static Public Member Functions
static	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...
static	validateAddress ($address, $patternselect=null)
	Check that a string looks like an email address. More...
static	idnSupported ()
	Tells whether IDNs (Internationalized Domain Names) are supported or not. More...
static	rfcDate ()
	Return an RFC 822 formatted date. More...
static	isValidHost ($host)
	Validate whether a string contains a valid value to use as a hostname or IP address. 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=null)
	Normalize line breaks in a string. More...
static	stripTrailingWSP ($text)
	Remove trailing breaks from a string. More...
static	getLE ()
	Return the current line break format string. More...
static	hasLineLongerThanMax ($str)
	Detect if a string contains a line longer than the maximum line length allowed by RFC 2822 section 2.1.1. More...
static	quotedString ($str)
	If a string contains any "special" characters, double-quote the name, and escape any double quotes with a backslash. More...

Data Fields
const	CHARSET_ASCII = 'us-ascii'
const	CHARSET_ISO88591 = 'iso-8859-1'
const	CHARSET_UTF8 = 'utf-8'
const	CONTENT_TYPE_PLAINTEXT = 'text/plain'
const	CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'
const	CONTENT_TYPE_TEXT_HTML = 'text/html'
const	CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'
const	CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'
const	CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'
const	ENCODING_7BIT = '7bit'
const	ENCODING_8BIT = '8bit'
const	ENCODING_BASE64 = 'base64'
const	ENCODING_BINARY = 'binary'
const	ENCODING_QUOTED_PRINTABLE = 'quoted-printable'
const	ENCRYPTION_STARTTLS = 'tls'
const	ENCRYPTION_SMTPS = 'ssl'
const	ICAL_METHOD_REQUEST = 'REQUEST'
const	ICAL_METHOD_PUBLISH = 'PUBLISH'
const	ICAL_METHOD_REPLY = 'REPLY'
const	ICAL_METHOD_ADD = 'ADD'
const	ICAL_METHOD_CANCEL = 'CANCEL'
const	ICAL_METHOD_REFRESH = 'REFRESH'
const	ICAL_METHOD_COUNTER = 'COUNTER'
const	ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'
	$Priority
	$CharSet = self::CHARSET_ISO88591
	$ContentType = self::CONTENT_TYPE_PLAINTEXT
	$Encoding = self::ENCODING_8BIT
	$ErrorInfo = ''
	$From = 'root@localhost'
	$FromName = 'Root User'
	$Sender = ''
	$Subject = ''
	$Body = ''
	$AltBody = ''
	$Ical = ''
	$WordWrap = 0
	$Mailer = 'mail'
	$Sendmail = '/usr/sbin/sendmail'
	$UseSendmailOptions = true
	$ConfirmReadingTo = ''
	$Hostname = ''
	$MessageID = ''
	$MessageDate = ''
	$Host = 'localhost'
	$Port = 25
	$Helo = ''
	$SMTPSecure = ''
	$SMTPAutoTLS = true
	$SMTPAuth = false
	$SMTPOptions = []
	$Username = ''
	$Password = ''
	$AuthType = ''
	$Timeout = 300
	$dsn = ''
	Comma separated list of DSN notifications 'NEVER' under no circumstances a DSN must be returned to the sender. More...
	$SMTPDebug = 0
	$Debugoutput = 'echo'
	$SMTPKeepAlive = false
	$SingleTo = false
	$do_verp = false
	$AllowEmpty = false
	$DKIM_selector = ''
	$DKIM_identity = ''
	$DKIM_passphrase = ''
	$DKIM_domain = ''
	$DKIM_copyHeaderFields = true
	$DKIM_extraHeaders = []
	$DKIM_private = ''
	$DKIM_private_string = ''
	$action_function = ''
	$XMailer = ''
const	VERSION = '6.1.6'
const	STOP_MESSAGE = 0
const	STOP_CONTINUE = 1
const	STOP_CRITICAL = 2
const	CRLF = "\r\n"
	The SMTP standard CRLF line break. More...
const	FWS = ' '
	"Folding White Space" a white space string used for line folding. More...
const	MAIL_MAX_LINE_LENGTH = 63
const	MAX_LINE_LENGTH = 998
const	STD_LINE_LENGTH = 76

Static Public Attributes
static	$validator = 'php'

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 a unique ID to use for boundaries. 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=self::ENCODING_BASE64)
	Encode a file attachment in requested format. More...
	validateEncoding ($encoding)
	Validate encodings. More...
	cidExists ($cid)
	Check if an embedded attachment is present with this cid. 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, $extra)
	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...
static	isPermittedPath ($path)
	Check whether a file path is of a permitted type. More...
static	setLE ($le)
	Set the line break format string, e.g. More...

Protected Attributes
	$MIMEBody = ''
	$MIMEHeader = ''
	$mailHeader = ''
	$oauth
	$SingleToArray = []
	$smtp
	$to = []
	$cc = []
	$bcc = []
	$ReplyTo = []
	$all_recipients = []
	$RecipientsQueue = []
	$ReplyToQueue = []
	$attachment = []
	$CustomHeader = []
	$lastMessageID = ''
	$message_type = ''
	$boundary = []
	$language = []
	$error_count = 0
	$sign_cert_file = ''
	$sign_key_file = ''
	$sign_extracerts_file = ''
	$sign_key_pass = ''
	$exceptions = false
	$uniqueid = ''

Static Protected Attributes
static	$IcalMethods
static	$LE = self::CRLF

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

Detailed Description

PHPMailer - PHP email creation and transport class.

Author

Marcus Bointon (Synchro/coolbru) phpma.nosp@m.iler.nosp@m.@sync.nosp@m.hrom.nosp@m.edia..nosp@m.co.u.nosp@m.k

Jim Jagielski (jimjag) jimja.nosp@m.g@gm.nosp@m.ail.c.nosp@m.om

Andy Prevost (codeworxtech) codew.nosp@m.orxt.nosp@m.ech@u.nosp@m.sers.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et

Brent R. Matzelle (original founder)

Definition at line 31 of file PHPMailer.php.

Constructor & Destructor Documentation

__construct()

PHPMailer\PHPMailer\PHPMailer::__construct

(

$exceptions = null

)

Constructor.

Parameters

bool

$exceptions

Should we throw external exceptions?

Definition at line 821 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$exceptions.

    {
        if (null !== $exceptions) {
            $this->exceptions = (bool) $exceptions;
        }
        //Pick an appropriate debug output format automatically
        $this->Debugoutput = (strpos(PHP_SAPI, 'cli') !== false ? 'echo' : 'html');
    }

__destruct()

PHPMailer\PHPMailer\PHPMailer::__destruct

(

)

Destructor.

Definition at line 833 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\smtpClose().

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

Here is the call graph for this function:

Member Function Documentation

_mime_types()

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

static

Get the MIME type for a file extension.

Parameters

string

$ext

File extension

Returns

string MIME type of file

Definition at line 4140 of file PHPMailer.php.

    {
        $mimes = [
            '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',
            'm4a' => 'audio/mp4',
            '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',
            'mka' => 'audio/x-matroska',
            'bmp' => 'image/bmp',
            'gif' => 'image/gif',
            'jpeg' => 'image/jpeg',
            'jpe' => 'image/jpeg',
            'jpg' => 'image/jpeg',
            'png' => 'image/png',
            'tiff' => 'image/tiff',
            'tif' => 'image/tiff',
            'webp' => 'image/webp',
            'heif' => 'image/heif',
            'heifs' => 'image/heif-sequence',
            'heic' => 'image/heic',
            'heics' => 'image/heic-sequence',
            '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',
            'ics' => 'text/calendar',
            'xml' => 'text/xml',
            'xsl' => 'text/xml',
            'wmv' => 'video/x-ms-wmv',
            'mpeg' => 'video/mpeg',
            'mpe' => 'video/mpeg',
            'mpg' => 'video/mpeg',
            'mp4' => 'video/mp4',
            'm4v' => 'video/mp4',
            'mov' => 'video/quicktime',
            'qt' => 'video/quicktime',
            'rv' => 'video/vnd.rn-realvideo',
            'avi' => 'video/x-msvideo',
            'movie' => 'video/x-sgi-movie',
            'webm' => 'video/webm',
            'mkv' => 'video/x-matroska',
        ];
        $ext = strtolower($ext);
        if (array_key_exists($ext, $mimes)) {
            return $mimes[$ext];
        }

        return 'application/octet-stream';
    }

addAddress()

PHPMailer\PHPMailer\PHPMailer::addAddress	(		$address,
			$name = ''
	)

Add a "To" address.

Parameters

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

Exceptions

Exception

Returns

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

Definition at line 1005 of file PHPMailer.php.

References $name, and PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress().

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

Here is the call graph for this function:

addAnAddress()

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

Exception

Returns

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

Definition at line 1124 of file PHPMailer.php.

References $name, PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

    {
        if (!in_array($kind, ['to', 'cc', 'bcc', 'Reply-To'])) {
            $error_message = sprintf(
                '%s: %s',
                $this->lang('Invalid recipient kind'),
                $kind
            );
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new Exception($error_message);
            }

            return false;
        }
        if (!static::validateAddress($address)) {
            $error_message = sprintf(
                '%s (%s): %s',
                $this->lang('invalid_address'),
                $kind,
                $address
            );
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new Exception($error_message);
            }

            return false;
        }
        if ('Reply-To' !== $kind) {
            if (!array_key_exists(strtolower($address), $this->all_recipients)) {
                $this->{$kind}[] = [$address, $name];
                $this->all_recipients[strtolower($address)] = true;

                return true;
            }
        } elseif (!array_key_exists(strtolower($address), $this->ReplyTo)) {
            $this->ReplyTo[strtolower($address)] = [$address, $name];

            return true;
        }

        return false;
    }

Here is the call graph for this function:

addAttachment()

PHPMailer\PHPMailer\PHPMailer::addAttachment	(		$path,
			$name = '',
			$encoding = self::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. Explicitly does not support passing URLs; PHPMailer is not an HTTP client. If you need to do that, fetch the resource yourself and pass it in via a local file or string.

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

Exception

Returns

bool

Definition at line 2963 of file PHPMailer.php.

References $filename, $name, $path, $type, attachment(), PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\lang(), PHPMailer\PHPMailer\PHPMailer\setError(), and PHPMailer\PHPMailer\PHPMailer\validateEncoding().

      {
        try {
            if (!static::isPermittedPath($path) || !@is_file($path) || !is_readable($path)) {
                throw new Exception($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 = static::filenameToType($path);
            }

            $filename = (string) static::mb_pathinfo($path, PATHINFO_BASENAME);
            if ('' === $name) {
                $name = $filename;
            }

            if (!$this->validateEncoding($encoding)) {
                throw new Exception($this->lang('encoding') . $encoding);
            }

            $this->attachment[] = [
                0 => $path,
                1 => $filename,
                2 => $name,
                3 => $encoding,
                4 => $type,
                5 => false, // isStringAttachment
                6 => $disposition,
                7 => $name,
            ];
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }

        return true;
    }

Here is the call graph for this function:

addBCC()

PHPMailer\PHPMailer\PHPMailer::addBCC	(		$address,
			$name = ''
	)

Add a "BCC" address.

Parameters

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

Exceptions

Exception

Returns

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

Definition at line 1035 of file PHPMailer.php.

References $name, and PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress().

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

Here is the call graph for this function:

addCC()

PHPMailer\PHPMailer\PHPMailer::addCC	(		$address,
			$name = ''
	)

Add a "CC" address.

Parameters

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

Exceptions

Exception

Returns

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

Definition at line 1020 of file PHPMailer.php.

References $name, and PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress().

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

Here is the call graph for this function:

addCustomHeader()

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

Add a custom header.

$name value can be overloaded to contain both header name and value (name:value).

Parameters

string	$name	Custom header name
string | null	$value	Header value

Exceptions

Exception

Definition at line 3954 of file PHPMailer.php.

References $name.

    {
        if (null === $value && strpos($name, ':') !== false) {
            // Value passed in as name:value
            list($name, $value) = explode(':', $name, 2);
        }
        $name = trim($name);
        $value = trim($value);
        //Ensure name is not empty, and that neither name nor value contain line breaks
        if (empty($name) || strpbrk($name . $value, "\r\n") !== false) {
            if ($this->exceptions) {
                throw new Exception('Invalid header name or value');
            }

            return false;
        }
        $this->CustomHeader[] = [$name, $value];

        return true;
    }

addEmbeddedImage()

PHPMailer\PHPMailer\PHPMailer::addEmbeddedImage	(		$path,
			$cid,
			$name = '',
			$encoding = self::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

Exceptions

Exception

Returns

bool True on successfully adding an attachment

Definition at line 3523 of file PHPMailer.php.

References $filename, $name, $path, $type, attachment(), PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\lang(), PHPMailer\PHPMailer\PHPMailer\setError(), and PHPMailer\PHPMailer\PHPMailer\validateEncoding().

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

      {
        try {
            if (!static::isPermittedPath($path) || !@is_file($path) || !is_readable($path)) {
                throw new Exception($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 = static::filenameToType($path);
            }

            if (!$this->validateEncoding($encoding)) {
                throw new Exception($this->lang('encoding') . $encoding);
            }

            $filename = (string) static::mb_pathinfo($path, PATHINFO_BASENAME);
            if ('' === $name) {
                $name = $filename;
            }

            // Append to $attachment array
            $this->attachment[] = [
                0 => $path,
                1 => $filename,
                2 => $name,
                3 => $encoding,
                4 => $type,
                5 => false, // isStringAttachment
                6 => $disposition,
                7 => $cid,
            ];
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addOrEnqueueAnAddress()

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

Exception

Returns

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

Definition at line 1069 of file PHPMailer.php.

References $name, PHPMailer\PHPMailer\$params, PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\has8bitChars(), PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

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

    {
        $address = trim($address);
        $name = trim(preg_replace('/[\r\n]+/', '', $name)); //Strip breaks and trim
        $pos = strrpos($address, '@');
        if (false === $pos) {
            // At-sign is missing.
            $error_message = sprintf(
                '%s (%s): %s',
                $this->lang('invalid_address'),
                $kind,
                $address
            );
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new Exception($error_message);
            }

            return false;
        }
        $params = [$kind, $address, $name];
        // Enqueue addresses with IDN until we know the PHPMailer::$CharSet.
        if (static::idnSupported() && $this->has8bitChars(substr($address, ++$pos))) {
            if ('Reply-To' !== $kind) {
                if (!array_key_exists($address, $this->RecipientsQueue)) {
                    $this->RecipientsQueue[$address] = $params;

                    return true;
                }
            } elseif (!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([$this, 'addAnAddress'], $params);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addrAppend()

PHPMailer\PHPMailer\PHPMailer::addrAppend	(		$type,
			$addr
	)

Create recipient headers.

Parameters

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

Returns

string

Definition at line 2173 of file PHPMailer.php.

References $type, and PHPMailer\PHPMailer\PHPMailer\addrFormat().

Referenced by PHPMailer\PHPMailer\PHPMailer\createHeader(), and PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        $addresses = [];
        foreach ($addr as $address) {
            $addresses[] = $this->addrFormat($address);
        }

        return $type . ': ' . implode(', ', $addresses) . static::$LE;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addReplyTo()

PHPMailer\PHPMailer\PHPMailer::addReplyTo	(		$address,
			$name = ''
	)

Add a "Reply-To" address.

Parameters

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

Exceptions

Exception

Returns

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

Definition at line 1050 of file PHPMailer.php.

References $name, and PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress().

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

Here is the call graph for this function:

addrFormat()

PHPMailer\PHPMailer\PHPMailer::addrFormat

(

$addr

)

Format an address for use in a message header.

Parameters

array

$addr

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

Returns

string

Definition at line 2191 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\encodeHeader(), and PHPMailer\PHPMailer\PHPMailer\secureHeader().

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

    {
        if (empty($addr[1])) { // No name provided
            return $this->secureHeader($addr[0]);
        }

        return $this->encodeHeader($this->secureHeader($addr[1]), 'phrase') .
            ' <' . $this->secureHeader($addr[0]) . '>';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addStringAttachment()

PHPMailer\PHPMailer\PHPMailer::addStringAttachment	(		$string,
			$filename,
			$encoding = self::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

Exceptions

Exception

Returns

bool True on successfully adding an attachment

Definition at line 3461 of file PHPMailer.php.

References $filename, $type, attachment(), PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\lang(), PHPMailer\PHPMailer\PHPMailer\setError(), and PHPMailer\PHPMailer\PHPMailer\validateEncoding().

      {
        try {
            // If a MIME type is not specified, try to work it out from the file name
            if ('' === $type) {
                $type = static::filenameToType($filename);
            }

            if (!$this->validateEncoding($encoding)) {
                throw new Exception($this->lang('encoding') . $encoding);
            }

            // Append to $attachment array
            $this->attachment[] = [
                0 => $string,
                1 => $filename,
                2 => static::mb_pathinfo($filename, PATHINFO_BASENAME),
                3 => $encoding,
                4 => $type,
                5 => true, // isStringAttachment
                6 => $disposition,
                7 => 0,
            ];
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }

        return true;
    }

Here is the call graph for this function:

addStringEmbeddedImage()

PHPMailer\PHPMailer\PHPMailer::addStringEmbeddedImage	(		$string,
			$cid,
			$name = '',
			$encoding = self::ENCODING_BASE64,
			$type = '',
			$disposition = 'inline'
	)

Add an embedded stringified attachment.

This can include images, sounds, and just about any other document type. If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.

Parameters

string	$string	The attachment binary data
string	$cid	Content ID of the attachment; Use this to reference the content when using an embedded image in HTML
string	$name	A filename for the attachment. If this contains an extension, PHPMailer will attempt to set a MIME type for the attachment. For example 'file.jpg' would get an 'image/jpeg' MIME type.
string	$encoding	File encoding (see $Encoding), defaults to 'base64'
string	$type	MIME type - will be used in preference to any automatically derived type
string	$disposition	Disposition to use

Exceptions

Exception

Returns

bool True on successfully adding an attachment

Definition at line 3593 of file PHPMailer.php.

References $name, $type, attachment(), PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\lang(), PHPMailer\PHPMailer\PHPMailer\setError(), and PHPMailer\PHPMailer\PHPMailer\validateEncoding().

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

      {
        try {
            // If a MIME type is not specified, try to work it out from the name
            if ('' === $type && !empty($name)) {
                $type = static::filenameToType($name);
            }

            if (!$this->validateEncoding($encoding)) {
                throw new Exception($this->lang('encoding') . $encoding);
            }

            // Append to $attachment array
            $this->attachment[] = [
                0 => $string,
                1 => $name,
                2 => $name,
                3 => $encoding,
                4 => $type,
                5 => true, // isStringAttachment
                6 => $disposition,
                7 => $cid,
            ];
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

alternativeExists()

PHPMailer\PHPMailer\PHPMailer::alternativeExists

(

)

Check if this message has an alternative body set.

Returns

bool

Definition at line 3712 of file PHPMailer.php.

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

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

Here is the caller graph for this function:

attachAll()

PHPMailer\PHPMailer\PHPMailer::attachAll (   $disposition_type,   $boundary  )

protected

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

Returns an empty string on failure.

Parameters

string	$disposition_type
string	$boundary

Exceptions

Exception

Returns

string

Definition at line 3033 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$attachment, PHPMailer\PHPMailer\PHPMailer\$boundary, $name, $path, $type, attachment(), PHPMailer\PHPMailer\PHPMailer\encodeFile(), PHPMailer\PHPMailer\PHPMailer\encodeHeader(), PHPMailer\PHPMailer\PHPMailer\encodeString(), GuzzleHttp\Psr7\hash(), PHPMailer\PHPMailer\PHPMailer\isError(), and PHPMailer\PHPMailer\PHPMailer\secureHeader().

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        // Return text of body
        $mime = [];
        $cidUniq = [];
        $incl = [];

        // 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 = hash('sha256', serialize($attachment));
                if (in_array($inclhash, $incl, true)) {
                    continue;
                }
                $incl[] = $inclhash;
                $name = $attachment[2];
                $encoding = $attachment[3];
                $type = $attachment[4];
                $disposition = $attachment[6];
                $cid = $attachment[7];
                if ('inline' === $disposition && array_key_exists($cid, $cidUniq)) {
                    continue;
                }
                $cidUniq[$cid] = true;

                $mime[] = sprintf('--%s%s', $boundary, static::$LE);
                //Only include a filename property if we have one
                if (!empty($name)) {
                    $mime[] = sprintf(
                        'Content-Type: %s; name=%s%s',
                        $type,
                        static::quotedString($this->encodeHeader($this->secureHeader($name))),
                        static::$LE
                    );
                } else {
                    $mime[] = sprintf(
                        'Content-Type: %s%s',
                        $type,
                        static::$LE
                    );
                }
                // RFC1341 part 5 says 7bit is assumed if not specified
                if (static::ENCODING_7BIT !== $encoding) {
                    $mime[] = sprintf('Content-Transfer-Encoding: %s%s', $encoding, static::$LE);
                }

                //Only set Content-IDs on inline attachments
                if ((string) $cid !== '' && $disposition === 'inline') {
                    $mime[] = 'Content-ID: <' . $this->encodeHeader($this->secureHeader($cid)) . '>' . static::$LE;
                }

                // Allow for bypassing the Content-Disposition header
                if (!empty($disposition)) {
                    $encoded_name = $this->encodeHeader($this->secureHeader($name));
                    if (!empty($encoded_name)) {
                        $mime[] = sprintf(
                            'Content-Disposition: %s; filename=%s%s',
                            $disposition,
                            static::quotedString($encoded_name),
                            static::$LE . static::$LE
                        );
                    } else {
                        $mime[] = sprintf(
                            'Content-Disposition: %s%s',
                            $disposition,
                            static::$LE . static::$LE
                        );
                    }
                } else {
                    $mime[] = static::$LE;
                }

                // Encode as string attachment
                if ($bString) {
                    $mime[] = $this->encodeString($string, $encoding);
                } else {
                    $mime[] = $this->encodeFile($path, $encoding);
                }
                if ($this->isError()) {
                    return '';
                }
                $mime[] = static::$LE;
            }
        }

        $mime[] = sprintf('--%s--%s', $boundary, static::$LE);

        return implode('', $mime);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

attachmentExists()

PHPMailer\PHPMailer\PHPMailer::attachmentExists

(

)

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

Returns

bool

Definition at line 3696 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$attachment, and attachment().

Referenced by PHPMailer\PHPMailer\PHPMailer\setMessageType().

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

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

base64EncodeWrapMB()

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

See also

http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283

Parameters

string	$str	multi-byte text to wrap encode
string	$linebreak	string to use as linefeed/end-of-line

Returns

string

Definition at line 3347 of file PHPMailer.php.

References $end, $i, and $start.

Referenced by PHPMailer\PHPMailer\PHPMailer\encodeHeader().

    {
        $start = '=?' . $this->CharSet . '?B?';
        $end = '?=';
        $encoded = '';
        if (null === $linebreak) {
            $linebreak = static::$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);

        $offset = 0;
        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
        return substr($encoded, 0, -strlen($linebreak));
    }

Here is the caller graph for this function:

cidExists()

PHPMailer\PHPMailer\PHPMailer::cidExists (   $cid )

protected

Check if an embedded attachment is present with this cid.

Parameters

string

$cid

Returns

bool

Definition at line 3664 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$attachment, and attachment().

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

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

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

clearAddresses()

PHPMailer\PHPMailer\PHPMailer::clearAddresses

(

)

Clear all To recipients.

Definition at line 3735 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$to, and PHPMailer\PHPMailer\PHPMailer\clearQueuedAddresses().

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

Here is the call graph for this function:

clearAllRecipients()

PHPMailer\PHPMailer\PHPMailer::clearAllRecipients

(

)

Clear all recipient types.

Definition at line 3780 of file PHPMailer.php.

    {
        $this->to = [];
        $this->cc = [];
        $this->bcc = [];
        $this->all_recipients = [];
        $this->RecipientsQueue = [];
    }

clearAttachments()

PHPMailer\PHPMailer\PHPMailer::clearAttachments

(

)

Clear all filesystem, string, and binary attachments.

Definition at line 3792 of file PHPMailer.php.

References attachment().

    {
        $this->attachment = [];
    }

Here is the call graph for this function:

clearBCCs()

PHPMailer\PHPMailer\PHPMailer::clearBCCs

(

)

Clear all BCC recipients.

Definition at line 3759 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$bcc, and PHPMailer\PHPMailer\PHPMailer\clearQueuedAddresses().

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

Here is the call graph for this function:

clearCCs()

PHPMailer\PHPMailer\PHPMailer::clearCCs

(

)

Clear all CC recipients.

Definition at line 3747 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$cc, and PHPMailer\PHPMailer\PHPMailer\clearQueuedAddresses().

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

Here is the call graph for this function:

clearCustomHeaders()

PHPMailer\PHPMailer\PHPMailer::clearCustomHeaders

(

)

Clear all custom headers.

Definition at line 3800 of file PHPMailer.php.

    {
        $this->CustomHeader = [];
    }

clearQueuedAddresses()

PHPMailer\PHPMailer\PHPMailer::clearQueuedAddresses

(

$kind

)

Clear queued addresses of given kind.

Parameters

string

$kind

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

Definition at line 3722 of file PHPMailer.php.

References PHPMailer\PHPMailer\$params.

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

    {
        $this->RecipientsQueue = array_filter(
            $this->RecipientsQueue,
            static function ($params) use ($kind) {
                return $params[0] !== $kind;
            }
        );
    }

Here is the caller graph for this function:

clearReplyTos()

PHPMailer\PHPMailer\PHPMailer::clearReplyTos

(

)

Clear all ReplyTo recipients.

Definition at line 3771 of file PHPMailer.php.

    {
        $this->ReplyTo = [];
        $this->ReplyToQueue = [];
    }

createBody()

PHPMailer\PHPMailer\PHPMailer::createBody

(

)

Assemble the message body.

Returns an empty string on failure.

Exceptions

Exception

Returns

string The assembled message body

Definition at line 2573 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        $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() . static::$LE;
        }

        $this->setWordWrap();

        $bodyEncoding = $this->Encoding;
        $bodyCharSet = $this->CharSet;
        //Can we do a 7-bit downgrade?
        if (static::ENCODING_8BIT === $bodyEncoding && !$this->has8bitChars($this->Body)) {
            $bodyEncoding = static::ENCODING_7BIT;
            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
            $bodyCharSet = static::CHARSET_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 (static::ENCODING_BASE64 !== $this->Encoding && static::hasLineLongerThanMax($this->Body)) {
            $bodyEncoding = static::ENCODING_QUOTED_PRINTABLE;
        }

        $altBodyEncoding = $this->Encoding;
        $altBodyCharSet = $this->CharSet;
        //Can we do a 7-bit downgrade?
        if (static::ENCODING_8BIT === $altBodyEncoding && !$this->has8bitChars($this->AltBody)) {
            $altBodyEncoding = static::ENCODING_7BIT;
            //All ISO 8859, Windows codepage and UTF-8 charsets are ascii compatible up to 7-bit
            $altBodyCharSet = static::CHARSET_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 (static::ENCODING_BASE64 !== $altBodyEncoding && static::hasLineLongerThanMax($this->AltBody)) {
            $altBodyEncoding = static::ENCODING_QUOTED_PRINTABLE;
        }
        //Use this as a preamble in all multipart message types
        $mimepre = 'This is a multi-part message in MIME format.' . static::$LE . static::$LE;
        switch ($this->message_type) {
            case 'inline':
                $body .= $mimepre;
                $body .= $this->getBoundary($this->boundary[1], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$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 .= static::$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', static::CONTENT_TYPE_MULTIPART_RELATED . ';');
                $body .= $this->textLine(' boundary="' . $this->boundary[2] . '";');
                $body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"');
                $body .= static::$LE;
                $body .= $this->getBoundary($this->boundary[2], $bodyCharSet, '', $bodyEncoding);
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= static::$LE;
                $body .= $this->attachAll('attachment', $this->boundary[1]);
                break;
            case 'alt':
                $body .= $mimepre;
                $body .= $this->getBoundary(
                    $this->boundary[1],
                    $altBodyCharSet,
                    static::CONTENT_TYPE_PLAINTEXT,
                    $altBodyEncoding
                );
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[1],
                    $bodyCharSet,
                    static::CONTENT_TYPE_TEXT_HTML,
                    $bodyEncoding
                );
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$LE;
                if (!empty($this->Ical)) {
                    $method = static::ICAL_METHOD_REQUEST;
                    foreach (static::$IcalMethods as $imethod) {
                        if (stripos($this->Ical, 'METHOD:' . $imethod) !== false) {
                            $method = $imethod;
                            break;
                        }
                    }
                    $body .= $this->getBoundary(
                        $this->boundary[1],
                        '',
                        static::CONTENT_TYPE_TEXT_CALENDAR . '; method=' . $method,
                        ''
                    );
                    $body .= $this->encodeString($this->Ical, $this->Encoding);
                    $body .= static::$LE;
                }
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_inline':
                $body .= $mimepre;
                $body .= $this->getBoundary(
                    $this->boundary[1],
                    $altBodyCharSet,
                    static::CONTENT_TYPE_PLAINTEXT,
                    $altBodyEncoding
                );
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= static::$LE;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';');
                $body .= $this->textLine(' boundary="' . $this->boundary[2] . '";');
                $body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"');
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[2],
                    $bodyCharSet,
                    static::CONTENT_TYPE_TEXT_HTML,
                    $bodyEncoding
                );
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$LE;
                $body .= $this->attachAll('inline', $this->boundary[2]);
                $body .= static::$LE;
                $body .= $this->endBoundary($this->boundary[1]);
                break;
            case 'alt_attach':
                $body .= $mimepre;
                $body .= $this->textLine('--' . $this->boundary[1]);
                $body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_ALTERNATIVE . ';');
                $body .= $this->textLine(' boundary="' . $this->boundary[2] . '"');
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[2],
                    $altBodyCharSet,
                    static::CONTENT_TYPE_PLAINTEXT,
                    $altBodyEncoding
                );
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[2],
                    $bodyCharSet,
                    static::CONTENT_TYPE_TEXT_HTML,
                    $bodyEncoding
                );
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$LE;
                if (!empty($this->Ical)) {
                    $method = static::ICAL_METHOD_REQUEST;
                    foreach (static::$IcalMethods as $imethod) {
                        if (stripos($this->Ical, 'METHOD:' . $imethod) !== false) {
                            $method = $imethod;
                            break;
                        }
                    }
                    $body .= $this->getBoundary(
                        $this->boundary[2],
                        '',
                        static::CONTENT_TYPE_TEXT_CALENDAR . '; method=' . $method,
                        ''
                    );
                    $body .= $this->encodeString($this->Ical, $this->Encoding);
                }
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= static::$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', static::CONTENT_TYPE_MULTIPART_ALTERNATIVE . ';');
                $body .= $this->textLine(' boundary="' . $this->boundary[2] . '"');
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[2],
                    $altBodyCharSet,
                    static::CONTENT_TYPE_PLAINTEXT,
                    $altBodyEncoding
                );
                $body .= $this->encodeString($this->AltBody, $altBodyEncoding);
                $body .= static::$LE;
                $body .= $this->textLine('--' . $this->boundary[2]);
                $body .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';');
                $body .= $this->textLine(' boundary="' . $this->boundary[3] . '";');
                $body .= $this->textLine(' type="' . static::CONTENT_TYPE_TEXT_HTML . '"');
                $body .= static::$LE;
                $body .= $this->getBoundary(
                    $this->boundary[3],
                    $bodyCharSet,
                    static::CONTENT_TYPE_TEXT_HTML,
                    $bodyEncoding
                );
                $body .= $this->encodeString($this->Body, $bodyEncoding);
                $body .= static::$LE;
                $body .= $this->attachAll('inline', $this->boundary[3]);
                $body .= static::$LE;
                $body .= $this->endBoundary($this->boundary[2]);
                $body .= static::$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 = '';
            if ($this->exceptions) {
                throw new Exception($this->lang('empty_message'), self::STOP_CRITICAL);
            }
        } elseif ($this->sign_key_file) {
            try {
                if (!defined('PKCS7_TEXT')) {
                    throw new Exception($this->lang('extension_missing') . 'openssl');
                }

                $file = tempnam(sys_get_temp_dir(), 'srcsign');
                $signed = tempnam(sys_get_temp_dir(), 'mailsign');
                file_put_contents($file, $body);

                //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),
                        ['file://' . realpath($this->sign_key_file), $this->sign_key_pass],
                        []
                    );
                } else {
                    $sign = @openssl_pkcs7_sign(
                        $file,
                        $signed,
                        'file://' . realpath($this->sign_cert_file),
                        ['file://' . realpath($this->sign_key_file), $this->sign_key_pass],
                        [],
                        PKCS7_DETACHED,
                        $this->sign_extracerts_file
                    );
                }

                @unlink($file);
                if ($sign) {
                    $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] . static::$LE . static::$LE;
                    $body = $parts[1];
                } else {
                    @unlink($signed);
                    throw new Exception($this->lang('signing') . openssl_error_string());
                }
            } catch (Exception $exc) {
                $body = '';
                if ($this->exceptions) {
                    throw $exc;
                }
            }
        }

        return $body;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createHeader()

PHPMailer\PHPMailer\PHPMailer::createHeader

(

)

Assemble message headers.

Returns

string The assembled headers

Definition at line 2381 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        $result = '';

        $result .= $this->headerLine('Date', '' === $this->MessageDate ? self::rfcDate() : $this->MessageDate);

        // To be created automatically by mail()
        if ($this->SingleTo) {
            if ('mail' !== $this->Mailer) {
                foreach ($this->to as $toaddr) {
                    $this->SingleToArray[] = $this->addrFormat($toaddr);
                }
            }
        } elseif (count($this->to) > 0) {
            if ('mail' !== $this->Mailer) {
                $result .= $this->addrAppend('To', $this->to);
            }
        } elseif (count($this->cc) === 0) {
            $result .= $this->headerLine('To', 'undisclosed-recipients:;');
        }

        $result .= $this->addrAppend('From', [[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 ((
                'sendmail' === $this->Mailer || 'qmail' === $this->Mailer || 'mail' === $this->Mailer
            )
            && 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 ('mail' !== $this->Mailer) {
            $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 && 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 (null !== $this->Priority) {
            $result .= $this->headerLine('X-Priority', $this->Priority);
        }
        if ('' === $this->XMailer) {
            $result .= $this->headerLine(
                'X-Mailer',
                'PHPMailer ' . self::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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

DKIM_Add()

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

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

Parameters

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

Exceptions

Exception

Returns

string

Definition at line 4579 of file PHPMailer.php.

References $header, PHPMailer\PHPMailer\PHPMailer\DKIM_BodyC(), PHPMailer\PHPMailer\PHPMailer\DKIM_HeaderC(), PHPMailer\PHPMailer\PHPMailer\DKIM_QP(), PHPMailer\PHPMailer\PHPMailer\DKIM_Sign(), and GuzzleHttp\Psr7\hash().

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        $DKIMsignatureType = 'rsa-sha256'; // Signature & hash algorithms
        $DKIMcanonicalization = 'relaxed/simple'; // Canonicalization methods of header & body
        $DKIMquery = 'dns/txt'; // Query method
        $DKIMtime = time();
        //Always sign these headers without being asked
        //Recommended list from https://tools.ietf.org/html/rfc6376#section-5.4.1
        $autoSignHeaders = [
            'from',
            'to',
            'cc',
            'date',
            'subject',
            'reply-to',
            'message-id',
            'content-type',
            'mime-version',
            'x-mailer',
        ];
        if (stripos($headers_line, 'Subject') === false) {
            $headers_line .= 'Subject: ' . $subject . static::$LE;
        }
        $headerLines = explode(static::$LE, $headers_line);
        $currentHeaderLabel = '';
        $currentHeaderValue = '';
        $parsedHeaders = [];
        $headerLineIndex = 0;
        $headerLineCount = count($headerLines);
        foreach ($headerLines as $headerLine) {
            $matches = [];
            if (preg_match('/^([^ \t]*?)(?::[ \t]*)(.*)$/', $headerLine, $matches)) {
                if ($currentHeaderLabel !== '') {
                    //We were previously in another header; This is the start of a new header, so save the previous one
                    $parsedHeaders[] = ['label' => $currentHeaderLabel, 'value' => $currentHeaderValue];
                }
                $currentHeaderLabel = $matches[1];
                $currentHeaderValue = $matches[2];
            } elseif (preg_match('/^[ \t]+(.*)$/', $headerLine, $matches)) {
                //This is a folded continuation of the current header, so unfold it
                $currentHeaderValue .= ' ' . $matches[1];
            }
            ++$headerLineIndex;
            if ($headerLineIndex >= $headerLineCount) {
                //This was the last line, so finish off this header
                $parsedHeaders[] = ['label' => $currentHeaderLabel, 'value' => $currentHeaderValue];
            }
        }
        $copiedHeaders = [];
        $headersToSignKeys = [];
        $headersToSign = [];
        foreach ($parsedHeaders as $header) {
            //Is this header one that must be included in the DKIM signature?
            if (in_array(strtolower($header['label']), $autoSignHeaders, true)) {
                $headersToSignKeys[] = $header['label'];
                $headersToSign[] = $header['label'] . ': ' . $header['value'];
                if ($this->DKIM_copyHeaderFields) {
                    $copiedHeaders[] = $header['label'] . ':' . //Note no space after this, as per RFC
                        str_replace('|', '=7C', $this->DKIM_QP($header['value']));
                }
                continue;
            }
            //Is this an extra custom header we've been asked to sign?
            if (in_array($header['label'], $this->DKIM_extraHeaders, true)) {
                //Find its value in custom headers
                foreach ($this->CustomHeader as $customHeader) {
                    if ($customHeader[0] === $header['label']) {
                        $headersToSignKeys[] = $header['label'];
                        $headersToSign[] = $header['label'] . ': ' . $header['value'];
                        if ($this->DKIM_copyHeaderFields) {
                            $copiedHeaders[] = $header['label'] . ':' . //Note no space after this, as per RFC
                                str_replace('|', '=7C', $this->DKIM_QP($header['value']));
                        }
                        //Skip straight to the next header
                        continue 2;
                    }
                }
            }
        }
        $copiedHeaderFields = '';
        if ($this->DKIM_copyHeaderFields && count($copiedHeaders) > 0) {
            //Assemble a DKIM 'z' tag
            $copiedHeaderFields = ' z=';
            $first = true;
            foreach ($copiedHeaders as $copiedHeader) {
                if (!$first) {
                    $copiedHeaderFields .= static::$LE . ' |';
                }
                //Fold long values
                if (strlen($copiedHeader) > self::STD_LINE_LENGTH - 3) {
                    $copiedHeaderFields .= substr(
                        chunk_split($copiedHeader, self::STD_LINE_LENGTH - 3, static::$LE . self::FWS),
                        0,
                        -strlen(static::$LE . self::FWS)
                    );
                } else {
                    $copiedHeaderFields .= $copiedHeader;
                }
                $first = false;
            }
            $copiedHeaderFields .= ';' . static::$LE;
        }
        $headerKeys = ' h=' . implode(':', $headersToSignKeys) . ';' . static::$LE;
        $headerValues = implode(static::$LE, $headersToSign);
        $body = $this->DKIM_BodyC($body);
        $DKIMb64 = base64_encode(pack('H*', hash('sha256', $body))); // Base64 of packed binary SHA-256 hash of body
        $ident = '';
        if ('' !== $this->DKIM_identity) {
            $ident = ' i=' . $this->DKIM_identity . ';' . static::$LE;
        }
        //The DKIM-Signature header is included in the signature *except for* the value of the `b` tag
        //which is appended after calculating the signature
        //https://tools.ietf.org/html/rfc6376#section-3.5
        $dkimSignatureHeader = 'DKIM-Signature: v=1;' .
            ' d=' . $this->DKIM_domain . ';' .
            ' s=' . $this->DKIM_selector . ';' . static::$LE .
            ' a=' . $DKIMsignatureType . ';' .
            ' q=' . $DKIMquery . ';' .
            ' t=' . $DKIMtime . ';' .
            ' c=' . $DKIMcanonicalization . ';' . static::$LE .
            $headerKeys .
            $ident .
            $copiedHeaderFields .
            ' bh=' . $DKIMb64 . ';' . static::$LE .
            ' b=';
        //Canonicalize the set of headers
        $canonicalizedHeaders = $this->DKIM_HeaderC(
            $headerValues . static::$LE . $dkimSignatureHeader
        );
        $signature = $this->DKIM_Sign($canonicalizedHeaders);
        $signature = trim(chunk_split($signature, self::STD_LINE_LENGTH - 3, static::$LE . self::FWS));

        return static::normalizeBreaks($dkimSignatureHeader . $signature);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

DKIM_BodyC()

PHPMailer\PHPMailer\PHPMailer::DKIM_BodyC

(

$body

)

Generate a DKIM canonicalization body.

Uses the 'simple' algorithm from RFC6376 section 3.4.3. Canonicalized bodies should always use CRLF, regardless of mailer setting.

See also

https://tools.ietf.org/html/rfc6376#section-3.4.3

Parameters

string

$body

Message Body

Returns

string

Definition at line 4556 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\DKIM_Add().

    {
        if (empty($body)) {
            return self::CRLF;
        }
        // Normalize line endings to CRLF
        $body = static::normalizeBreaks($body, self::CRLF);

        //Reduce multiple trailing line breaks to a single one
        return static::stripTrailingWSP($body) . self::CRLF;
    }

Here is the caller graph for this function:

DKIM_HeaderC()

PHPMailer\PHPMailer\PHPMailer::DKIM_HeaderC

(

$signHeader

)

Generate a DKIM canonicalization header.

Uses the 'relaxed' algorithm from RFC6376 section 3.4.2. Canonicalized headers should always use CRLF, regardless of mailer setting.

See also

https://tools.ietf.org/html/rfc6376#section-3.4.2

Parameters

string

$signHeader

Header

Returns

string

Definition at line 4512 of file PHPMailer.php.

References $key.

Referenced by PHPMailer\PHPMailer\PHPMailer\DKIM_Add().

    {
        //Normalize breaks to CRLF (regardless of the mailer)
        $signHeader = static::normalizeBreaks($signHeader, self::CRLF);
        //Unfold header lines
        //Note PCRE \s is too broad a definition of whitespace; RFC5322 defines it as `[ \t]`
        //@see https://tools.ietf.org/html/rfc5322#section-2.2
        //That means this may break if you do something daft like put vertical tabs in your headers.
        $signHeader = preg_replace('/\r\n[ \t]+/', ' ', $signHeader);
        //Break headers out into an array
        $lines = explode(self::CRLF, $signHeader);
        foreach ($lines as $key => $line) {
            //If the header is missing a :, skip it as it's invalid
            //This is likely to happen because the explode() above will also split
            //on the trailing LE, leaving an empty line
            if (strpos($line, ':') === false) {
                continue;
            }
            list($heading, $value) = explode(':', $line, 2);
            //Lower-case header name
            $heading = strtolower($heading);
            //Collapse white space within the value, also convert WSP to space
            $value = preg_replace('/[ \t]+/', ' ', $value);
            //RFC6376 is slightly unclear here - it says to delete space at the *end* of each value
            //But then says to delete space before and after the colon.
            //Net result is the same as trimming both ends of the value.
            //By elimination, the same applies to the field name
            $lines[$key] = trim($heading, " \t") . ':' . trim($value, " \t");
        }

        return implode(self::CRLF, $lines);
    }

Here is the caller graph for this function:

DKIM_QP()

PHPMailer\PHPMailer\PHPMailer::DKIM_QP

(

$txt

)

Quoted-Printable-encode a DKIM header.

Parameters

string

$txt

Returns

string

Definition at line 4449 of file PHPMailer.php.

References $i, and $txt.

Referenced by PHPMailer\PHPMailer\PHPMailer\DKIM_Add().

    {
        $line = '';
        $len = strlen($txt);
        for ($i = 0; $i < $len; ++$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;
    }

Here is the caller graph for this function:

DKIM_Sign()

PHPMailer\PHPMailer\PHPMailer::DKIM_Sign

(

$signHeader

)

Generate a DKIM signature.

Parameters

string

$signHeader

Exceptions

Exception

Returns

string The DKIM signature value

Definition at line 4474 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\lang().

Referenced by PHPMailer\PHPMailer\PHPMailer\DKIM_Add().

    {
        if (!defined('PKCS7_TEXT')) {
            if ($this->exceptions) {
                throw new Exception($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);
        }
        if (openssl_sign($signHeader, $signature, $privKey, 'sha256WithRSAEncryption')) {
            openssl_pkey_free($privKey);

            return base64_encode($signature);
        }
        openssl_pkey_free($privKey);

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doCallback()

PHPMailer\PHPMailer\PHPMailer::doCallback (   $isSent,   $to,   $cc,   $bcc,   $subject,   $body,   $from,   $extra  )

protected

Perform a callback.

Parameters

bool	$isSent
array	$to
array	$cc
array	$bcc
string	$subject
string	$body
string	$from
array	$extra

Definition at line 4816 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$bcc, PHPMailer\PHPMailer\PHPMailer\$cc, $from, and PHPMailer\PHPMailer\PHPMailer\$to.

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

    {
        if (!empty($this->action_function) && is_callable($this->action_function)) {
            call_user_func($this->action_function, $isSent, $to, $cc, $bcc, $subject, $body, $from, $extra);
        }
    }

Here is the caller graph for this function:

edebug()

PHPMailer\PHPMailer\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 886 of file PHPMailer.php.

References Monolog\Handler\error_log().

Referenced by PHPMailer\PHPMailer\PHPMailer\addAnAddress(), PHPMailer\PHPMailer\PHPMailer\addAttachment(), PHPMailer\PHPMailer\PHPMailer\addEmbeddedImage(), PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress(), PHPMailer\PHPMailer\PHPMailer\addStringAttachment(), PHPMailer\PHPMailer\PHPMailer\addStringEmbeddedImage(), PHPMailer\PHPMailer\PHPMailer\encodeFile(), PHPMailer\PHPMailer\PHPMailer\postSend(), PHPMailer\PHPMailer\PHPMailer\preSend(), PHPMailer\PHPMailer\PHPMailer\setFrom(), and PHPMailer\PHPMailer\PHPMailer\smtpConnect().

    {
        if ($this->SMTPDebug <= 0) {
            return;
        }
        //Is this a PSR-3 logger?
        if ($this->Debugoutput instanceof \Psr\Log\LoggerInterface) {
            $this->Debugoutput->debug($str);

            return;
        }
        //Avoid clash with built-in function names
        if (is_callable($this->Debugoutput) && !in_array($this->Debugoutput, ['error_log', 'html', 'echo'])) {
            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|\r/m', "\n", $str);
                echo gmdate('Y-m-d H:i:s'),
                "\t",
                    //Trim trailing space
                trim(
                    //Indent for readability, except for trailing break
                    str_replace(
                        "\n",
                        "\n                   \t                  ",
                        trim($str)
                    )
                ),
                "\n";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

encodeFile()

PHPMailer\PHPMailer\PHPMailer::encodeFile (   $path,   $encoding = self::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'

Returns

string

Definition at line 3143 of file PHPMailer.php.

References $path, PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\encodeString(), PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

Referenced by PHPMailer\PHPMailer\PHPMailer\attachAll().

    {
        try {
            if (!static::isPermittedPath($path) || !file_exists($path) || !is_readable($path)) {
                throw new Exception($this->lang('file_open') . $path, self::STOP_CONTINUE);
            }
            $file_buffer = file_get_contents($path);
            if (false === $file_buffer) {
                throw new Exception($this->lang('file_open') . $path, self::STOP_CONTINUE);
            }
            $file_buffer = $this->encodeString($file_buffer, $encoding);

            return $file_buffer;
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return '';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

encodeHeader()

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

Encode a header value (not including its label) optimally.

Picks shortest of Q, B, or none. Result includes folding if needed. See RFC822 definitions for phrase, comment and text positions.

Parameters

string	$str	The header value to encode
string	$position	What context the string will be used in

Returns

string

Definition at line 3224 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$CharSet, PHPMailer\PHPMailer\PHPMailer\base64EncodeWrapMB(), PHPMailer\PHPMailer\PHPMailer\encodeQ(), PHPMailer\PHPMailer\PHPMailer\has8bitChars(), PHPMailer\PHPMailer\PHPMailer\hasMultiBytes(), and PHPMailer\PHPMailer\PHPMailer\wrapText().

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

    {
        $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;
                    }

                    return "\"$encoded\"";
                }
                $matchcount = preg_match_all('/[^\040\041\043-\133\135-\176]/', $str, $matches);
                break;
            /* @noinspection PhpMissingBreakStatementInspection */
            case 'comment':
                $matchcount = preg_match_all('/[()"]/', $str, $matches);
            //fallthrough
            case 'text':
            default:
                $matchcount += preg_match_all('/[\000-\010\013\014\016-\037\177-\377]/', $str, $matches);
                break;
        }

        if ($this->has8bitChars($str)) {
            $charset = $this->CharSet;
        } else {
            $charset = static::CHARSET_ASCII;
        }

        // Q/B encoding adds 8 chars and the charset ("` =?<charset>?[QB]?<content>?=`").
        $overhead = 8 + strlen($charset);

        if ('mail' === $this->Mailer) {
            $maxlen = static::MAIL_MAX_LINE_LENGTH - $overhead;
        } else {
            $maxlen = static::MAX_LINE_LENGTH - $overhead;
        }

        // Select the encoding that produces the shortest output and/or prevents corruption.
        if ($matchcount > strlen($str) / 3) {
            // More than 1/3 of the content needs encoding, use B-encode.
            $encoding = 'B';
        } elseif ($matchcount > 0) {
            // Less than 1/3 of the content needs encoding, use Q-encode.
            $encoding = 'Q';
        } elseif (strlen($str) > $maxlen) {
            // No encoding needed, but value exceeds max line length, use Q-encode to prevent corruption.
            $encoding = 'Q';
        } else {
            // No reformatting needed
            $encoding = false;
        }

        switch ($encoding) {
            case 'B':
                if ($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"));
                }
                $encoded = preg_replace('/^(.*)$/m', ' =?' . $charset . "?$encoding?\\1?=", $encoded);
                break;
            case 'Q':
                $encoded = $this->encodeQ($str, $position);
                $encoded = $this->wrapText($encoded, $maxlen, true);
                $encoded = str_replace('=' . static::$LE, "\n", trim($encoded));
                $encoded = preg_replace('/^(.*)$/m', ' =?' . $charset . "?$encoding?\\1?=", $encoded);
                break;
            default:
                return $str;
        }

        return trim(static::normalizeBreaks($encoded));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

encodeQ()

PHPMailer\PHPMailer\PHPMailer::encodeQ	(		$str,
			$position = 'text'
	)

Encode a string using Q encoding.

See also

http://tools.ietf.org/html/rfc2047#section-4.2

Parameters

string	$str	the text to encode
string	$position	Where the text is going to be used, see the RFC for what that means

Returns

string

Definition at line 3403 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\encodeHeader().

    {
        // There should not be any EOL in the string
        $pattern = '';
        $encoded = str_replace(["\r", "\n"], '', $str);
        switch (strtolower($position)) {
            case 'phrase':
                // RFC 2047 section 5.3
                $pattern = '^A-Za-z0-9!*+\/ -';
                break;
            /*
             * RFC 2047 section 5.2.
             * Build $pattern without including delimiters and []
             */
            /* @noinspection PhpMissingBreakStatementInspection */
            case 'comment':
                $pattern = '\(\)"';
            /* Intentional fall through */
            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 = [];
        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], true);
            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 spaces with _ (more readable than =20)
        // RFC 2047 section 4.2(2)
        return str_replace(' ', '_', $encoded);
    }

Here is the caller graph for this function:

encodeQP()

PHPMailer\PHPMailer\PHPMailer::encodeQP

(

$string

)

Encode a string in quoted-printable format.

According to RFC2045 section 6.7.

Parameters

string

$string

The text to encode

Returns

string

Definition at line 3388 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\encodeString().

    {
        return static::normalizeBreaks(quoted_printable_encode($string));
    }

Here is the caller graph for this function:

encodeString()

PHPMailer\PHPMailer\PHPMailer::encodeString	(		$str,
			$encoding = self::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'

Exceptions

Exception

Returns

string

Definition at line 3178 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\encodeQP(), PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

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

    {
        $encoded = '';
        switch (strtolower($encoding)) {
            case static::ENCODING_BASE64:
                $encoded = chunk_split(
                    base64_encode($str),
                    static::STD_LINE_LENGTH,
                    static::$LE
                );
                break;
            case static::ENCODING_7BIT:
            case static::ENCODING_8BIT:
                $encoded = static::normalizeBreaks($str);
                // Make sure it ends with a line break
                if (substr($encoded, -(strlen(static::$LE))) !== static::$LE) {
                    $encoded .= static::$LE;
                }
                break;
            case static::ENCODING_BINARY:
                $encoded = $str;
                break;
            case static::ENCODING_QUOTED_PRINTABLE:
                $encoded = $this->encodeQP($str);
                break;
            default:
                $this->setError($this->lang('encoding') . $encoding);
                if ($this->exceptions) {
                    throw new Exception($this->lang('encoding') . $encoding);
                }
                break;
        }

        return $encoded;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

endBoundary()

PHPMailer\PHPMailer\PHPMailer::endBoundary (   $boundary )

protected

Return the end of a message boundary.

Parameters

string

$boundary

Returns

string

Definition at line 2893 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$boundary.

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        return static::$LE . '--' . $boundary . '--' . static::$LE;
    }

Here is the caller graph for this function:

filenameToType()

static PHPMailer\PHPMailer\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 4271 of file PHPMailer.php.

References $filename.

    {
        // 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);
        }
        $ext = static::mb_pathinfo($filename, PATHINFO_EXTENSION);

        return static::_mime_types($ext);
    }

generateId()

PHPMailer\PHPMailer\PHPMailer::generateId ( )

protected

Create a unique ID to use for boundaries.

Returns

string

CryptographicallySecureRandomnessInspection

Definition at line 2541 of file PHPMailer.php.

References GuzzleHttp\Psr7\hash().

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        $len = 32; //32 bytes = 256 bits
        $bytes = '';
        if (function_exists('random_bytes')) {
            try {
                $bytes = random_bytes($len);
            } catch (\Exception $e) {
                //Do nothing
            }
        } elseif (function_exists('openssl_random_pseudo_bytes')) {
            $bytes = openssl_random_pseudo_bytes($len);
        }
        if ($bytes === '') {
            //We failed to produce a proper random string, so make do.
            //Use a hash to force the length to the same as the other methods
            $bytes = hash('sha256', uniqid((string) mt_rand(), true), true);
        }

        //We don't care about messing up base64 format here, just want a random string
        return str_replace(['=', '+', '/'], '', base64_encode(hash('sha256', $bytes, true)));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllRecipientAddresses()

PHPMailer\PHPMailer\PHPMailer::getAllRecipientAddresses

(

)

Allows for public read access to 'all_recipients' property.

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

Returns

array

Definition at line 4799 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$all_recipients.

    {
        return $this->all_recipients;
    }

getAttachments()

PHPMailer\PHPMailer\PHPMailer::getAttachments

(

)

Return the array of attachments.

Returns

array

Definition at line 3017 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$attachment.

    {
        return $this->attachment;
    }

getBccAddresses()

PHPMailer\PHPMailer\PHPMailer::getBccAddresses

(

)

Allows for public read access to 'bcc' property.

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

Returns

array

Definition at line 4777 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$bcc.

    {
        return $this->bcc;
    }

getBoundary()

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

protected

Return the start of a message boundary.

Parameters

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

Returns

string

Definition at line 2862 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$boundary, PHPMailer\PHPMailer\PHPMailer\$CharSet, PHPMailer\PHPMailer\PHPMailer\$ContentType, $contentType, PHPMailer\PHPMailer\PHPMailer\$Encoding, $result, PHPMailer\PHPMailer\PHPMailer\headerLine(), and PHPMailer\PHPMailer\PHPMailer\textLine().

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        $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 .= static::$LE;
        // RFC1341 part 5 says 7bit is assumed if not specified
        if (static::ENCODING_7BIT !== $encoding) {
            $result .= $this->headerLine('Content-Transfer-Encoding', $encoding);
        }
        $result .= static::$LE;

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCcAddresses()

PHPMailer\PHPMailer\PHPMailer::getCcAddresses

(

)

Allows for public read access to 'cc' property.

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

Returns

array

Definition at line 4766 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$cc.

    {
        return $this->cc;
    }

getCustomHeaders()

PHPMailer\PHPMailer\PHPMailer::getCustomHeaders

(

)

Returns all custom headers.

Returns

array

Definition at line 3980 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$CustomHeader.

    {
        return $this->CustomHeader;
    }

getLastMessageID()

PHPMailer\PHPMailer\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 1281 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$lastMessageID.

    {
        return $this->lastMessageID;
    }

getLE()

static PHPMailer\PHPMailer\PHPMailer::getLE ( )

static

Return the current line break format string.

Returns

string

Definition at line 4411 of file PHPMailer.php.

    {
        return static::$LE;
    }

getMailMIME()

PHPMailer\PHPMailer\PHPMailer::getMailMIME

(

)

Get the message MIME type headers.

Returns

string

Definition at line 2474 of file PHPMailer.php.

References $result, PHPMailer\PHPMailer\PHPMailer\headerLine(), and PHPMailer\PHPMailer\PHPMailer\textLine().

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody(), and PHPMailer\PHPMailer\PHPMailer\createHeader().

    {
        $result = '';
        $ismultipart = true;
        switch ($this->message_type) {
            case 'inline':
                $result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_RELATED . ';');
                $result .= $this->textLine(' boundary="' . $this->boundary[1] . '"');
                break;
            case 'attach':
            case 'inline_attach':
            case 'alt_attach':
            case 'alt_inline_attach':
                $result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_MIXED . ';');
                $result .= $this->textLine(' boundary="' . $this->boundary[1] . '"');
                break;
            case 'alt':
            case 'alt_inline':
                $result .= $this->headerLine('Content-Type', static::CONTENT_TYPE_MULTIPART_ALTERNATIVE . ';');
                $result .= $this->textLine(' boundary="' . $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 (static::ENCODING_7BIT !== $this->Encoding) {
            // RFC 2045 section 6.4 says multipart MIME parts may only use 7bit, 8bit or binary CTE
            if ($ismultipart) {
                if (static::ENCODING_8BIT === $this->Encoding) {
                    $result .= $this->headerLine('Content-Transfer-Encoding', static::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 ('mail' !== $this->Mailer) {
//            $result .= static::$LE;
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOAuth()

PHPMailer\PHPMailer\PHPMailer::getOAuth

(

)

Get the OAuth instance.

Returns

OAuth

Definition at line 4828 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$oauth.

    {
        return $this->oauth;
    }

getReplyToAddresses()

PHPMailer\PHPMailer\PHPMailer::getReplyToAddresses

(

)

Allows for public read access to 'ReplyTo' property.

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

Returns

array

Definition at line 4788 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$ReplyTo.

    {
        return $this->ReplyTo;
    }

getSentMIMEMessage()

PHPMailer\PHPMailer\PHPMailer::getSentMIMEMessage

(

)

Returns the whole MIME message.

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

See also

PHPMailer::preSend()

Returns

string

Definition at line 2530 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$MIMEBody.

    {
        return static::stripTrailingWSP($this->MIMEHeader . $this->mailHeader) .
            static::$LE . static::$LE . $this->MIMEBody;
    }

getSMTPInstance()

PHPMailer\PHPMailer\PHPMailer::getSMTPInstance

(

)

Get an instance to use for SMTP operations.

Override this function to load your own SMTP implementation, or set one with setSMTPInstance.

Returns

SMTP

Definition at line 1821 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$smtp.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpConnect().

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

        return $this->smtp;
    }

Here is the caller graph for this function:

getToAddresses()

PHPMailer\PHPMailer\PHPMailer::getToAddresses

(

)

Allows for public read access to 'to' property.

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

Returns

array

Definition at line 4755 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$to.

    {
        return $this->to;
    }

getTranslations()

PHPMailer\PHPMailer\PHPMailer::getTranslations

(

)

Get the array of strings for the current language.

Returns

array

Definition at line 2157 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$language.

    {
        return $this->language;
    }

has8bitChars()

PHPMailer\PHPMailer\PHPMailer::has8bitChars

(

$text

)

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

Parameters

string

$text

Returns

bool

Definition at line 3330 of file PHPMailer.php.

References $text.

Referenced by PHPMailer\PHPMailer\PHPMailer\addOrEnqueueAnAddress(), PHPMailer\PHPMailer\PHPMailer\createBody(), PHPMailer\PHPMailer\PHPMailer\encodeHeader(), PHPMailer\PHPMailer\PHPMailer\punyencodeAddress(), and PHPMailer\PHPMailer\PHPMailer\setFrom().

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

Here is the caller graph for this function:

hasLineLongerThanMax()

static PHPMailer\PHPMailer\PHPMailer::hasLineLongerThanMax (   $str )

static

Detect if a string contains a line longer than the maximum line length allowed by RFC 2822 section 2.1.1.

Parameters

string

$str

Returns

bool

Definition at line 4722 of file PHPMailer.php.

    {
        return (bool) preg_match('/^(.{' . (self::MAX_LINE_LENGTH + strlen(static::$LE)) . ',})/m', $str);
    }

hasMultiBytes()

PHPMailer\PHPMailer\PHPMailer::hasMultiBytes

(

$str

)

Check if a string contains multi-byte characters.

Parameters

string

$str

multi-byte text to wrap encode

Returns

bool

Definition at line 3313 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\encodeHeader().

    {
        if (function_exists('mb_strlen')) {
            return strlen($str) > mb_strlen($str, $this->CharSet);
        }

        // Assume no multibytes (we can't handle without mbstring functions anyway)
        return false;
    }

Here is the caller graph for this function:

headerLine()

PHPMailer\PHPMailer\PHPMailer::headerLine	(		$name,
			$value
	)

Format a header line.

Parameters

string	$name
string | int	$value

Returns

string

Definition at line 2929 of file PHPMailer.php.

References $name.

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

    {
        return $name . ': ' . $value . static::$LE;
    }

Here is the caller graph for this function:

html2text()

PHPMailer\PHPMailer\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 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
bool | callable	$advanced	Any boolean value to use the internal converter, or provide your own callable for custom conversion

Returns

string

Definition at line 4120 of file PHPMailer.php.

References $html.

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

    {
        if (is_callable($advanced)) {
            return $advanced($html);
        }

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

Here is the caller graph for this function:

idnSupported()

static PHPMailer\PHPMailer\PHPMailer::idnSupported ( )

static

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 1376 of file PHPMailer.php.

    {
        return function_exists('idn_to_ascii') && function_exists('mb_convert_encoding');
    }

inlineImageExists()

PHPMailer\PHPMailer\PHPMailer::inlineImageExists

(

)

Check if an inline attachment is present.

Returns

bool

Definition at line 3680 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$attachment, and attachment().

Referenced by PHPMailer\PHPMailer\PHPMailer\setMessageType().

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

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isError()

PHPMailer\PHPMailer\PHPMailer::isError

(

)

Check if an error occurred.

Returns

bool True if an error did occur

Definition at line 3939 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\attachAll(), and PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        return $this->error_count > 0;
    }

Here is the caller graph for this function:

isHTML()

PHPMailer\PHPMailer\PHPMailer::isHTML

(

$isHtml = true

)

Sets message type to HTML or plain.

Parameters

bool

$isHtml

True for HTML mode

Definition at line 940 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

    {
        if ($isHtml) {
            $this->ContentType = static::CONTENT_TYPE_TEXT_HTML;
        } else {
            $this->ContentType = static::CONTENT_TYPE_PLAINTEXT;
        }
    }

Here is the caller graph for this function:

isMail()

PHPMailer\PHPMailer\PHPMailer::isMail

(

)

Send messages using PHP's mail() function.

Definition at line 960 of file PHPMailer.php.

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

isPermittedPath()

static PHPMailer\PHPMailer\PHPMailer::isPermittedPath (   $path )

staticprotected

Check whether a file path is of a permitted type.

Used to reject URLs and phar files from functions that access local file paths, such as addAttachment.

Parameters

string

$path

A relative or absolute path to a file

Returns

bool

Definition at line 1751 of file PHPMailer.php.

References $path.

    {
        return !preg_match('#^[a-z]+://#i', $path);
    }

isQmail()

PHPMailer\PHPMailer\PHPMailer::isQmail

(

)

Send messages using qmail.

Definition at line 983 of file PHPMailer.php.

    {
        $ini_sendmail_path = ini_get('sendmail_path');

        if (false === stripos($ini_sendmail_path, 'qmail')) {
            $this->Sendmail = '/var/qmail/bin/qmail-inject';
        } else {
            $this->Sendmail = $ini_sendmail_path;
        }
        $this->Mailer = 'qmail';
    }

isSendmail()

PHPMailer\PHPMailer\PHPMailer::isSendmail

(

)

Send messages using $Sendmail.

Definition at line 968 of file PHPMailer.php.

    {
        $ini_sendmail_path = ini_get('sendmail_path');

        if (false === stripos($ini_sendmail_path, 'sendmail')) {
            $this->Sendmail = '/usr/sbin/sendmail';
        } else {
            $this->Sendmail = $ini_sendmail_path;
        }
        $this->Mailer = 'sendmail';
    }

isShellSafe()

static PHPMailer\PHPMailer\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.

See also

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

Parameters

string

$string

The string to be validated

Returns

bool

Definition at line 1717 of file PHPMailer.php.

References $c, and $i.

    {
        // Future-proof
        if (escapeshellcmd($string) !== $string
            || !in_array(escapeshellarg($string), ["'$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\PHPMailer\PHPMailer::isSMTP

(

)

Send messages using SMTP.

Definition at line 952 of file PHPMailer.php.

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

isValidHost()

static PHPMailer\PHPMailer\PHPMailer::isValidHost (   $host )

static

Validate whether a string contains a valid value to use as a hostname or IP address.

IPv6 addresses must include [], e.g. [::1], not just ::1.

Parameters

string

$host

The host name or IP address to check

Returns

bool

Definition at line 3878 of file PHPMailer.php.

    {
        //Simple syntax limits
        if (empty($host)
            || !is_string($host)
            || strlen($host) > 256
            || !preg_match('/^([a-zA-Z\d.-]*|\[[a-fA-F\d:]+])$/', $host)
        ) {
            return false;
        }
        //Looks like a bracketed IPv6 address
        if (strlen($host) > 2 && substr($host, 0, 1) === '[' && substr($host, -1, 1) === ']') {
            return filter_var(substr($host, 1, -1), FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false;
        }
        //If removing all the dots results in a numeric string, it must be an IPv4 address.
        //Need to check this first because otherwise things like `999.0.0.0` are considered valid host names
        if (is_numeric(str_replace('.', '', $host))) {
            //Is it a valid IPv4 address?
            return filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false;
        }
        if (filter_var('http://' . $host, FILTER_VALIDATE_URL) !== false) {
            //Is it a syntactically valid hostname?
            return true;
        }

        return false;
    }

lang()

PHPMailer\PHPMailer\PHPMailer::lang (   $key )

protected

Get an error message in the current language.

Parameters

string

$key

Returns

string

Definition at line 3913 of file PHPMailer.php.

References $key, and PHPMailer\PHPMailer\PHPMailer\setLanguage().

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

    {
        if (count($this->language) < 1) {
            $this->setLanguage(); // set the default language
        }

        if (array_key_exists($key, $this->language)) {
            if ('smtp_connect_failed' === $key) {
                //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];
        }

        //Return the key as a fallback
        return $key;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mailPassthru()

PHPMailer\PHPMailer\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 | null	$params	Params

Returns

bool

Definition at line 853 of file PHPMailer.php.

References $header, PHPMailer\PHPMailer\$params, $result, PHPMailer\PHPMailer\PHPMailer\$to, PHPMailer\PHPMailer\PHPMailer\encodeHeader(), Monolog\Handler\mail(), and PHPMailer\PHPMailer\PHPMailer\secureHeader().

Referenced by PHPMailer\PHPMailer\PHPMailer\mailSend().

    {
        //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
        //Calling mail() with null params breaks
        if (!$this->UseSendmailOptions || null === $params) {
            $result = @mail($to, $subject, $body, $header);
        } else {
            $result = @mail($to, $subject, $body, $header, $params);
        }

        return $result;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mailSend()

PHPMailer\PHPMailer\PHPMailer::mailSend (   $header,   $body  )

protected

Send mail using the PHP mail() function.

See also

http://www.php.net/manual/en/book.mail.php

Parameters

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

Exceptions

Exception

Returns

bool

Definition at line 1768 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\postSend().

    {
        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;

        $toArr = [];
        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
        //A space after `-f` is optional, but there is a long history of its presence
        //causing problems, so we don't use one
        //Exim docs: http://www.exim.org/exim-html-current/doc/html/spec_html/ch-the_exim_command_line.html
        //Sendmail docs: http://www.sendmail.org/~ca/email/man/sendmail.html
        //Qmail docs: http://www.qmail.org/man/man8/qmail-inject.html
        //Example problem: https://www.drupal.org/node/1057954
        // CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.
        if (!empty($this->Sender) && static::validateAddress($this->Sender) && self::isShellSafe($this->Sender)) {
            $params = sprintf('-f%s', $this->Sender);
        }
        if (!empty($this->Sender) && static::validateAddress($this->Sender)) {
            $old_from = ini_get('sendmail_from');
            ini_set('sendmail_from', $this->Sender);
        }
        $result = false;
        if ($this->SingleTo && count($toArr) > 1) {
            foreach ($toArr as $toAddr) {
                $result = $this->mailPassthru($toAddr, $this->Subject, $body, $header, $params);
                $this->doCallback($result, [$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 Exception($this->lang('instantiate'), self::STOP_CRITICAL);
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

mb_pathinfo()

static PHPMailer\PHPMailer\PHPMailer::mb_pathinfo (   $path,   $options = null  )

static

Multi-byte-safe pathinfo replacement.

Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.

See also

http://www.php.net/manual/en/function.pathinfo.php#107461

Parameters

string	$path	A filename or path, does not need to exist as a file
int | string	$options	Either a PATHINFO_* constant, or a string name to return only the specified piece

Returns

string|array

Definition at line 4295 of file PHPMailer.php.

References PHPMailer\PHPMailer\$options, $path, and $ret.

    {
        $ret = ['dirname' => '', 'basename' => '', 'extension' => '', 'filename' => ''];
        $pathinfo = [];
        if (preg_match('#^(.*?)[\\\\/]*(([^/\\\\]*?)(\.([^.\\\\/]+?)|))[\\\\/.]*$#m', $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;
        }
    }

msgHTML()

PHPMailer\PHPMailer\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) Converts data-uri images into embedded attachments. If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.

Parameters

string	$message	HTML message string
string	$basedir	Absolute path to a base directory to prepend to relative paths to images
bool | callable	$advanced	Whether to use the internal HTML to text converter or your own custom converter

Returns

string $message The transformed message Body

Exceptions

Exception

See also

PHPMailer::html2text()

Definition at line 4005 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$Body, $data, $filename, $message, $url, PHPMailer\PHPMailer\PHPMailer\addEmbeddedImage(), PHPMailer\PHPMailer\PHPMailer\addStringEmbeddedImage(), PHPMailer\PHPMailer\PHPMailer\alternativeExists(), PHPMailer\PHPMailer\PHPMailer\cidExists(), GuzzleHttp\Psr7\hash(), PHPMailer\PHPMailer\PHPMailer\html2text(), and PHPMailer\PHPMailer\PHPMailer\isHTML().

    {
        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
                //e.g. "data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="
                $match = [];
                if (preg_match('#^data:(image/(?:jpe?g|gif|png));?(base64)?,(.+)#', $url, $match)) {
                    if (count($match) === 4 && static::ENCODING_BASE64 === $match[2]) {
                        $data = base64_decode($match[3]);
                    } elseif ('' === $match[2]) {
                        $data = rawurldecode($match[3]);
                    } else {
                        //Not recognised so leave it alone
                        continue;
                    }
                    //Hash the decoded data, not the URL, so that the same data-URI image used in multiple places
                    //will only be embedded once, even if it used a different encoding
                    $cid = substr(hash('sha256', $data), 0, 32) . '@phpmailer.0'; // RFC2392 S 2

                    if (!$this->cidExists($cid)) {
                        $this->addStringEmbeddedImage(
                            $data,
                            $cid,
                            'embed' . $imgindex,
                            static::ENCODING_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
                    && 0 !== strpos($url, 'cid:')
                    // Do not change absolute URLs, including anonymous protocol
                    && !preg_match('#^[a-z][a-z0-9+.-]*:?//#i', $url)
                ) {
                    $filename = static::mb_pathinfo($url, PATHINFO_BASENAME);
                    $directory = dirname($url);
                    if ('.' === $directory) {
                        $directory = '';
                    }
                    // RFC2392 S 2
                    $cid = substr(hash('sha256', $url), 0, 32) . '@phpmailer.0';
                    if (strlen($basedir) > 1 && '/' !== substr($basedir, -1)) {
                        $basedir .= '/';
                    }
                    if (strlen($directory) > 1 && '/' !== substr($directory, -1)) {
                        $directory .= '/';
                    }
                    if ($this->addEmbeddedImage(
                        $basedir . $directory . $filename,
                        $cid,
                        $filename,
                        static::ENCODING_BASE64,
                        static::_mime_types((string) static::mb_pathinfo($filename, PATHINFO_EXTENSION))
                    )
                    ) {
                        $message = preg_replace(
                            '/' . $images[1][$imgindex] . '=["\']' . preg_quote($url, '/') . '["\']/Ui',
                            $images[1][$imgindex] . '="cid:' . $cid . '"',
                            $message
                        );
                    }
                }
            }
        }
        $this->isHTML();
        // Convert all message body line breaks to LE, makes quoted-printable encoding work much better
        $this->Body = static::normalizeBreaks($message);
        $this->AltBody = static::normalizeBreaks($this->html2text($message, $advanced));
        if (!$this->alternativeExists()) {
            $this->AltBody = 'This is an HTML-only message. To view it, activate HTML in your email application.'
                . static::$LE;
        }

        return $this->Body;
    }

Here is the call graph for this function:

normalizeBreaks()

static PHPMailer\PHPMailer\PHPMailer::normalizeBreaks (   $text,   $breaktype = null  )

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 static::$LE

Returns

string

Definition at line 4379 of file PHPMailer.php.

References $text.

    {
        if (null === $breaktype) {
            $breaktype = static::$LE;
        }
        // Normalise to \n
        $text = str_replace([self::CRLF, "\r"], "\n", $text);
        // Now convert LE as needed
        if ("\n" !== $breaktype) {
            $text = str_replace("\n", $breaktype, $text);
        }

        return $text;
    }

parseAddresses()

static PHPMailer\PHPMailer\PHPMailer::parseAddresses (   $addrstr,   $useimap = true  )

static

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.

See also

http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation

Parameters

string	$addrstr	The address list string
bool	$useimap	Whether to use the IMAP extension to parse the list

Returns

array

Definition at line 1184 of file PHPMailer.php.

References $email, $list, and $name.

    {
        $addresses = [];
        if ($useimap && 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 (('.SYNTAX-ERROR.' !== $address->host) && static::validateAddress(
                    $address->mailbox . '@' . $address->host
                )) {
                    $addresses[] = [
                        '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 (static::validateAddress($address)) {
                        $addresses[] = [
                            'name' => '',
                            'address' => $address,
                        ];
                    }
                } else {
                    list($name, $email) = explode('<', $address);
                    $email = trim(str_replace('>', '', $email));
                    if (static::validateAddress($email)) {
                        $addresses[] = [
                            'name' => trim(str_replace(['"', "'"], '', $name)),
                            'address' => $email,
                        ];
                    }
                }
            }
        }

        return $addresses;
    }

postSend()

PHPMailer\PHPMailer\PHPMailer::postSend

(

)

Actually send a message via the selected mechanism.

Exceptions

Exception

Returns

bool

Definition at line 1595 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\send().

    {
        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 (Exception $exc) {
            $this->setError($exc->getMessage());
            $this->edebug($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

preSend()

PHPMailer\PHPMailer\PHPMailer::preSend

(

)

Prepare a message for sending.

Exceptions

Exception

Returns

bool

Definition at line 1459 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\send().

    {
        if ('smtp' === $this->Mailer
            || ('mail' === $this->Mailer && stripos(PHP_OS, 'WIN') === 0)
        ) {
            //SMTP mandates RFC-compliant line endings
            //and it's also used with mail() on Windows
            static::setLE(self::CRLF);
        } else {
            //Maintain backward compatibility with legacy Linux command line mailers
            static::setLE(PHP_EOL);
        }
        //Check for buggy PHP versions that add a header with an incorrect line break
        if ('mail' === $this->Mailer
            && ((PHP_VERSION_ID >= 70000 && PHP_VERSION_ID < 70017)
                || (PHP_VERSION_ID >= 70100 && PHP_VERSION_ID < 70103))
            && ini_get('mail.add_x_header') === '1'
            && stripos(PHP_OS, 'WIN') === 0
        ) {
            trigger_error(
                'Your version of PHP is affected by a bug that may result in corrupted messages.' .
                ' To fix it, switch to sending using SMTP, disable the mail.add_x_header option in' .
                ' your php.ini, switch to MacOS or Linux, or upgrade your PHP to version 7.0.17+ or 7.1.3+.',
                E_USER_WARNING
            );
        }

        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([$this, 'addAnAddress'], $params);
            }
            if (count($this->to) + count($this->cc) + count($this->bcc) < 1) {
                throw new Exception($this->lang('provide_address'), self::STOP_CRITICAL);
            }

            // Validate From, Sender, and ConfirmReadingTo addresses
            foreach (['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 (!static::validateAddress($this->$address_kind)) {
                    $error_message = sprintf(
                        '%s (%s): %s',
                        $this->lang('invalid_address'),
                        $address_kind,
                        $this->$address_kind
                    );
                    $this->setError($error_message);
                    $this->edebug($error_message);
                    if ($this->exceptions) {
                        throw new Exception($error_message);
                    }

                    return false;
                }
            }

            // Set whether the message is multipart/alternative
            if ($this->alternativeExists()) {
                $this->ContentType = static::CONTENT_TYPE_MULTIPART_ALTERNATIVE;
            }

            $this->setMessageType();
            // Refuse to send an empty message unless we are specifically allowing it
            if (!$this->AllowEmpty && empty($this->Body)) {
                throw new Exception($this->lang('empty_message'), self::STOP_CRITICAL);
            }

            //Trim subject consistently
            $this->Subject = trim($this->Subject);
            // 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 ('mail' === $this->Mailer) {
                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($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)
                        && static::isPermittedPath($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 = static::stripTrailingWSP($this->MIMEHeader) . static::$LE .
                    static::normalizeBreaks($header_dkim) . static::$LE;
            }

            return true;
        } catch (Exception $exc) {
            $this->setError($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

punyencodeAddress()

PHPMailer\PHPMailer\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 contains 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 1395 of file PHPMailer.php.

References $domain, and PHPMailer\PHPMailer\PHPMailer\has8bitChars().

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        // Verify we have required functions, CharSet, and at-sign.
        $pos = strrpos($address, '@');
        if (!empty($this->CharSet) &&
            false !== $pos &&
            static::idnSupported()
        ) {
            $domain = substr($address, ++$pos);
            // Verify CharSet string is a valid one, and domain properly encoded in this CharSet.
            if ($this->has8bitChars($domain) && @mb_check_encoding($domain, $this->CharSet)) {
                $domain = mb_convert_encoding($domain, 'UTF-8', $this->CharSet);
                //Ignore IDE complaints about this line - method signature changed in PHP 5.4
                $errorcode = 0;
                if (defined('INTL_IDNA_VARIANT_UTS46')) {
                    $punycode = idn_to_ascii($domain, $errorcode, INTL_IDNA_VARIANT_UTS46);
                } elseif (defined('INTL_IDNA_VARIANT_2003')) {
                    $punycode = idn_to_ascii($domain, $errorcode, INTL_IDNA_VARIANT_2003);
                } else {
                    $punycode = idn_to_ascii($domain, $errorcode);
                }
                if (false !== $punycode) {
                    return substr($address, 0, $pos) . $punycode;
                }
            }
        }

        return $address;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

quotedString()

static PHPMailer\PHPMailer\PHPMailer::quotedString (   $str )

static

If a string contains any "special" characters, double-quote the name, and escape any double quotes with a backslash.

Parameters

string

$str

Returns

string

See also

RFC822 3.4.1

Definition at line 4737 of file PHPMailer.php.

    {
        if (preg_match('/[ ()<>@,;:"\/\[\]?=]/', $str)) {
            //If the string contains any of these chars, it must be double-quoted
            //and any double quotes must be escaped with a backslash
            return '"' . str_replace('"', '\\"', $str) . '"';
        }

        //Return the string untouched, it doesn't need quoting
        return $str;
    }

rfcDate()

static PHPMailer\PHPMailer\PHPMailer::rfcDate ( )

static

Return an RFC 822 formatted date.

Returns

string

Definition at line 3836 of file 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');
    }

secureHeader()

PHPMailer\PHPMailer\PHPMailer::secureHeader

(

$str

)

Strip newlines to prevent header injection.

Parameters

string

$str

Returns

string

Definition at line 4364 of file PHPMailer.php.

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

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

Here is the caller graph for this function:

send()

PHPMailer\PHPMailer\PHPMailer::send

(

)

Create a message and send it.

Uses the sending method specified by $Mailer.

Exceptions

Exception

Returns

bool false on error - See the ErrorInfo property for details of the error

Definition at line 1433 of file PHPMailer.php.

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

    {
        try {
            if (!$this->preSend()) {
                return false;
            }

            return $this->postSend();
        } catch (Exception $exc) {
            $this->mailHeader = '';
            $this->setError($exc->getMessage());
            if ($this->exceptions) {
                throw $exc;
            }

            return false;
        }
    }

Here is the call graph for this function:

sendmailSend()

PHPMailer\PHPMailer\PHPMailer::sendmailSend (   $header,   $body  )

protected

Send mail using the $Sendmail program.

See also

PHPMailer::$Sendmail

Parameters

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

Exceptions

Exception

Returns

bool

Definition at line 1638 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\postSend().

    {
        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;

        // CVE-2016-10033, CVE-2016-10045: Don't pass -f if characters will be escaped.
        if (!empty($this->Sender) && self::isShellSafe($this->Sender)) {
            if ('qmail' === $this->Mailer) {
                $sendmailFmt = '%s -f%s';
            } else {
                $sendmailFmt = '%s -oi -f%s -t';
            }
        } elseif ('qmail' === $this->Mailer) {
            $sendmailFmt = '%s';
        } else {
            $sendmailFmt = '%s -oi -t';
        }

        $sendmail = sprintf($sendmailFmt, escapeshellcmd($this->Sendmail), $this->Sender);

        if ($this->SingleTo) {
            foreach ($this->SingleToArray as $toAddr) {
                $mail = @popen($sendmail, 'w');
                if (!$mail) {
                    throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
                fwrite($mail, 'To: ' . $toAddr . "\n");
                fwrite($mail, $header);
                fwrite($mail, $body);
                $result = pclose($mail);
                $this->doCallback(
                    ($result === 0),
                    [$toAddr],
                    $this->cc,
                    $this->bcc,
                    $this->Subject,
                    $body,
                    $this->From,
                    []
                );
                if (0 !== $result) {
                    throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
                }
            }
        } else {
            $mail = @popen($sendmail, 'w');
            if (!$mail) {
                throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
            fwrite($mail, $header);
            fwrite($mail, $body);
            $result = pclose($mail);
            $this->doCallback(
                ($result === 0),
                $this->to,
                $this->cc,
                $this->bcc,
                $this->Subject,
                $body,
                $this->From,
                []
            );
            if (0 !== $result) {
                throw new Exception($this->lang('execute') . $this->Sendmail, self::STOP_CRITICAL);
            }
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

serverHostname()

PHPMailer\PHPMailer\PHPMailer::serverHostname ( )

protected

Get the server hostname.

Returns 'localhost.localdomain' if unknown.

Returns

string

Definition at line 3851 of file PHPMailer.php.

References $_SERVER, PHPMailer\PHPMailer\PHPMailer\$Hostname, and $result.

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

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

        return $result;
    }

Here is the caller graph for this function:

set()

PHPMailer\PHPMailer\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', static::ENCRYPTION_STARTTLS);` is the same as: $mail->SMTPSecure = static::ENCRYPTION_STARTTLS;.

Parameters

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

Returns

bool

Definition at line 4345 of file PHPMailer.php.

References $name, PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

    {
        if (property_exists($this, $name)) {
            $this->$name = $value;

            return true;
        }
        $this->setError($this->lang('variable_set') . $name);

        return false;
    }

Here is the call graph for this function:

setError()

PHPMailer\PHPMailer\PHPMailer::setError (   $msg )

protected

Add an error message to the error container.

Parameters

string

$msg

Definition at line 3810 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$error_count, and PHPMailer\PHPMailer\PHPMailer\lang().

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

    {
        ++$this->error_count;
        if ('smtp' === $this->Mailer && 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFrom()

PHPMailer\PHPMailer\PHPMailer::setFrom	(		$address,
			$name = '',
			$auto = true
	)

Set the From and FromName properties.

Parameters

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

Exceptions

Exception

Returns

bool

Definition at line 1241 of file PHPMailer.php.

References $name, PHPMailer\PHPMailer\PHPMailer\edebug(), PHPMailer\PHPMailer\PHPMailer\has8bitChars(), PHPMailer\PHPMailer\PHPMailer\lang(), and PHPMailer\PHPMailer\PHPMailer\setError().

    {
        $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().
        $pos = strrpos($address, '@');
        if ((false === $pos)
            || ((!$this->has8bitChars(substr($address, ++$pos)) || !static::idnSupported())
            && !static::validateAddress($address))
        ) {
            $error_message = sprintf(
                '%s (From): %s',
                $this->lang('invalid_address'),
                $address
            );
            $this->setError($error_message);
            $this->edebug($error_message);
            if ($this->exceptions) {
                throw new Exception($error_message);
            }

            return false;
        }
        $this->From = $address;
        $this->FromName = $name;
        if ($auto && empty($this->Sender)) {
            $this->Sender = $address;
        }

        return true;
    }

Here is the call graph for this function:

setLanguage()

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

bool

Definition at line 2084 of file PHPMailer.php.

References $PHPMAILER_LANG.

Referenced by PHPMailer\PHPMailer\PHPMailer\lang().

    {
        // Backwards compatibility for renamed language codes
        $renamed_langcodes = [
            'br' => 'pt_br',
            'cz' => 'cs',
            'dk' => 'da',
            'no' => 'nb',
            'se' => 'sv',
            'rs' => 'sr',
            'tg' => 'tl',
            'am' => 'hy',
        ];

        if (isset($renamed_langcodes[$langcode])) {
            $langcode = $renamed_langcodes[$langcode];
        }

        // Define full set of translatable strings in English
        $PHPMAILER_LANG = [
            '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: ',
            'invalid_hostentry' => 'Invalid hostentry: ',
            'invalid_host' => 'Invalid host: ',
            '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(__DIR__) . 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 ('en' !== $langcode) {
            // Make sure language file path is readable
            if (!static::isPermittedPath($lang_file) || !file_exists($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 (bool) $foundlang; // Returns false if language not found
    }

Here is the caller graph for this function:

setLE()

static PHPMailer\PHPMailer\PHPMailer::setLE (   $le )

staticprotected

Set the line break format string, e.g.

"\r\n".

Parameters

string

$le

Definition at line 4421 of file PHPMailer.php.

    {
        static::$LE = $le;
    }

setMessageType()

PHPMailer\PHPMailer\PHPMailer::setMessageType ( )

protected

Set the message type.

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

Definition at line 2902 of file PHPMailer.php.

References $type, PHPMailer\PHPMailer\PHPMailer\alternativeExists(), PHPMailer\PHPMailer\PHPMailer\attachmentExists(), and PHPMailer\PHPMailer\PHPMailer\inlineImageExists().

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

    {
        $type = [];
        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';
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOAuth()

PHPMailer\PHPMailer\PHPMailer::setOAuth

(

OAuth

$oauth

)

Set an OAuth instance.

Definition at line 4836 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$oauth.

    {
        $this->oauth = $oauth;
    }

setSMTPInstance()

PHPMailer\PHPMailer\PHPMailer::setSMTPInstance

(

SMTP

$smtp

)

Provide an instance to use for SMTP operations.

Returns

SMTP

Definition at line 1835 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\$smtp.

    {
        $this->smtp = $smtp;

        return $this->smtp;
    }

setWordWrap()

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

Definition at line 2357 of file PHPMailer.php.

References PHPMailer\PHPMailer\PHPMailer\wrapText().

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

    {
        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;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sign()

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

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

Parameters

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

Definition at line 4434 of file 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\PHPMailer\PHPMailer::smtpClose

(

)

Close the active SMTP session if one exists.

Definition at line 2066 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\__destruct().

    {
        if ((null !== $this->smtp) && $this->smtp->connected()) {
            $this->smtp->quit();
            $this->smtp->close();
        }
    }

Here is the caller graph for this function:

smtpConnect()

PHPMailer\PHPMailer\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()

Exceptions

Exception

Returns

bool

Definition at line 1942 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpSend().

    {
        if (null === $this->smtp) {
            $this->smtp = $this->getSMTPInstance();
        }

        //If no options are provided, use whatever is set in the instance
        if (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 = [];
            if (!preg_match(
                '/^(?:(ssl|tls):\/\/)?(.+?)(?::(\d+))?$/',
                trim($hostentry),
                $hostinfo
            )) {
                $this->edebug($this->lang('invalid_hostentry') . ' ' . trim($hostentry));
                // Not a valid host entry
                continue;
            }
            // $hostinfo[1]: optional ssl or tls prefix
            // $hostinfo[2]: the hostname
            // $hostinfo[3]: 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

            //Check the host name is a valid name or IP address before trying to use it
            if (!static::isValidHost($hostinfo[2])) {
                $this->edebug($this->lang('invalid_host') . ' ' . $hostinfo[2]);
                continue;
            }
            $prefix = '';
            $secure = $this->SMTPSecure;
            $tls = (static::ENCRYPTION_STARTTLS === $this->SMTPSecure);
            if ('ssl' === $hostinfo[1] || ('' === $hostinfo[1] && static::ENCRYPTION_SMTPS === $this->SMTPSecure)) {
                $prefix = 'ssl://';
                $tls = false; // Can't have SSL and TLS at the same time
                $secure = static::ENCRYPTION_SMTPS;
            } elseif ('tls' === $hostinfo[1]) {
                $tls = true;
                // tls doesn't use a prefix
                $secure = static::ENCRYPTION_STARTTLS;
            }
            //Do we need the OpenSSL extension?
            $sslext = defined('OPENSSL_ALGO_SHA256');
            if (static::ENCRYPTION_STARTTLS === $secure || static::ENCRYPTION_SMTPS === $secure) {
                //Check for an OpenSSL constant rather than using extension_loaded, which is sometimes disabled
                if (!$sslext) {
                    throw new Exception($this->lang('extension_missing') . 'openssl', self::STOP_CRITICAL);
                }
            }
            $host = $hostinfo[2];
            $port = $this->Port;
            if (array_key_exists(3, $hostinfo) && is_numeric($hostinfo[3]) && $hostinfo[3] > 0 && $hostinfo[3] < 65536) {
                $port = (int) $hostinfo[3];
            }
            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 && $sslext && 'ssl' !== $secure && $this->smtp->getServerExt('STARTTLS')) {
                        $tls = true;
                    }
                    if ($tls) {
                        if (!$this->smtp->startTLS()) {
                            throw new Exception($this->lang('connect_host'));
                        }
                        // We must resend EHLO after TLS negotiation
                        $this->smtp->hello($hello);
                    }
                    if ($this->SMTPAuth && !$this->smtp->authenticate(
                        $this->Username,
                        $this->Password,
                        $this->AuthType,
                        $this->oauth
                    )) {
                        throw new Exception($this->lang('authenticate'));
                    }

                    return true;
                } catch (Exception $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 && null !== $lastexception) {
            throw $lastexception;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

smtpSend()

PHPMailer\PHPMailer\PHPMailer::smtpSend (   $header,   $body  )

protected

Send mail via SMTP.

Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

See also

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

Parameters

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

Exceptions

Exception

Returns

bool

Definition at line 1857 of file PHPMailer.php.

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

Referenced by PHPMailer\PHPMailer\PHPMailer\postSend().

    {
        $header = static::stripTrailingWSP($header) . static::$LE . static::$LE;
        $bad_rcpt = [];
        if (!$this->smtpConnect($this->SMTPOptions)) {
            throw new Exception($this->lang('smtp_connect_failed'), self::STOP_CRITICAL);
        }
        //Sender already validated in preSend()
        if ('' === $this->Sender) {
            $smtp_from = $this->From;
        } else {
            $smtp_from = $this->Sender;
        }
        if (!$this->smtp->mail($smtp_from)) {
            $this->setError($this->lang('from_failed') . $smtp_from . ' : ' . implode(',', $this->smtp->getError()));
            throw new Exception($this->ErrorInfo, self::STOP_CRITICAL);
        }

        $callbacks = [];
        // Attempt to send to all recipients
        foreach ([$this->to, $this->cc, $this->bcc] as $togroup) {
            foreach ($togroup as $to) {
                if (!$this->smtp->recipient($to[0], $this->dsn)) {
                    $error = $this->smtp->getError();
                    $bad_rcpt[] = ['to' => $to[0], 'error' => $error['detail']];
                    $isSent = false;
                } else {
                    $isSent = true;
                }

                $callbacks[] = ['issent'=>$isSent, 'to'=>$to[0]];
            }
        }

        // Only send the DATA command if we have viable recipients
        if ((count($this->all_recipients) > count($bad_rcpt)) && !$this->smtp->data($header . $body)) {
            throw new Exception($this->lang('data_not_accepted'), self::STOP_CRITICAL);
        }

        $smtp_transaction_id = $this->smtp->getLastTransactionID();

        if ($this->SMTPKeepAlive) {
            $this->smtp->reset();
        } else {
            $this->smtp->quit();
            $this->smtp->close();
        }

        foreach ($callbacks as $cb) {
            $this->doCallback(
                $cb['issent'],
                [$cb['to']],
                [],
                [],
                $this->Subject,
                $body,
                $this->From,
                ['smtp_transaction_id' => $smtp_transaction_id]
            );
        }

        //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 Exception($this->lang('recipients_failed') . $errstr, self::STOP_CONTINUE);
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

stripTrailingWSP()

static PHPMailer\PHPMailer\PHPMailer::stripTrailingWSP (   $text )

static

Remove trailing breaks from a string.

Parameters

string

$text

Returns

string The text to remove breaks from

Definition at line 4401 of file PHPMailer.php.

References $text.

    {
        return rtrim($text, " \r\n\t");
    }

textLine()

PHPMailer\PHPMailer\PHPMailer::textLine

(

$value

)

Return a formatted mail line.

Parameters

string

$value

Returns

string

Definition at line 2941 of file PHPMailer.php.

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

    {
        return $value . static::$LE;
    }

Here is the caller graph for this function:

utf8CharBoundary()

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

Parameters

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

Returns

int

Definition at line 2313 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\wrapText().

    {
        $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 -= $lookBack - $encodedCharPos;
                    }
                    $foundSplitPos = true;
                } elseif ($dec >= 192) {
                    // First byte of a multi byte character
                    // Reduce maxLength to split at start of character
                    $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;
    }

Here is the caller graph for this function:

validateAddress()

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

static

Check that a string looks like an email address.

Validation patterns supported:

• auto Pick best pattern automatically;
• pcre8 Use the squiloople.com pattern, requires PCRE > 8.0;
• 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@example.com', function($address) {
    return (strpos($address, '@') !== false);
});

You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.

Parameters

string	$address	The email address to check
string | callable	$patternselect	Which pattern to use

Returns

bool

Definition at line 1310 of file PHPMailer.php.

    {
        if (null === $patternselect) {
            $patternselect = static::$validator;
        }
        if (is_callable($patternselect)) {
            return $patternselect($address);
        }
        //Reject line breaks in addresses; it's valid RFC5322, but not RFC5321
        if (strpos($address, "\n") !== false || strpos($address, "\r") !== false) {
            return false;
        }
        switch ($patternselect) {
            case 'pcre': //Kept for BC
            case 'pcre8':
                /*
                 * A more complex and more permissive version of the RFC5322 regex on which FILTER_VALIDATE_EMAIL
                 * is based.
                 * In addition to the addresses allowed by filter_var, also permits:
                 *  * dotless domains: `a@b`
                 *  * comments: `1234 @ local(blah) .machine .example`
                 *  * quoted elements: `'"test blah"@example.org'`
                 *  * numeric TLDs: `a@b.123`
                 *  * unbracketed IPv4 literals: `a@192.168.0.1`
                 *  * IPv6 literals: 'first.last@[IPv6:a1::]'
                 * Not all of these will necessarily work for sending!
                 *
                 * @see       http://squiloople.com/2009/12/20/email-address-validation/
                 * @copyright 2009-2010 Michael Rushton
                 * Feel free to use and redistribute this code. But please keep this copyright notice.
                 */
                return (bool) 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 'html5':
                /*
                 * This is the pattern used in the HTML5 spec for validation of 'email' type form input elements.
                 *
                 * @see http://www.whatwg.org/specs/web-apps/current-work/#e-mail-state-(type=email)
                 */
                return (bool) 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 'php':
            default:
                return filter_var($address, FILTER_VALIDATE_EMAIL) !== false;
        }
    }

validateEncoding()

PHPMailer\PHPMailer\PHPMailer::validateEncoding (   $encoding )

protected

Validate encodings.

Parameters

string

$encoding

Returns

bool

Definition at line 3642 of file PHPMailer.php.

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

    {
        return in_array(
            $encoding,
            [
                self::ENCODING_7BIT,
                self::ENCODING_QUOTED_PRINTABLE,
                self::ENCODING_BASE64,
                self::ENCODING_8BIT,
                self::ENCODING_BINARY,
            ],
            true
        );
    }

Here is the caller graph for this function:

wrapText()

PHPMailer\PHPMailer\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
int	$length	The line length to wrap to
bool	$qp_mode	Whether to run in Quoted-Printable mode

Returns

string

Definition at line 2213 of file PHPMailer.php.

References $message, and PHPMailer\PHPMailer\PHPMailer\utf8CharBoundary().

Referenced by PHPMailer\PHPMailer\PHPMailer\encodeHeader(), and PHPMailer\PHPMailer\PHPMailer\setWordWrap().

    {
        if ($qp_mode) {
            $soft_break = sprintf(' =%s', static::$LE);
        } else {
            $soft_break = static::$LE;
        }
        // If utf-8 encoding is used, we will need to make sure we don't
        // split multibyte characters when we wrap
        $is_utf8 = static::CHARSET_UTF8 === strtolower($this->CharSet);
        $lelen = strlen(static::$LE);
        $crlflen = strlen(static::$LE);

        $message = static::normalizeBreaks($message);
        //Remove a trailing line break
        if (substr($message, -$lelen) === static::$LE) {
            $message = substr($message, 0, -$lelen);
        }

        //Split message into lines
        $lines = explode(static::$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 && (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', static::$LE);
                        } else {
                            $message .= $buf . $soft_break;
                        }
                        $buf = '';
                    }
                    while ($word !== '') {
                        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 = (string) substr($word, $len);

                        if ($word !== '') {
                            $message .= $part . sprintf('=%s', static::$LE);
                        } else {
                            $buf = $part;
                        }
                    }
                } else {
                    $buf_o = $buf;
                    if (!$firstword) {
                        $buf .= ' ';
                    }
                    $buf .= $word;

                    if ('' !== $buf_o && strlen($buf) > $length) {
                        $message .= $buf_o . $soft_break;
                        $buf = $word;
                    }
                }
                $firstword = false;
            }
            $message .= $buf . static::$LE;
        }

        return $message;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$action_function

PHPMailer\PHPMailer\PHPMailer::$action_function = ''

Definition at line 557 of file PHPMailer.php.

$all_recipients

PHPMailer\PHPMailer\PHPMailer::$all_recipients = []

protected

Definition at line 623 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getAllRecipientAddresses().

$AllowEmpty

PHPMailer\PHPMailer\PHPMailer::$AllowEmpty = false

Definition at line 470 of file PHPMailer.php.

$AltBody

PHPMailer\PHPMailer\PHPMailer::$AltBody = ''

Definition at line 147 of file PHPMailer.php.

$attachment

PHPMailer\PHPMailer\PHPMailer::$attachment = []

protected

Definition at line 656 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\attachAll(), PHPMailer\PHPMailer\PHPMailer\attachmentExists(), PHPMailer\PHPMailer\PHPMailer\cidExists(), PHPMailer\PHPMailer\PHPMailer\getAttachments(), and PHPMailer\PHPMailer\PHPMailer\inlineImageExists().

$AuthType

PHPMailer\PHPMailer\PHPMailer::$AuthType = ''

Definition at line 357 of file PHPMailer.php.

$bcc

PHPMailer\PHPMailer\PHPMailer::$bcc = []

protected

Definition at line 604 of file PHPMailer.php.

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

$Body

PHPMailer\PHPMailer\PHPMailer::$Body = ''

Definition at line 137 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\msgHTML().

$boundary

PHPMailer\PHPMailer\PHPMailer::$boundary = []

protected

Definition at line 684 of file PHPMailer.php.

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

$cc

PHPMailer\PHPMailer\PHPMailer::$cc = []

protected

Definition at line 597 of file PHPMailer.php.

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

$CharSet

PHPMailer\PHPMailer\PHPMailer::$CharSet = self::CHARSET_ISO88591

Definition at line 76 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody(), PHPMailer\PHPMailer\PHPMailer\encodeHeader(), and PHPMailer\PHPMailer\PHPMailer\getBoundary().

$ConfirmReadingTo

PHPMailer\PHPMailer\PHPMailer::$ConfirmReadingTo = ''

Definition at line 236 of file PHPMailer.php.

$ContentType

PHPMailer\PHPMailer\PHPMailer::$ContentType = self::CONTENT_TYPE_PLAINTEXT

Definition at line 83 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getBoundary().

$CustomHeader

PHPMailer\PHPMailer\PHPMailer::$CustomHeader = []

protected

Definition at line 663 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getCustomHeaders().

$Debugoutput

PHPMailer\PHPMailer\PHPMailer::$Debugoutput = 'echo'

Definition at line 427 of file PHPMailer.php.

$DKIM_copyHeaderFields

PHPMailer\PHPMailer\PHPMailer::$DKIM_copyHeaderFields = true

Definition at line 509 of file PHPMailer.php.

$DKIM_domain

PHPMailer\PHPMailer\PHPMailer::$DKIM_domain = ''

Definition at line 502 of file PHPMailer.php.

$DKIM_extraHeaders

PHPMailer\PHPMailer\PHPMailer::$DKIM_extraHeaders = []

Definition at line 518 of file PHPMailer.php.

$DKIM_identity

PHPMailer\PHPMailer\PHPMailer::$DKIM_identity = ''

Definition at line 485 of file PHPMailer.php.

$DKIM_passphrase

PHPMailer\PHPMailer\PHPMailer::$DKIM_passphrase = ''

Definition at line 493 of file PHPMailer.php.

$DKIM_private

PHPMailer\PHPMailer\PHPMailer::$DKIM_private = ''

Definition at line 525 of file PHPMailer.php.

$DKIM_private_string

PHPMailer\PHPMailer\PHPMailer::$DKIM_private_string = ''

Definition at line 534 of file PHPMailer.php.

$DKIM_selector

PHPMailer\PHPMailer\PHPMailer::$DKIM_selector = ''

Definition at line 477 of file PHPMailer.php.

$do_verp

PHPMailer\PHPMailer\PHPMailer::$do_verp = false

Definition at line 463 of file PHPMailer.php.

$dsn

PHPMailer\PHPMailer\PHPMailer::$dsn = ''

Comma separated list of DSN notifications 'NEVER' under no circumstances a DSN must be returned to the sender.

If you use NEVER all other notifications will be ignored. 'SUCCESS' will notify you when your mail has arrived at its destination. 'FAILURE' will arrive if an error occurred during delivery. 'DELAY' will notify you if there is an unusual delay in delivery, but the actual delivery's outcome (success or failure) is not yet decided.

See also

https://tools.ietf.org/html/rfc3461 See section 4.1 for more information about NOTIFY

Definition at line 385 of file PHPMailer.php.

$Encoding

PHPMailer\PHPMailer\PHPMailer::$Encoding = self::ENCODING_8BIT

Definition at line 91 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody(), and PHPMailer\PHPMailer\PHPMailer\getBoundary().

$error_count

PHPMailer\PHPMailer\PHPMailer::$error_count = 0

protected

Definition at line 698 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\setError().

$ErrorInfo

PHPMailer\PHPMailer\PHPMailer::$ErrorInfo = ''

Definition at line 98 of file PHPMailer.php.

$exceptions

PHPMailer\PHPMailer\PHPMailer::$exceptions = false

protected

Definition at line 734 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\__construct().

$From

PHPMailer\PHPMailer\PHPMailer::$From = 'root@localhost'

Definition at line 105 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpSend().

$FromName

PHPMailer\PHPMailer\PHPMailer::$FromName = 'Root User'

Definition at line 112 of file PHPMailer.php.

$Helo

PHPMailer\PHPMailer\PHPMailer::$Helo = ''

Definition at line 300 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpConnect().

$Host

PHPMailer\PHPMailer\PHPMailer::$Host = 'localhost'

Definition at line 282 of file PHPMailer.php.

$Hostname

PHPMailer\PHPMailer\PHPMailer::$Hostname = ''

Definition at line 248 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\serverHostname().

$Ical

PHPMailer\PHPMailer\PHPMailer::$Ical = ''

Definition at line 159 of file PHPMailer.php.

$IcalMethods

PHPMailer\PHPMailer\PHPMailer::$IcalMethods

staticprotected

Initial value:

= [
        self::ICAL_METHOD_REQUEST,
        self::ICAL_METHOD_PUBLISH,
        self::ICAL_METHOD_REPLY,
        self::ICAL_METHOD_ADD,
        self::ICAL_METHOD_CANCEL,
        self::ICAL_METHOD_REFRESH,
        self::ICAL_METHOD_COUNTER,
        self::ICAL_METHOD_DECLINECOUNTER,
    ]

Definition at line 166 of file PHPMailer.php.

$language

PHPMailer\PHPMailer\PHPMailer::$language = []

protected

Definition at line 691 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getTranslations().

$lastMessageID

PHPMailer\PHPMailer\PHPMailer::$lastMessageID = ''

protected

Definition at line 670 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getLastMessageID().

$LE

PHPMailer\PHPMailer\PHPMailer::$LE = self::CRLF

staticprotected

Definition at line 787 of file PHPMailer.php.

$Mailer

PHPMailer\PHPMailer\PHPMailer::$Mailer = 'mail'

Definition at line 214 of file PHPMailer.php.

$mailHeader

PHPMailer\PHPMailer\PHPMailer::$mailHeader = ''

protected

Definition at line 196 of file PHPMailer.php.

$message_type

PHPMailer\PHPMailer\PHPMailer::$message_type = ''

protected

Definition at line 677 of file PHPMailer.php.

$MessageDate

PHPMailer\PHPMailer\PHPMailer::$MessageDate = ''

Definition at line 268 of file PHPMailer.php.

$MessageID

PHPMailer\PHPMailer\PHPMailer::$MessageID = ''

Definition at line 260 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\createHeader().

$MIMEBody

PHPMailer\PHPMailer\PHPMailer::$MIMEBody = ''

protected

Definition at line 182 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getSentMIMEMessage().

$MIMEHeader

PHPMailer\PHPMailer\PHPMailer::$MIMEHeader = ''

protected

Definition at line 189 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\preSend().

$oauth

PHPMailer\PHPMailer\PHPMailer::$oauth

protected

Definition at line 364 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getOAuth(), and PHPMailer\PHPMailer\PHPMailer\setOAuth().

$Password

PHPMailer\PHPMailer\PHPMailer::$Password = ''

Definition at line 349 of file PHPMailer.php.

$Port

PHPMailer\PHPMailer\PHPMailer::$Port = 25

Definition at line 289 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpConnect().

$Priority

PHPMailer\PHPMailer\PHPMailer::$Priority

Definition at line 69 of file PHPMailer.php.

$RecipientsQueue

PHPMailer\PHPMailer\PHPMailer::$RecipientsQueue = []

protected

Definition at line 638 of file PHPMailer.php.

$ReplyTo

PHPMailer\PHPMailer\PHPMailer::$ReplyTo = []

protected

Definition at line 611 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getReplyToAddresses().

$ReplyToQueue

PHPMailer\PHPMailer\PHPMailer::$ReplyToQueue = []

protected

Definition at line 649 of file PHPMailer.php.

$Sender

PHPMailer\PHPMailer\PHPMailer::$Sender = ''

Definition at line 122 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpSend().

$Sendmail

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

Definition at line 221 of file PHPMailer.php.

$sign_cert_file

PHPMailer\PHPMailer\PHPMailer::$sign_cert_file = ''

protected

Definition at line 705 of file PHPMailer.php.

$sign_extracerts_file

PHPMailer\PHPMailer\PHPMailer::$sign_extracerts_file = ''

protected

Definition at line 719 of file PHPMailer.php.

$sign_key_file

PHPMailer\PHPMailer\PHPMailer::$sign_key_file = ''

protected

Definition at line 712 of file PHPMailer.php.

$sign_key_pass

PHPMailer\PHPMailer\PHPMailer::$sign_key_pass = ''

protected

Definition at line 727 of file PHPMailer.php.

$SingleTo

PHPMailer\PHPMailer\PHPMailer::$SingleTo = false

Definition at line 445 of file PHPMailer.php.

$SingleToArray

PHPMailer\PHPMailer\PHPMailer::$SingleToArray = []

protected

Definition at line 452 of file PHPMailer.php.

$smtp

PHPMailer\PHPMailer\PHPMailer::$smtp

protected

Definition at line 583 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\getSMTPInstance(), and PHPMailer\PHPMailer\PHPMailer\setSMTPInstance().

$SMTPAuth

PHPMailer\PHPMailer\PHPMailer::$SMTPAuth = false

Definition at line 328 of file PHPMailer.php.

$SMTPAutoTLS

PHPMailer\PHPMailer\PHPMailer::$SMTPAutoTLS = true

Definition at line 317 of file PHPMailer.php.

$SMTPDebug

PHPMailer\PHPMailer\PHPMailer::$SMTPDebug = 0

Definition at line 401 of file PHPMailer.php.

$SMTPKeepAlive

PHPMailer\PHPMailer\PHPMailer::$SMTPKeepAlive = false

Definition at line 436 of file PHPMailer.php.

$SMTPOptions

PHPMailer\PHPMailer\PHPMailer::$SMTPOptions = []

Definition at line 335 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpConnect().

$SMTPSecure

PHPMailer\PHPMailer\PHPMailer::$SMTPSecure = ''

Definition at line 308 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\smtpConnect().

$Subject

PHPMailer\PHPMailer\PHPMailer::$Subject = ''

Definition at line 129 of file PHPMailer.php.

$Timeout

PHPMailer\PHPMailer\PHPMailer::$Timeout = 300

Definition at line 372 of file PHPMailer.php.

$to

PHPMailer\PHPMailer\PHPMailer::$to = []

protected

Definition at line 590 of file PHPMailer.php.

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

$uniqueid

PHPMailer\PHPMailer\PHPMailer::$uniqueid = ''

protected

Definition at line 741 of file PHPMailer.php.

Referenced by PHPMailer\PHPMailer\PHPMailer\createBody().

$Username

PHPMailer\PHPMailer\PHPMailer::$Username = ''

Definition at line 342 of file PHPMailer.php.

$UseSendmailOptions

PHPMailer\PHPMailer\PHPMailer::$UseSendmailOptions = true

Definition at line 229 of file PHPMailer.php.

$validator

PHPMailer\PHPMailer\PHPMailer::$validator = 'php'

static

Definition at line 576 of file PHPMailer.php.

$WordWrap

PHPMailer\PHPMailer\PHPMailer::$WordWrap = 0

Definition at line 206 of file PHPMailer.php.

$XMailer

PHPMailer\PHPMailer\PHPMailer::$XMailer = ''

Definition at line 565 of file PHPMailer.php.

CHARSET_ASCII

const PHPMailer\PHPMailer\PHPMailer::CHARSET_ASCII = 'us-ascii'

Definition at line 33 of file PHPMailer.php.

CHARSET_ISO88591

const PHPMailer\PHPMailer\PHPMailer::CHARSET_ISO88591 = 'iso-8859-1'

Definition at line 34 of file PHPMailer.php.

CHARSET_UTF8

const PHPMailer\PHPMailer\PHPMailer::CHARSET_UTF8 = 'utf-8'

Definition at line 35 of file PHPMailer.php.

CONTENT_TYPE_MULTIPART_ALTERNATIVE

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'

Definition at line 40 of file PHPMailer.php.

CONTENT_TYPE_MULTIPART_MIXED

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'

Definition at line 41 of file PHPMailer.php.

CONTENT_TYPE_MULTIPART_RELATED

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'

Definition at line 42 of file PHPMailer.php.

CONTENT_TYPE_PLAINTEXT

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_PLAINTEXT = 'text/plain'

Definition at line 37 of file PHPMailer.php.

CONTENT_TYPE_TEXT_CALENDAR

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'

Definition at line 38 of file PHPMailer.php.

CONTENT_TYPE_TEXT_HTML

const PHPMailer\PHPMailer\PHPMailer::CONTENT_TYPE_TEXT_HTML = 'text/html'

Definition at line 39 of file PHPMailer.php.

CRLF

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

The SMTP standard CRLF line break.

If you want to change line break format, change static::$LE, not this.

Definition at line 775 of file PHPMailer.php.

ENCODING_7BIT

const PHPMailer\PHPMailer\PHPMailer::ENCODING_7BIT = '7bit'

Definition at line 44 of file PHPMailer.php.

ENCODING_8BIT

const PHPMailer\PHPMailer\PHPMailer::ENCODING_8BIT = '8bit'

Definition at line 45 of file PHPMailer.php.

ENCODING_BASE64

const PHPMailer\PHPMailer\PHPMailer::ENCODING_BASE64 = 'base64'

Definition at line 46 of file PHPMailer.php.

ENCODING_BINARY

const PHPMailer\PHPMailer\PHPMailer::ENCODING_BINARY = 'binary'

Definition at line 47 of file PHPMailer.php.

ENCODING_QUOTED_PRINTABLE

const PHPMailer\PHPMailer\PHPMailer::ENCODING_QUOTED_PRINTABLE = 'quoted-printable'

Definition at line 48 of file PHPMailer.php.

ENCRYPTION_SMTPS

const PHPMailer\PHPMailer\PHPMailer::ENCRYPTION_SMTPS = 'ssl'

Definition at line 51 of file PHPMailer.php.

ENCRYPTION_STARTTLS

const PHPMailer\PHPMailer\PHPMailer::ENCRYPTION_STARTTLS = 'tls'

Definition at line 50 of file PHPMailer.php.

FWS

const PHPMailer\PHPMailer\PHPMailer::FWS = ' '

"Folding White Space" a white space string used for line folding.

Definition at line 780 of file PHPMailer.php.

ICAL_METHOD_ADD

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_ADD = 'ADD'

Definition at line 56 of file PHPMailer.php.

ICAL_METHOD_CANCEL

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_CANCEL = 'CANCEL'

Definition at line 57 of file PHPMailer.php.

ICAL_METHOD_COUNTER

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_COUNTER = 'COUNTER'

Definition at line 59 of file PHPMailer.php.

ICAL_METHOD_DECLINECOUNTER

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'

Definition at line 60 of file PHPMailer.php.

ICAL_METHOD_PUBLISH

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_PUBLISH = 'PUBLISH'

Definition at line 54 of file PHPMailer.php.

ICAL_METHOD_REFRESH

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_REFRESH = 'REFRESH'

Definition at line 58 of file PHPMailer.php.

ICAL_METHOD_REPLY

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_REPLY = 'REPLY'

Definition at line 55 of file PHPMailer.php.

ICAL_METHOD_REQUEST

const PHPMailer\PHPMailer\PHPMailer::ICAL_METHOD_REQUEST = 'REQUEST'

Definition at line 53 of file PHPMailer.php.

MAIL_MAX_LINE_LENGTH

const PHPMailer\PHPMailer\PHPMailer::MAIL_MAX_LINE_LENGTH = 63

Definition at line 797 of file PHPMailer.php.

MAX_LINE_LENGTH

const PHPMailer\PHPMailer\PHPMailer::MAX_LINE_LENGTH = 998

Definition at line 804 of file PHPMailer.php.

STD_LINE_LENGTH

const PHPMailer\PHPMailer\PHPMailer::STD_LINE_LENGTH = 76

Definition at line 814 of file PHPMailer.php.

STOP_CONTINUE

const PHPMailer\PHPMailer\PHPMailer::STOP_CONTINUE = 1

Definition at line 762 of file PHPMailer.php.

STOP_CRITICAL

const PHPMailer\PHPMailer\PHPMailer::STOP_CRITICAL = 2

Definition at line 769 of file PHPMailer.php.

STOP_MESSAGE

const PHPMailer\PHPMailer\PHPMailer::STOP_MESSAGE = 0

Definition at line 755 of file PHPMailer.php.

VERSION

const PHPMailer\PHPMailer\PHPMailer::VERSION = '6.1.6'

Definition at line 748 of file PHPMailer.php.

---

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

• libs/composer/vendor/phpmailer/phpmailer/src/PHPMailer.php