Parameters
- @@ -543,6 +556,8 @@
From e444e5ce1409af0fa140dcde4218258d372e8760 Mon Sep 17 00:00:00 2001
From: Synchro Wrapper for the built-in parse_url function to work around a bug in PHP 5.5. OAuth - OAuth2 authentication wrapper class. Uses the oauth2-client package from the League of Extraordinary Packages. The client ID, generated in the app definition of the service you're connecting to.
Tags
@@ -153,6 +154,8 @@
+
+
Table of Contents
@@ -175,49 +178,49 @@
Parameters
Return values
PHPMailer
@@ -324,6 +327,7 @@
Parameters
Return values
PHPMailer
@@ -380,6 +386,7 @@
Return values
array<string|int, mixed>|false
@@ -431,6 +440,7 @@
Parameters
+
+
Parameters
+
+
Parameters
Parameters
+
+
Return values
array<string|int, mixed>
@@ -779,13 +800,13 @@
Tags
@@ -148,6 +149,8 @@
+
+
Table of Contents
@@ -170,7 +173,7 @@
Return values
@@ -342,7 +345,7 @@
Table of Contents
@@ -186,35 +189,35 @@
protected
string
@@ -313,6 +314,8 @@ and also the from address when sending email.
+
+
protected
string
@@ -347,6 +351,8 @@ and also the from address when sending email.
+
+
The refresh token, used to obtain new AccessTokens.
+
protected
string
@@ -381,6 +388,8 @@ and also the from address when sending email.
+
+
The current OAuth access token.
+
protected
AccessToken
@@ -415,6 +425,8 @@ and also the from address when sending email.
+
+
The user's email address, usually used as the login ID
and also the from address when sending email.
+
protected
string
@@ -450,6 +463,8 @@ and also the from address when sending email.
+
+
An instance of the League OAuth Client Provider.
+
protected
AbstractProvider
@@ -484,6 +500,8 @@ and also the from address when sending email.
+
+
@@ -520,6 +538,7 @@ and also the from address when sending email.
+
Parameters
-
@@ -537,6 +556,8 @@ and also the from address when sending email.
+
+
Return values
@@ -603,6 +627,9 @@ and also the from address when sending email.
+
+
+
Return values
@@ -639,6 +666,9 @@ and also the from address when sending email.
+
+
+
Return values
@@ -759,22 +789,22 @@ and also the from address when sending email.
- Properties
-
- Methods
-
- - __construct()
- - getOauth64()
- - getGrant()
- - getToken()
+ - __construct()
+ - getOauth64()
+ - getGrant()
+ - getToken()
diff --git a/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html b/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html
index 1350c6aa..5e6ba192 100644
--- a/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html
+++ b/classes/PHPMailer-PHPMailer-OAuthTokenProvider.html
@@ -115,6 +115,7 @@
OAuthTokenProvider - OAuth2 token provider interface.
+
Provides base64 encoded OAuth2 auth strings for SMTP authentication.
@@ -159,7 +160,9 @@
-
+
+
+
@@ -185,7 +188,7 @@
-
- getOauth64()
+ getOauth64()
: string
@@ -198,8 +201,6 @@
-
-
Methods
@@ -232,6 +233,7 @@
+
The string to be base 64 encoded should be in the form:
"user=<user_email_address>\001auth=Bearer <access_token>\001\001"
@@ -239,6 +241,8 @@
+
+
Return values
string
@@ -357,7 +361,7 @@
- Methods
-
diff --git a/classes/PHPMailer-PHPMailer-PHPMailer.html b/classes/PHPMailer-PHPMailer-PHPMailer.html
index 94b7687f..4b61b1cb 100644
--- a/classes/PHPMailer-PHPMailer-PHPMailer.html
+++ b/classes/PHPMailer-PHPMailer-PHPMailer.html
@@ -126,6 +126,7 @@
+
Tags
@@ -172,6 +173,8 @@
+
+
Table of Contents
@@ -191,207 +194,207 @@
-
- CHARSET_ASCII
+ CHARSET_ASCII
= 'us-ascii'
-
- CHARSET_ISO88591
+ CHARSET_ISO88591
= 'iso-8859-1'
-
- CHARSET_UTF8
+ CHARSET_UTF8
= 'utf-8'
-
- CONTENT_TYPE_MULTIPART_ALTERNATIVE
+ CONTENT_TYPE_MULTIPART_ALTERNATIVE
= 'multipart/alternative'
-
- CONTENT_TYPE_MULTIPART_MIXED
+ CONTENT_TYPE_MULTIPART_MIXED
= 'multipart/mixed'
-
- CONTENT_TYPE_MULTIPART_RELATED
+ CONTENT_TYPE_MULTIPART_RELATED
= 'multipart/related'
-
- CONTENT_TYPE_PLAINTEXT
+ CONTENT_TYPE_PLAINTEXT
= 'text/plain'
-
- CONTENT_TYPE_TEXT_CALENDAR
+ CONTENT_TYPE_TEXT_CALENDAR
= 'text/calendar'
-
- CONTENT_TYPE_TEXT_HTML
+ CONTENT_TYPE_TEXT_HTML
= 'text/html'
-
- CRLF
+ CRLF
= "\r\n"
- The SMTP standard CRLF line break.
-
- ENCODING_7BIT
+ ENCODING_7BIT
= '7bit'
-
- ENCODING_8BIT
+ ENCODING_8BIT
= '8bit'
-
- ENCODING_BASE64
+ ENCODING_BASE64
= 'base64'
-
- ENCODING_BINARY
+ ENCODING_BINARY
= 'binary'
-
- ENCODING_QUOTED_PRINTABLE
+ ENCODING_QUOTED_PRINTABLE
= 'quoted-printable'
-
- ENCRYPTION_SMTPS
+ ENCRYPTION_SMTPS
= 'ssl'
-
- ENCRYPTION_STARTTLS
+ ENCRYPTION_STARTTLS
= 'tls'
-
- FWS
+ FWS
= ' '
- "Folding White Space" a white space string used for line folding.
-
- ICAL_METHOD_ADD
+ ICAL_METHOD_ADD
= 'ADD'
-
- ICAL_METHOD_CANCEL
+ ICAL_METHOD_CANCEL
= 'CANCEL'
-
- ICAL_METHOD_COUNTER
+ ICAL_METHOD_COUNTER
= 'COUNTER'
-
- ICAL_METHOD_DECLINECOUNTER
+ ICAL_METHOD_DECLINECOUNTER
= 'DECLINECOUNTER'
-
- ICAL_METHOD_PUBLISH
+ ICAL_METHOD_PUBLISH
= 'PUBLISH'
-
- ICAL_METHOD_REFRESH
+ ICAL_METHOD_REFRESH
= 'REFRESH'
-
- ICAL_METHOD_REPLY
+ ICAL_METHOD_REPLY
= 'REPLY'
-
- ICAL_METHOD_REQUEST
+ ICAL_METHOD_REQUEST
= 'REQUEST'
-
- MAIL_MAX_LINE_LENGTH
+ MAIL_MAX_LINE_LENGTH
= 63
- The maximum line length supported by mail().
-
- MAX_LINE_LENGTH
+ MAX_LINE_LENGTH
= 998
- The maximum line length allowed by RFC 2822 section 2.1.1.
-
- STD_LINE_LENGTH
+ STD_LINE_LENGTH
= 76
- The lower maximum line length allowed by RFC 2822 section 2.1.1.
-
- STOP_CONTINUE
+ STOP_CONTINUE
= 1
- Error severity: message, likely ok to continue processing.
-
- STOP_CRITICAL
+ STOP_CRITICAL
= 2
- Error severity: message, plus full stop, critical error reached.
-
- STOP_MESSAGE
+ STOP_MESSAGE
= 0
- Error severity: message only, continue processing.
-
- VERSION
+ VERSION
= '6.9.1'
@@ -407,133 +410,133 @@
-
- $action_function
+ $action_function
: string
- Callback Action function name.
-
- $AllowEmpty
+ $AllowEmpty
: bool
- Whether to allow sending messages with an empty body.
-
- $AltBody
+ $AltBody
: string
- The plain-text message body.
-
- $AuthType
+ $AuthType
: string
- SMTP authentication type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2.
-
- $Body
+ $Body
: string
- An HTML or plain text message body.
-
- $CharSet
+ $CharSet
: string
- The character set of the message.
-
- $ConfirmReadingTo
+ $ConfirmReadingTo
: string
- The email address that a reading confirmation should be sent to, also known as read receipt.
-
- $ContentType
+ $ContentType
: string
- The MIME Content-type of the message.
-
- $Debugoutput
+ $Debugoutput
: string|callable|LoggerInterface
- How to handle debug output.
-
- $DKIM_copyHeaderFields
+ $DKIM_copyHeaderFields
: bool
- DKIM Copy header field values for diagnostic use.
-
- $DKIM_domain
+ $DKIM_domain
: string
- DKIM signing domain name.
-
- $DKIM_extraHeaders
+ $DKIM_extraHeaders
: array<string|int, mixed>
- DKIM Extra signing headers.
-
- $DKIM_identity
+ $DKIM_identity
: string
- DKIM Identity.
-
- $DKIM_passphrase
+ $DKIM_passphrase
: string
- DKIM passphrase.
-
- $DKIM_private
+ $DKIM_private
: string
- DKIM private key file path.
-
- $DKIM_private_string
+ $DKIM_private_string
: string
- DKIM private key string.
-
- $DKIM_selector
+ $DKIM_selector
: string
- DKIM selector.
-
- $do_verp
+ $do_verp
: bool
- Whether to generate VERP addresses on send.
-
- $dsn
+ $dsn
: mixed
@@ -541,119 +544,119 @@
'NEVER' under no circumstances a DSN must be returned to the sender.
-
- $Encoding
+ $Encoding
: string
- The message encoding.
-
- $ErrorInfo
+ $ErrorInfo
: string
- Holds the most recent mailer error message.
-
- $From
+ $From
: string
- The From email address for the message.
-
- $FromName
+ $FromName
: string
- The From name of the message.
-
- $Helo
+ $Helo
: string
- The SMTP HELO/EHLO name used for the SMTP connection.
-
- $Host
+ $Host
: string
- SMTP hosts.
-
- $Hostname
+ $Hostname
: string
- The hostname to use in the Message-ID header and as default HELO string.
-
- $Ical
+ $Ical
: string
- An iCal message part body.
-
- $Mailer
+ $Mailer
: string
- Which method to use to send mail.
-
- $MessageDate
+ $MessageDate
: string
- The message Date to be used in the Date header.
-
- $MessageID
+ $MessageID
: string
- An ID to be used in the Message-ID header.
-
- $Password
+ $Password
: string
- SMTP password.
-
- $Port
+ $Port
: int
- The default SMTP server port.
-
- $Priority
+ $Priority
: int|null
- Email priority.
-
- $Sender
+ $Sender
: string
- The envelope sender of the message.
-
- $Sendmail
+ $Sendmail
: string
- The path to the sendmail program.
-
- $SingleTo
+ $SingleTo
: bool
@@ -661,14 +664,14 @@
or send them all in one message.
-
- $SMTPAuth
+ $SMTPAuth
: bool
- Whether to use SMTP authentication.
-
- $SMTPAutoTLS
+ $SMTPAutoTLS
: bool
@@ -676,280 +679,280 @@ or send them all in one message.
even if `SMTPSecure` is not set to 'tls'.
-
- $SMTPDebug
+ $SMTPDebug
: int
- SMTP class debug output mode.
-
- $SMTPKeepAlive
+ $SMTPKeepAlive
: bool
- Whether to keep the SMTP connection open after each message.
-
- $SMTPOptions
+ $SMTPOptions
: array<string|int, mixed>
- Options array passed to stream_context_create when connecting via SMTP.
-
- $SMTPSecure
+ $SMTPSecure
: string
- What kind of encryption to use on the SMTP connection.
-
- $Subject
+ $Subject
: string
- The Subject of the message.
-
- $Timeout
+ $Timeout
: int
- The SMTP server timeout in seconds.
-
- $Username
+ $Username
: string
- SMTP username.
-
- $UseSendmailOptions
+ $UseSendmailOptions
: bool
- Whether mail() uses a fully sendmail-compatible MTA.
-
- $validator
+ $validator
: string|callable
- Which validator to use by default when validating email addresses.
-
- $WordWrap
+ $WordWrap
: int
- Word-wrap the message body to this number of chars.
-
- $XMailer
+ $XMailer
: string|null
- What to put in the X-Mailer header.
-
- $all_recipients
+ $all_recipients
: array<string|int, mixed>
- An array of all kinds of addresses.
-
- $attachment
+ $attachment
: array<string|int, mixed>
- The array of attachments.
-
- $bcc
+ $bcc
: array<string|int, mixed>
- The array of 'bcc' names and addresses.
-
- $boundary
+ $boundary
: array<string|int, mixed>
- The array of MIME boundary strings.
-
- $cc
+ $cc
: array<string|int, mixed>
- The array of 'cc' names and addresses.
-
- $CustomHeader
+ $CustomHeader
: array<string|int, mixed>
- The array of custom headers.
-
- $error_count
+ $error_count
: int
- The number of errors encountered.
-
- $exceptions
+ $exceptions
: bool
- Whether to throw exceptions for errors.
-
- $IcalMethods
+ $IcalMethods
: array<string|int, string>
- Value-array of "method" in Contenttype header "text/calendar"
-
- $language
+ $language
: array<string|int, mixed>
- The array of available text strings for the current language.
-
- $lastMessageID
+ $lastMessageID
: string
- The most recent Message-ID (including angular brackets).
-
- $LE
+ $LE
: string
- SMTP RFC standard line ending; Carriage Return, Line Feed.
-
- $mailHeader
+ $mailHeader
: string
- Extra headers that createHeader() doesn't fold in.
-
- $message_type
+ $message_type
: string
- The message's MIME type.
-
- $MIMEBody
+ $MIMEBody
: string
- The complete compiled MIME message body.
-
- $MIMEHeader
+ $MIMEHeader
: string
- The complete compiled MIME message headers.
-
- $oauth
+ $oauth
: OAuthTokenProvider
- An implementation of the PHPMailer OAuthTokenProvider interface.
-
- $RecipientsQueue
+ $RecipientsQueue
: array<string|int, mixed>
- An array of names and addresses queued for validation.
-
- $ReplyTo
+ $ReplyTo
: array<string|int, mixed>
- The array of reply-to names and addresses.
-
- $ReplyToQueue
+ $ReplyToQueue
: array<string|int, mixed>
- An array of reply-to names and addresses queued for validation.
-
- $sign_cert_file
+ $sign_cert_file
: string
- The S/MIME certificate file path.
-
- $sign_extracerts_file
+ $sign_extracerts_file
: string
- The optional S/MIME extra certificates ("CA Chain") file path.
-
- $sign_key_file
+ $sign_key_file
: string
- The S/MIME key file path.
-
- $sign_key_pass
+ $sign_key_pass
: string
- The S/MIME password for the key.
-
- $SingleToArray
+ $SingleToArray
: array<string|int, mixed>
- Storage for addresses when SingleTo is enabled.
-
- $smtp
+ $smtp
: SMTP
- An instance of the SMTP sender class.
-
- $SMTPXClient
+ $SMTPXClient
: array<string|int, mixed>
- SMTP SMTPXClient command attibutes
-
- $to
+ $to
: array<string|int, mixed>
- The array of 'to' names and addresses.
-
- $uniqueid
+ $uniqueid
: string
@@ -964,119 +967,119 @@ even if `SMTPSecure` is not set to 'tls'.
-
- __construct()
+ __construct()
: mixed
- Constructor.
-
- __destruct()
+ __destruct()
: mixed
- Destructor.
-
- _mime_types()
+ _mime_types()
: string
- Get the MIME type for a file extension.
-
- addAddress()
+ addAddress()
: bool
- Add a "To" address.
-
- addAttachment()
+ addAttachment()
: bool
- Add an attachment from a path on the filesystem.
-
- addBCC()
+ addBCC()
: bool
- Add a "BCC" address.
-
- addCC()
+ addCC()
: bool
- Add a "CC" address.
-
- addCustomHeader()
+ addCustomHeader()
: bool
- Add a custom header.
-
- addEmbeddedImage()
+ addEmbeddedImage()
: bool
- Add an embedded (inline) attachment from a file.
-
- addrAppend()
+ addrAppend()
: string
- Create recipient headers.
-
- addReplyTo()
+ addReplyTo()
: bool
- Add a "Reply-To" address.
-
- addrFormat()
+ addrFormat()
: string
- Format an address for use in a message header.
-
- addStringAttachment()
+ addStringAttachment()
: bool
- Add a string or binary attachment (non-filesystem).
-
- addStringEmbeddedImage()
+ addStringEmbeddedImage()
: bool
- Add an embedded stringified attachment.
-
- alternativeExists()
+ alternativeExists()
: bool
- Check if this message has an alternative body set.
-
- attachmentExists()
+ attachmentExists()
: bool
- Check if an attachment (non-inline) is present.
-
- base64EncodeWrapMB()
+ base64EncodeWrapMB()
: string
@@ -1084,273 +1087,273 @@ even if `SMTPSecure` is not set to 'tls'.
without breaking lines within a character.
-
- clearAddresses()
+ clearAddresses()
: mixed
- Clear all To recipients.
-
- clearAllRecipients()
+ clearAllRecipients()
: mixed
- Clear all recipient types.
-
- clearAttachments()
+ clearAttachments()
: mixed
- Clear all filesystem, string, and binary attachments.
-
- clearBCCs()
+ clearBCCs()
: mixed
- Clear all BCC recipients.
-
- clearCCs()
+ clearCCs()
: mixed
- Clear all CC recipients.
-
- clearCustomHeader()
+ clearCustomHeader()
: bool
- Clear a specific custom header by name or name and value.
-
- clearCustomHeaders()
+ clearCustomHeaders()
: mixed
- Clear all custom headers.
-
- clearQueuedAddresses()
+ clearQueuedAddresses()
: mixed
- Clear queued addresses of given kind.
-
- clearReplyTos()
+ clearReplyTos()
: mixed
- Clear all ReplyTo recipients.
-
- createBody()
+ createBody()
: string
- Assemble the message body.
-
- createHeader()
+ createHeader()
: string
- Assemble message headers.
-
- DKIM_Add()
+ DKIM_Add()
: string
- Create the DKIM header and body in a new message header.
-
- DKIM_BodyC()
+ DKIM_BodyC()
: string
- Generate a DKIM canonicalization body.
-
- DKIM_HeaderC()
+ DKIM_HeaderC()
: string
- Generate a DKIM canonicalization header.
-
- DKIM_QP()
+ DKIM_QP()
: string
- Quoted-Printable-encode a DKIM header.
-
- DKIM_Sign()
+ DKIM_Sign()
: string
- Generate a DKIM signature.
-
- encodeHeader()
+ encodeHeader()
: string
- Encode a header value (not including its label) optimally.
-
- encodeQ()
+ encodeQ()
: string
- Encode a string using Q encoding.
-
- encodeQP()
+ encodeQP()
: string
- Encode a string in quoted-printable format.
-
- encodeString()
+ encodeString()
: string
- Encode a string in requested format.
-
- filenameToType()
+ filenameToType()
: string
- Map a file name to a MIME type.
-
- getAllRecipientAddresses()
+ getAllRecipientAddresses()
: array<string|int, mixed>
- Allows for public read access to 'all_recipients' property.
-
- getAttachments()
+ getAttachments()
: array<string|int, mixed>
- Return the array of attachments.
-
- getBccAddresses()
+ getBccAddresses()
: array<string|int, mixed>
- Allows for public read access to 'bcc' property.
-
- getBoundaries()
+ getBoundaries()
: array<string|int, mixed>
- Get the boundaries that this message will use
-
- getCcAddresses()
+ getCcAddresses()
: array<string|int, mixed>
- Allows for public read access to 'cc' property.
-
- getCustomHeaders()
+ getCustomHeaders()
: array<string|int, mixed>
- Returns all custom headers.
-
- getLastMessageID()
+ getLastMessageID()
: string
- Return the Message-ID header of the last email.
-
- getLE()
+ getLE()
: string
- Return the current line break format string.
-
- getMailMIME()
+ getMailMIME()
: string
- Get the message MIME type headers.
-
- getOAuth()
+ getOAuth()
: OAuthTokenProvider
- Get the OAuthTokenProvider instance.
-
- getReplyToAddresses()
+ getReplyToAddresses()
: array<string|int, mixed>
- Allows for public read access to 'ReplyTo' property.
-
- getSentMIMEMessage()
+ getSentMIMEMessage()
: string
- Returns the whole MIME message.
-
- getSMTPInstance()
+ getSMTPInstance()
: SMTP
- Get an instance to use for SMTP operations.
-
- getSMTPXclientAttributes()
+ getSMTPXclientAttributes()
: array<string|int, mixed>
- Get SMTP XCLIENT attributes
-
- getToAddresses()
+ getToAddresses()
: array<string|int, mixed>
- Allows for public read access to 'to' property.
-
- getTranslations()
+ getTranslations()
: array<string|int, mixed>
- Get the array of strings for the current language.
-
- has8bitChars()
+ has8bitChars()
: bool
- Does a string contain any 8-bit chars (in any charset)?
-
- hasLineLongerThanMax()
+ hasLineLongerThanMax()
: bool
@@ -1358,28 +1361,28 @@ without breaking lines within a character.
allowed by RFC 2822 section 2.1.1.
-
- hasMultiBytes()
+ hasMultiBytes()
: bool
- Check if a string contains multi-byte characters.
-
- headerLine()
+ headerLine()
: string
- Format a header line.
-
- html2text()
+ html2text()
: string
- Convert an HTML string into plain text.
-
- idnSupported()
+ idnSupported()
: bool
@@ -1387,84 +1390,84 @@ allowed by RFC 2822 section 2.1.1.
`intl` and `mbstring` PHP extensions.
-
- inlineImageExists()
+ inlineImageExists()
: bool
- Check if an inline attachment is present.
-
- isError()
+ isError()
: bool
- Check if an error occurred.
-
- isHTML()
+ isHTML()
: mixed
- Sets message type to HTML or plain.
-
- isMail()
+ isMail()
: mixed
- Send messages using PHP's mail() function.
-
- isQmail()
+ isQmail()
: mixed
- Send messages using qmail.
-
- isSendmail()
+ isSendmail()
: mixed
- Send messages using $Sendmail.
-
- isSMTP()
+ isSMTP()
: mixed
- Send messages using SMTP.
-
- isValidHost()
+ isValidHost()
: bool
- Validate whether a string contains a valid value to use as a hostname or IP address.
-
- mb_pathinfo()
+ mb_pathinfo()
: string|array<string|int, mixed>
- Multi-byte-safe pathinfo replacement.
-
- msgHTML()
+ msgHTML()
: string
- Create a message body from an HTML string.
-
- normalizeBreaks()
+ normalizeBreaks()
: string
- Normalize line breaks in a string.
-
- parseAddresses()
+ parseAddresses()
: array<string|int, mixed>
@@ -1472,28 +1475,28 @@ allowed by RFC 2822 section 2.1.1.
of the form "display name <address>" into an array of name/address pairs.
-
- postSend()
+ postSend()
: bool
- Actually send a message via the selected mechanism.
-
- preSend()
+ preSend()
: bool
- Prepare a message for sending.
-
- punyencodeAddress()
+ punyencodeAddress()
: string
- Converts IDN in given email address to its ASCII form, also known as punycode, if possible.
-
- quotedString()
+ quotedString()
: string
@@ -1501,133 +1504,133 @@ of the form "display name <address>" into an array of name/addre
and escape any double quotes with a backslash.
-
- replaceCustomHeader()
+ replaceCustomHeader()
: bool
- Replace a custom header.
-
- rfcDate()
+ rfcDate()
: string
- Return an RFC 822 formatted date.
-
- secureHeader()
+ secureHeader()
: string
- Strip newlines to prevent header injection.
-
- send()
+ send()
: bool
- Create a message and send it.
-
- set()
+ set()
: bool
- Set or reset instance properties.
-
- setBoundaries()
+ setBoundaries()
: void
- Set the boundaries to use for delimiting MIME parts.
-
- setFrom()
+ setFrom()
: bool
- Set the From and FromName properties.
-
- setLanguage()
+ setLanguage()
: bool
- Set the language for error messages.
-
- setOAuth()
+ setOAuth()
: mixed
- Set an OAuthTokenProvider instance.
-
- setSMTPInstance()
+ setSMTPInstance()
: SMTP
- Provide an instance to use for SMTP operations.
-
- setSMTPXclientAttribute()
+ setSMTPXclientAttribute()
: bool
- Provide SMTP XCLIENT attributes
-
- setWordWrap()
+ setWordWrap()
: mixed
- Apply word wrapping to the message body.
-
- sign()
+ sign()
: mixed
- Set the public and private key files and password for S/MIME signing.
-
- smtpClose()
+ smtpClose()
: mixed
- Close the active SMTP session if one exists.
-
- smtpConnect()
+ smtpConnect()
: bool
- Initiate a connection to an SMTP server.
-
- stripTrailingBreaks()
+ stripTrailingBreaks()
: string
- Strip trailing line breaks from a string.
-
- stripTrailingWSP()
+ stripTrailingWSP()
: string
- Remove trailing whitespace from a string.
-
- textLine()
+ textLine()
: string
- Return a formatted mail line.
-
- utf8CharBoundary()
+ utf8CharBoundary()
: int
@@ -1635,28 +1638,28 @@ and escape any double quotes with a backslash.
quoted-printable encoded string.
-
- validateAddress()
+ validateAddress()
: bool
- Check that a string looks like an email address.
-
- wrapText()
+ wrapText()
: string
- Word-wrap message.
-
- addAnAddress()
+ addAnAddress()
: bool
- Add an address to one of the recipient arrays or to the ReplyTo array.
-
- addOrEnqueueAnAddress()
+ addOrEnqueueAnAddress()
: bool
@@ -1665,154 +1668,154 @@ can't validate addresses with an IDN without knowing the PHPMailer::$CharSe
be modified after calling this function), addition of such addresses is delayed until send().
-
- attachAll()
+ attachAll()
: string
- Attach all file, string, and binary attachments to the message.
-
- cidExists()
+ cidExists()
: bool
- Check if an embedded attachment is present with this cid.
-
- doCallback()
+ doCallback()
: mixed
- Perform a callback.
-
- edebug()
+ edebug()
: mixed
- Output debugging info via a user-defined method.
-
- encodeFile()
+ encodeFile()
: string
- Encode a file attachment in requested format.
-
- endBoundary()
+ endBoundary()
: string
- Return the end of a message boundary.
-
- fileIsAccessible()
+ fileIsAccessible()
: bool
- Check whether a file path is safe, accessible, and readable.
-
- generateId()
+ generateId()
: string
- Create a unique ID to use for boundaries.
-
- getBoundary()
+ getBoundary()
: string
- Return the start of a message boundary.
-
- isPermittedPath()
+ isPermittedPath()
: bool
- Check whether a file path is of a permitted type.
-
- isShellSafe()
+ isShellSafe()
: bool
- Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters.
-
- lang()
+ lang()
: string
- Get an error message in the current language.
-
- mailSend()
+ mailSend()
: bool
- Send mail using the PHP mail() function.
-
- sendmailSend()
+ sendmailSend()
: bool
- Send mail using the $Sendmail program.
-
- serverHostname()
+ serverHostname()
: string
- Get the server hostname.
-
- setError()
+ setError()
: mixed
- Add an error message to the error container.
-
- setLE()
+ setLE()
: mixed
- Set the line break format string, e.g. "\r\n".
-
- setMessageType()
+ setMessageType()
: mixed
- Set the message type.
-
- smtpSend()
+ smtpSend()
: bool
- Send mail via SMTP.
-
- validateEncoding()
+ validateEncoding()
: bool
- Validate encodings.
-
- getSmtpErrorMessage()
+ getSmtpErrorMessage()
: string
- Build an error message starting with a generic one and adding details if possible.
-
- mailPassthru()
+ mailPassthru()
: bool
@@ -1822,9 +1825,6 @@ be modified after calling this function), addition of such addresses is delayed
-
-
-
@@ -1847,6 +1847,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1859,6 +1860,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -1875,6 +1878,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1887,6 +1891,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -1903,6 +1909,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1915,6 +1922,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -1931,6 +1940,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1943,6 +1953,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -1959,6 +1971,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1971,6 +1984,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -1987,6 +2002,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -1999,6 +2015,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2015,6 +2033,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2027,6 +2046,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2043,6 +2064,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2055,6 +2077,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2071,6 +2095,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2083,6 +2108,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2100,6 +2127,7 @@ be modified after calling this function), addition of such addresses is delayed
The SMTP standard CRLF line break.
+
public
mixed
@@ -2114,6 +2142,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2130,6 +2160,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2142,6 +2173,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2158,6 +2191,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2170,6 +2204,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2186,6 +2222,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2198,6 +2235,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2214,6 +2253,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2226,6 +2266,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2242,6 +2284,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2254,6 +2297,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2270,6 +2315,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2282,6 +2328,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2298,6 +2346,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2310,6 +2359,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2327,6 +2378,7 @@ be modified after calling this function), addition of such addresses is delayed
"Folding White Space" a white space string used for line folding.
+
public
mixed
@@ -2339,6 +2391,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2355,6 +2409,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2367,6 +2422,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2383,6 +2440,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2395,6 +2453,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2411,6 +2471,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2423,6 +2484,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2439,6 +2502,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2451,6 +2515,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2467,6 +2533,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2479,6 +2546,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2495,6 +2564,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2507,6 +2577,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2523,6 +2595,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2535,6 +2608,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2551,6 +2626,7 @@ be modified after calling this function), addition of such addresses is delayed
+
public
mixed
@@ -2563,6 +2639,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
@@ -2580,6 +2658,7 @@ be modified after calling this function), addition of such addresses is delayed
The maximum line length supported by mail().
+
public
int
@@ -2595,6 +2674,8 @@ with headers longer than 65 chars, see #818.
+
+
@@ -2612,6 +2693,7 @@ with headers longer than 65 chars, see #818.
The maximum line length allowed by RFC 2822 section 2.1.1.
+
public
int
@@ -2624,6 +2706,8 @@ with headers longer than 65 chars, see #818.
+
+
@@ -2641,6 +2725,7 @@ with headers longer than 65 chars, see #818.
The lower maximum line length allowed by RFC 2822 section 2.1.1.
+
public
int
@@ -2657,6 +2742,8 @@ the line break format is LF or CRLF; both are valid.
+
+
@@ -2674,6 +2761,7 @@ the line break format is LF or CRLF; both are valid.
Error severity: message, likely ok to continue processing.
+
public
int
@@ -2686,6 +2774,8 @@ the line break format is LF or CRLF; both are valid.
+
+
@@ -2703,6 +2793,7 @@ the line break format is LF or CRLF; both are valid.
Error severity: message, plus full stop, critical error reached.
+
public
int
@@ -2715,6 +2806,8 @@ the line break format is LF or CRLF; both are valid.
+
+
@@ -2732,6 +2825,7 @@ the line break format is LF or CRLF; both are valid.
Error severity: message only, continue processing.
+
public
int
@@ -2744,6 +2838,8 @@ the line break format is LF or CRLF; both are valid.
+
+
@@ -2761,6 +2857,7 @@ the line break format is LF or CRLF; both are valid.
The PHPMailer Version number.
+
public
string
@@ -2773,6 +2870,8 @@ the line break format is LF or CRLF; both are valid.
+
+
@@ -2806,6 +2905,7 @@ the line break format is LF or CRLF; both are valid.
Callback Action function name.
+
public
string
@@ -2830,6 +2930,8 @@ string $extra extra information of possible use
+
+
Whether to allow sending messages with an empty body.
+
public
bool
@@ -2864,6 +2967,8 @@ string $extra extra information of possible use
+
+
The plain-text message body.
+
public
string
@@ -2902,6 +3008,8 @@ Clients that can read HTML will view the normal Body.
+
+
SMTP authentication type. Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2.
+
public
string
@@ -2938,6 +3047,8 @@ Clients that can read HTML will view the normal Body.
+
+
An HTML or plain text message body.
+
public
string
@@ -2974,6 +3086,8 @@ Clients that can read HTML will view the normal Body.
+
+
The character set of the message.
+
public
string
@@ -3008,6 +3123,8 @@ Clients that can read HTML will view the normal Body.
+
+
The email address that a reading confirmation should be sent to, also known as read receipt.
+
public
string
@@ -3042,6 +3160,8 @@ Clients that can read HTML will view the normal Body.
+
+
The MIME Content-type of the message.
+
public
string
@@ -3076,6 +3197,8 @@ Clients that can read HTML will view the normal Body.
+
+
How to handle debug output.
+
public
string|callable|LoggerInterface
@@ -3143,6 +3267,8 @@ level output is used:
+
+
DKIM Copy header field values for diagnostic use.
+
public
bool
@@ -3177,6 +3304,8 @@ level output is used:
+
+
DKIM signing domain name.
+
public
string
@@ -3227,6 +3357,8 @@ level output is used:
+
+
DKIM Extra signing headers.
+
public
array<string|int, mixed>
@@ -3277,6 +3410,8 @@ level output is used:
+
+
DKIM Identity.
+
public
string
@@ -3313,6 +3449,8 @@ level output is used:
+
+
DKIM passphrase.
+
public
string
@@ -3349,6 +3488,8 @@ level output is used:
+
+
DKIM private key file path.
+
public
string
@@ -3383,6 +3525,8 @@ level output is used:
+
+
DKIM private key string.
+
public
string
@@ -3419,6 +3564,8 @@ level output is used:
+
+
DKIM selector.
+
public
string
@@ -3453,6 +3601,8 @@ level output is used:
+
+
Whether to generate VERP addresses on send.
+
public
bool
@@ -3514,6 +3665,8 @@ level output is used:
+
+
Comma separated list of DSN notifications
'NEVER' under no circumstances a DSN must be returned to the sender.
+
public
mixed
@@ -3572,6 +3726,8 @@ delivery's outcome (success or failure) is not yet decided.
+
+
The message encoding.
+
public
string
@@ -3608,6 +3765,8 @@ delivery's outcome (success or failure) is not yet decided.
+
+
Holds the most recent mailer error message.
+
public
string
@@ -3642,6 +3802,8 @@ delivery's outcome (success or failure) is not yet decided.
+
+
The From email address for the message.
+
public
string
@@ -3676,6 +3839,8 @@ delivery's outcome (success or failure) is not yet decided.
+
+
The From name of the message.
+
public
string
@@ -3710,6 +3876,8 @@ delivery's outcome (success or failure) is not yet decided.
+
+
The SMTP HELO/EHLO name used for the SMTP connection.
+
public
string
@@ -3762,6 +3931,8 @@ one with the same method described above for $Hostname.
+
+
SMTP hosts.
+
public
string
@@ -3804,6 +3976,8 @@ Hosts will be tried in order.
+
+
The hostname to use in the Message-ID header and as default HELO string.
+
public
string
@@ -3857,6 +4032,8 @@ $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value
+
+
An iCal message part body.
+
public
string
@@ -3909,6 +4087,8 @@ To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.
+
+
Which method to use to send mail.
+
public
string
@@ -3945,6 +4126,8 @@ To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.
+
+
The message Date to be used in the Date header.
+
public
string
@@ -3981,6 +4165,8 @@ To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.
+
+
An ID to be used in the Message-ID header.
+
public
string
@@ -4034,6 +4221,8 @@ as defined in RFC5322 section 3.6.4 or it will be ignored.
+
+
SMTP password.
+
public
string
@@ -4068,6 +4258,8 @@ as defined in RFC5322 section 3.6.4 or it will be ignored.
+
+
The default SMTP server port.
+
public
int
@@ -4102,6 +4295,8 @@ as defined in RFC5322 section 3.6.4 or it will be ignored.
+
+
Email priority.
+
public
int|null
@@ -4139,6 +4335,8 @@ When null, the header is not set at all.
+
+
The envelope sender of the message.
+
public
string
@@ -4177,6 +4376,8 @@ If not empty, will be passed via -f to sendmail
+
+
-f to sendmail
The path to the sendmail program.
+
public
string
@@ -4211,6 +4413,8 @@ If not empty, will be passed via -f to sendmail
+
+
-f to sendmail
Whether to split multiple to addresses into multiple messages or send them all in one message.
+PHPMailer isn't a mailing list manager!
+ +
public
bool
@@ -4247,23 +4459,8 @@ or send them all in one message.
-
- Tags
-
-
-
+
Whether to use SMTP authentication.
+
public
bool
@@ -4324,6 +4522,8 @@ or send them all in one message.
+
+
SMTP class debug output mode.
+
public
int
@@ -4458,6 +4662,8 @@ Options:
+
+
Whether to keep the SMTP connection open after each message.
+
public
bool
@@ -4497,6 +4704,8 @@ See the mailing list example for how to use it.
+
+
Options array passed to stream_context_create when connecting via SMTP.
+
public
array<string|int, mixed>
@@ -4531,6 +4741,8 @@ See the mailing list example for how to use it.
+
+
What kind of encryption to use on the SMTP connection.
+
public
string
@@ -4567,6 +4780,8 @@ See the mailing list example for how to use it.
+
+
The Subject of the message.
+
public
string
@@ -4601,6 +4817,8 @@ See the mailing list example for how to use it.
+
+
The SMTP server timeout in seconds.
+
public
int
@@ -4637,6 +4856,8 @@ See the mailing list example for how to use it.
+
+
SMTP username.
+
public
string
@@ -4671,6 +4893,8 @@ See the mailing list example for how to use it.
+
+
Whether mail() uses a fully sendmail-compatible MTA.
+
public
bool
@@ -4707,6 +4932,8 @@ See the mailing list example for how to use it.
+
+
Which validator to use by default when validating email addresses.
+
public
static string|callable
@@ -4759,6 +4987,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
Word-wrap the message body to this number of chars.
+
public
int
@@ -4810,6 +5041,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
What to put in the X-Mailer header.
+
public
string|null
@@ -4846,6 +5080,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
An array of all kinds of addresses.
+
protected
array<string|int, mixed>
@@ -4913,6 +5150,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of attachments.
+
protected
array<string|int, mixed>
@@ -4947,6 +5187,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of 'bcc' names and addresses.
+
protected
array<string|int, mixed>
@@ -4981,6 +5224,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of MIME boundary strings.
+
protected
array<string|int, mixed>
@@ -5015,6 +5261,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of 'cc' names and addresses.
+
protected
array<string|int, mixed>
@@ -5049,6 +5298,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of custom headers.
+
protected
array<string|int, mixed>
@@ -5083,6 +5335,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The number of errors encountered.
+
protected
int
@@ -5117,6 +5372,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
Whether to throw exceptions for errors.
+
protected
bool
@@ -5151,6 +5409,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
Value-array of "method" in Contenttype header "text/calendar"
+
protected
static array<string|int, string>
@@ -5185,6 +5446,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The array of available text strings for the current language.
+
protected
array<string|int, mixed>
@@ -5219,6 +5483,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The most recent Message-ID (including angular brackets).
+
protected
string
@@ -5253,6 +5520,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
SMTP RFC standard line ending; Carriage Return, Line Feed.
+
protected
static string
@@ -5287,6 +5557,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
Extra headers that createHeader() doesn't fold in.
+
protected
string
@@ -5321,6 +5594,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The message's MIME type.
+
protected
string
@@ -5355,6 +5631,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The complete compiled MIME message body.
+
protected
string
@@ -5389,6 +5668,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
The complete compiled MIME message headers.
+
protected
string
@@ -5423,6 +5705,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
An implementation of the PHPMailer OAuthTokenProvider interface.
+
protected
OAuthTokenProvider
@@ -5457,6 +5742,8 @@ The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
+
+
An array of names and addresses queued for validation.
+
protected
array<string|int, mixed>
@@ -5534,6 +5822,8 @@ This array is used only for addresses with IDN.
+
+
The array of reply-to names and addresses.
+
protected
array<string|int, mixed>
@@ -5568,6 +5859,8 @@ This array is used only for addresses with IDN.
+
+
An array of reply-to names and addresses queued for validation.
+
protected
array<string|int, mixed>
@@ -5620,6 +5914,8 @@ This array is used only for addresses with IDN.
+
+
The S/MIME certificate file path.
+
protected
string
@@ -5654,6 +5951,8 @@ This array is used only for addresses with IDN.
+
+
The optional S/MIME extra certificates ("CA Chain") file path.
+
protected
string
@@ -5688,6 +5988,8 @@ This array is used only for addresses with IDN.
+
+
The S/MIME key file path.
+
protected
string
@@ -5722,6 +6025,8 @@ This array is used only for addresses with IDN.
+
+
The S/MIME password for the key.
+
protected
string
@@ -5758,6 +6064,8 @@ This array is used only for addresses with IDN.
+
+
Storage for addresses when SingleTo is enabled.
+
protected
array<string|int, mixed>
@@ -5792,6 +6101,8 @@ This array is used only for addresses with IDN.
+
+
An instance of the SMTP sender class.
+
protected
SMTP
@@ -5826,6 +6138,8 @@ This array is used only for addresses with IDN.
+
+
SMTP SMTPXClient command attibutes
+
protected
array<string|int, mixed>
@@ -5860,6 +6175,8 @@ This array is used only for addresses with IDN.
+
+
The array of 'to' names and addresses.
+
protected
array<string|int, mixed>
@@ -5894,6 +6212,8 @@ This array is used only for addresses with IDN.
+
+
Unique ID used for message ID and boundaries.
+
protected
string
@@ -5928,6 +6249,8 @@ This array is used only for addresses with IDN.
+
+
@@ -5964,6 +6287,7 @@ This array is used only for addresses with IDN.
+
Parameters
-
@@ -5980,6 +6304,8 @@ This array is used only for addresses with IDN.
+
+
+
Parameters
-
@@ -6055,6 +6385,8 @@ This array is used only for addresses with IDN.
+
+
Return values
string
@@ -6092,6 +6424,7 @@ This array is used only for addresses with IDN.
+
Parameters
-
@@ -6129,6 +6462,8 @@ This array is used only for addresses with IDN.
+
+
Return values
bool
@@ -6165,6 +6500,7 @@ This array is used only for addresses with IDN.
+
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.
@@ -6237,6 +6573,8 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
+
Return values
bool
@@ -6270,6 +6608,7 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
Parameters
-
@@ -6307,6 +6646,8 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
+
Return values
bool
@@ -6344,6 +6685,7 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
Parameters
-
@@ -6381,6 +6723,8 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
+
Return values
bool
@@ -6417,6 +6761,7 @@ If you need to do that, fetch the resource yourself and pass it in via a local f
+
$name value can be overloaded to contain
both header name and value (name:value).
@@ -6460,6 +6805,8 @@ both header name and value (name:value).
+
+
Return values
bool
@@ -6496,6 +6843,7 @@ both header name and value (name:value).
+
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.
@@ -6581,6 +6929,8 @@ the content when using an embedded image in HTML
+
+
Return values
bool
@@ -6618,6 +6968,7 @@ the content when using an embedded image in HTML
+
Parameters
-
@@ -6643,6 +6994,8 @@ and element 1 containing a name, like:
+
+
Return values
string
@@ -6676,6 +7029,7 @@ and element 1 containing a name, like:
+
Parameters
-
@@ -6713,6 +7067,8 @@ and element 1 containing a name, like:
+
+
Return values
bool
@@ -6750,6 +7106,7 @@ and element 1 containing a name, like:
+
Parameters
-
@@ -6766,6 +7123,8 @@ and element 1 containing a name, like:
+
+
Return values
string
@@ -6798,6 +7157,7 @@ and element 1 containing a name, like:
+
This method can be used to attach ascii or binary data,
such as a BLOB record from a database.
@@ -6868,6 +7228,8 @@ such as a BLOB record from a database.
+
+
Return values
bool
@@ -6904,6 +7266,7 @@ such as a BLOB record from a database.
+
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.
@@ -6986,6 +7349,8 @@ For example 'file.jpg' would get an 'image/jpeg' MIME type.
+
+
Return values
bool
@@ -7025,6 +7390,9 @@ For example 'file.jpg' would get an 'image/jpeg' MIME type.
+
+
+
Return values
@@ -7061,6 +7429,9 @@ For example 'file.jpg' would get an 'image/jpeg' MIME type.
+
+
+
Return values
@@ -7095,6 +7466,7 @@ without breaking lines within a character.
+
Adapted from a function by paravoid.
@@ -7137,6 +7509,8 @@ without breaking lines within a character.
+
+
Return values
string
@@ -7172,6 +7546,9 @@ without breaking lines within a character.
+
+
+
@@ -7204,6 +7581,9 @@ without breaking lines within a character.
+
+
+
@@ -7236,6 +7616,9 @@ without breaking lines within a character.
+
+
+
@@ -7268,6 +7651,9 @@ without breaking lines within a character.
+
+
+
@@ -7300,6 +7686,9 @@ without breaking lines within a character.
+
+
+
@@ -7329,6 +7718,7 @@ without breaking lines within a character.
+
$name value can be overloaded to contain
both header name and value (name:value).
@@ -7357,6 +7747,8 @@ both header name and value (name:value).
+
+
Return values
bool
@@ -7396,6 +7788,9 @@ both header name and value (name:value).
+
+
+
@@ -7426,6 +7821,7 @@ both header name and value (name:value).
+
Parameters
-
@@ -7442,6 +7838,8 @@ both header name and value (name:value).
+
+
+
Returns an empty string on failure.
@@ -7522,6 +7924,8 @@ both header name and value (name:value).
+
+
Return values
string
@@ -7561,6 +7965,9 @@ both header name and value (name:value).
+
+
+
Return values
@@ -7599,6 +8006,7 @@ both header name and value (name:value).
+
Parameters
-
@@ -7647,6 +8055,8 @@ both header name and value (name:value).
+
+
Return values
string
@@ -7679,6 +8089,7 @@ both header name and value (name:value).
+
Uses the 'simple' algorithm from RFC6376 section 3.4.3.
Canonicalized bodies should always use CRLF, regardless of mailer setting.
@@ -7713,6 +8124,8 @@ Canonicalized bodies should always use CRLF, regardless of mailer setti
+
+
Return values
string
@@ -7745,6 +8158,7 @@ Canonicalized bodies should always use CRLF, regardless of mailer setti
+
Uses the 'relaxed' algorithm from RFC6376 section 3.4.2.
Canonicalized headers should always use CRLF, regardless of mailer setting.
@@ -7779,6 +8193,8 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
+
Return values
string
@@ -7812,6 +8228,7 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
Parameters
-
@@ -7825,6 +8242,8 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
+
Return values
string
@@ -7858,6 +8277,7 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
Parameters
-
@@ -7886,6 +8306,8 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
+
Return values
string
@@ -7922,6 +8344,7 @@ Canonicalized headers should always use CRLF, regardless of mailer sett
+
Picks shortest of Q, B, or none. Result includes folding if needed.
See RFC822 definitions for phrase, comment and text positions.
@@ -7950,6 +8373,8 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
Return values
string
@@ -7983,6 +8408,7 @@ See RFC822 definitions for phrase, comment and text positions.
+
Parameters
-
@@ -8022,6 +8448,8 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
Return values
string
@@ -8054,6 +8482,7 @@ See RFC822 definitions for phrase, comment and text positions.
+
According to RFC2045 section 6.7.
@@ -8072,6 +8501,8 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
Return values
string
@@ -8104,6 +8535,7 @@ See RFC822 definitions for phrase, comment and text positions.
+
Returns an empty string on failure.
@@ -8146,6 +8578,8 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
Return values
string
@@ -8178,6 +8612,7 @@ See RFC822 definitions for phrase, comment and text positions.
+
Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
@@ -8196,6 +8631,8 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
Return values
string
@@ -8228,12 +8665,15 @@ See RFC822 definitions for phrase, comment and text positions.
+
Before the send() call, queued addresses (i.e. with IDN) are not yet included.
+
+
Return values
array<string|int, mixed>
@@ -8269,6 +8709,9 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
+
Return values
@@ -8302,12 +8745,15 @@ See RFC822 definitions for phrase, comment and text positions.
+
Before the send() call, queued addresses (i.e. with IDN) are not yet included.
+
+
Return values
array<string|int, mixed>
@@ -8343,6 +8789,9 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
+
Return values
@@ -8376,12 +8825,15 @@ See RFC822 definitions for phrase, comment and text positions.
+
Before the send() call, queued addresses (i.e. with IDN) are not yet included.
+
+
Return values
array<string|int, mixed>
@@ -8417,6 +8869,9 @@ See RFC822 definitions for phrase, comment and text positions.
+
+
+
Return values
@@ -8450,6 +8905,7 @@ See RFC822 definitions for phrase, comment and text positions.
+
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.
@@ -8458,6 +8914,8 @@ pathological cases.
+
+
Return values
string
@@ -8493,6 +8951,9 @@ pathological cases.
+
+
+
Return values
@@ -8529,6 +8990,9 @@ pathological cases.
+
+
+
Return values
@@ -8565,6 +9029,9 @@ pathological cases.
+
+
+
Return values
@@ -8598,12 +9065,15 @@ pathological cases.
+
Before the send() call, queued addresses (i.e. with IDN) are not yet included.
+
+
Return values
array<string|int, mixed>
@@ -8636,6 +9106,7 @@ pathological cases.
+
Includes complete headers and body.
Only valid post preSend().
@@ -8658,6 +9129,8 @@ Only valid post preSend().
+
+
Return values
string
@@ -8690,6 +9163,7 @@ Only valid post preSend().
+
Override this function to load your own SMTP implementation,
or set one with setSMTPInstance.
@@ -8697,6 +9171,8 @@ or set one with setSMTPInstance.
+
+
Return values
SMTP
@@ -8732,6 +9208,9 @@ or set one with setSMTPInstance.
+
+
+
Return values
@@ -8765,12 +9244,15 @@ or set one with setSMTPInstance.
+
Before the send() call, queued addresses (i.e. with IDN) are not yet included.
+
+
Return values
array<string|int, mixed>
@@ -8806,6 +9288,9 @@ or set one with setSMTPInstance.
+
+
+
Return values
@@ -8840,6 +9325,7 @@ or set one with setSMTPInstance.
+
Parameters
-
@@ -8853,6 +9339,8 @@ or set one with setSMTPInstance.
+
+
Return values
bool
@@ -8887,6 +9375,7 @@ allowed by RFC 2822 section 2.1.1.
+
Parameters
-
@@ -8900,6 +9389,8 @@ allowed by RFC 2822 section 2.1.1.
+
+
Return values
bool
@@ -8933,6 +9424,7 @@ allowed by RFC 2822 section 2.1.1.
+
Parameters
-
@@ -8948,6 +9440,8 @@ allowed by RFC 2822 section 2.1.1.
+
+
Return values
bool
@@ -8981,6 +9475,7 @@ allowed by RFC 2822 section 2.1.1.
+
Parameters
-
@@ -9001,6 +9496,8 @@ allowed by RFC 2822 section 2.1.1.
+
+
Return values
string
@@ -9033,6 +9530,7 @@ allowed by RFC 2822 section 2.1.1.
+
This is used by msgHTML().
Note - older versions of this function used a bundled advanced converter
which was removed for license reasons in #232.
@@ -9073,6 +9571,8 @@ Never* pass user-supplied data into this parameter
+
+
Return values
string
@@ -9109,6 +9609,9 @@ Never* pass user-supplied data into this parameter
+
+
+
Return values
@@ -9149,6 +9652,9 @@ Never* pass user-supplied data into this parameter
+
+
+
Return values
@@ -9185,6 +9691,9 @@ Never* pass user-supplied data into this parameter
+
+
+
Return values
@@ -9223,6 +9732,7 @@ Never* pass user-supplied data into this parameter
+
Parameters
-
@@ -9239,6 +9749,8 @@ Never* pass user-supplied data into this parameter
+
+
+
IPv6 addresses must include [], e.g. [::1], not just ::1.
@@ -9412,6 +9937,8 @@ Never* pass user-supplied data into this parameter
+
+
Return values
bool
@@ -9444,6 +9971,7 @@ Never* pass user-supplied data into this parameter
+
Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.
@@ -9487,6 +10015,8 @@ or a string name to return only the specified piece
+
+
Return values
string|array<string|int, mixed>
@@ -9519,6 +10049,7 @@ or a string name to return only the specified piece
+
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!
@@ -9586,6 +10117,8 @@ or your own custom converter
+
+
Return values
string
@@ -9622,6 +10155,7 @@ or your own custom converter
+
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.
@@ -9648,6 +10182,8 @@ Defaults to CRLF (for message bodies) and preserves consecutive breaks.
+
+
Return values
string
@@ -9681,6 +10217,7 @@ of the form "display name <address>" into an array of name/addre
+
Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available.
Note that quotes in the name part are removed.
@@ -9735,6 +10272,8 @@ Note that quotes in the name part are removed.
+
+
Return values
array<string|int, mixed>
@@ -9770,6 +10309,7 @@ Note that quotes in the name part are removed.
+
Tags
@@ -9786,6 +10326,8 @@ Note that quotes in the name part are removed.
+
+
Return values
bool
@@ -9821,6 +10363,7 @@ Note that quotes in the name part are removed.
+
Tags
@@ -9837,6 +10380,8 @@ Note that quotes in the name part are removed.
+
+
Return values
bool
@@ -9869,6 +10414,7 @@ Note that quotes in the name part are removed.
+
Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet.
This function silently returns unmodified address if:
@@ -9908,6 +10454,8 @@ or fails for any reason (e.g. domain contains characters not allowed in an IDN).
+
+
Return values
string
@@ -9946,6 +10494,7 @@ and escape any double quotes with a backslash.
+
Parameters
-
@@ -9976,6 +10525,8 @@ and escape any double quotes with a backslash.
+
+
Return values
string
@@ -10008,6 +10559,7 @@ and escape any double quotes with a backslash.
+
$name value can be overloaded to contain
both header name and value (name:value).
@@ -10051,6 +10603,8 @@ both header name and value (name:value).
+
+
Return values
bool
@@ -10090,6 +10644,9 @@ both header name and value (name:value).
+
+
+
Return values
@@ -10124,6 +10681,7 @@ both header name and value (name:value).
+
Parameters
-
@@ -10137,6 +10695,8 @@ both header name and value (name:value).
+
+
Return values
string
@@ -10169,6 +10729,7 @@ both header name and value (name:value).
+
Uses the sending method specified by $Mailer.
@@ -10190,6 +10751,8 @@ both header name and value (name:value).
+
+
Return values
bool
@@ -10226,6 +10789,7 @@ both header name and value (name:value).
+
You should avoid this function - it's more verbose, less efficient, more error-prone and
harder to debug than setting properties directly.
Usage Example:
@@ -10258,6 +10822,8 @@ is the same as:
+
+
Return values
bool
@@ -10290,6 +10856,7 @@ is the same as:
+
If you override this, ensure you set all 3 boundaries to unique values.
The default boundaries include a "=_" sequence which cannot occur in quoted-printable bodies,
as suggested by https://www.rfc-editor.org/rfc/rfc2045#section-6.7
@@ -10299,6 +10866,8 @@ as suggested by https://www.rfc-editor.org/rfc/rfc2045#section-6.7
+
+
+
Parameters
-
@@ -10371,6 +10941,8 @@ as suggested by https://www.rfc-editor.org/rfc/rfc2045#section-6.7
+
+
Return values
bool
@@ -10403,6 +10975,7 @@ as suggested by https://www.rfc-editor.org/rfc/rfc2045#section-6.7
+
The default language is English.
@@ -10433,6 +11006,8 @@ Do not set this from user input!
+
+
Return values
bool
@@ -10470,6 +11045,7 @@ Do not set this from user input!
+
Parameters
-
@@ -10484,6 +11060,8 @@ Do not set this from user input!
+
+
+
Parameters
-
@@ -10525,6 +11104,8 @@ Do not set this from user input!
+
+
Return values
SMTP
@@ -10558,6 +11139,7 @@ Do not set this from user input!
+
Parameters
-
@@ -10582,6 +11164,8 @@ Do not set this from user input!
+
+
Return values
bool
@@ -10614,6 +11198,7 @@ Do not set this from user input!
+
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.
@@ -10623,6 +11208,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
+
Parameters
-
@@ -10690,6 +11278,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
+
Returns false if the operation failed.
@@ -10790,6 +11384,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
Return values
bool
@@ -10823,6 +11419,7 @@ This is called automatically by createBody(), so you don't need to call it yours
+
Parameters
-
@@ -10836,6 +11433,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
Return values
string
@@ -10873,6 +11472,7 @@ This is called automatically by createBody(), so you don't need to call it yours
+
Parameters
-
@@ -10886,6 +11486,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
Return values
string
@@ -10923,6 +11525,7 @@ This is called automatically by createBody(), so you don't need to call it yours
+
Parameters
-
@@ -10936,6 +11539,8 @@ This is called automatically by createBody(), so you don't need to call it yours
+
+
Return values
string
@@ -10969,6 +11574,7 @@ quoted-printable encoded string.
+
Original written by Colin Brown.
@@ -10996,6 +11602,8 @@ quoted-printable encoded string.
+
+
Return values
int
@@ -11028,6 +11636,7 @@ quoted-printable encoded string.
+
Validation patterns supported:
-
@@ -11075,6 +11684,8 @@ Alternatively you may pass in a callable to inject your own validator, for examp
+
+
Return values
bool
@@ -11107,6 +11718,7 @@ Alternatively you may pass in a callable to inject your own validator, for examp
+
For use with mailers that do not automatically perform wrapping
and for quoted-printable encoded messages.
Original written by philippe.
@@ -11145,6 +11757,8 @@ Original written by philippe.
+
+
Return values
string
@@ -11177,6 +11791,7 @@ Original written by philippe.
+
Addresses that have been added already return false, but do not throw exceptions.
@@ -11226,6 +11841,8 @@ Original written by philippe.
+
+
Return values
bool
@@ -11264,6 +11881,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Addresses that have been added already return false, but do not throw exceptions.
@@ -11315,6 +11933,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
bool
@@ -11351,6 +11971,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Returns an empty string on failure.
@@ -11389,6 +12010,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
string
@@ -11422,6 +12045,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Parameters
-
@@ -11435,6 +12059,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
bool
@@ -11468,6 +12094,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Parameters
-
@@ -11531,6 +12158,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
+
Only generates output if debug output is enabled.
@@ -11598,6 +12228,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
+
Returns an empty string on failure.
@@ -11652,6 +12285,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
string
@@ -11685,6 +12320,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Parameters
-
@@ -11698,6 +12334,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
string
@@ -11731,6 +12369,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Parameters
-
@@ -11746,6 +12385,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
bool
@@ -11781,6 +12422,9 @@ be modified after calling this function), addition of such addresses is delayed
+
+
+
Return values
@@ -11815,6 +12459,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Parameters
-
@@ -11849,6 +12494,8 @@ be modified after calling this function), addition of such addresses is delayed
+
+
Return values
string
@@ -11881,6 +12528,7 @@ be modified after calling this function), addition of such addresses is delayed
+
Used to reject URLs and phar files from functions that access local file paths,
such as addAttachment.
@@ -11900,6 +12548,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -11932,6 +12582,7 @@ such as addAttachment.
+
Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.
@@ -11967,6 +12618,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -12000,6 +12653,7 @@ such as addAttachment.
+
Parameters
-
@@ -12013,6 +12667,8 @@ such as addAttachment.
+
+
Return values
string
@@ -12046,6 +12702,7 @@ such as addAttachment.
+
Parameters
-
@@ -12093,6 +12750,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -12126,6 +12785,7 @@ such as addAttachment.
+
Parameters
-
@@ -12173,6 +12833,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -12205,12 +12867,15 @@ such as addAttachment.
+
Returns 'localhost.localdomain' if unknown.
+
+
Return values
string
@@ -12244,6 +12909,7 @@ such as addAttachment.
+
Parameters
-
@@ -12258,6 +12924,8 @@ such as addAttachment.
+
+
+
Parameters
-
@@ -12300,6 +12969,8 @@ such as addAttachment.
+
+
+
PHPMailer only supports some preset message types, not arbitrary MIME structures.
@@ -12334,6 +13006,8 @@ such as addAttachment.
+
+
+
Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
@@ -12421,6 +13096,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -12454,6 +13131,7 @@ such as addAttachment.
+
Parameters
-
@@ -12467,6 +13145,8 @@ such as addAttachment.
+
+
Return values
bool
@@ -12500,6 +13180,7 @@ such as addAttachment.
+
Parameters
-
@@ -12513,6 +13194,8 @@ such as addAttachment.
+
+
Return values
string
@@ -12545,6 +13228,7 @@ such as addAttachment.
+
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).
@@ -12601,6 +13285,8 @@ but it will do).
+
+
Return values
bool
@@ -12720,250 +13406,250 @@ but it will do).
- Constants
-
- - CHARSET_ASCII
- - CHARSET_ISO88591
- - CHARSET_UTF8
- - CONTENT_TYPE_MULTIPART_ALTERNATIVE
- - CONTENT_TYPE_MULTIPART_MIXED
- - CONTENT_TYPE_MULTIPART_RELATED
- - CONTENT_TYPE_PLAINTEXT
- - CONTENT_TYPE_TEXT_CALENDAR
- - CONTENT_TYPE_TEXT_HTML
- - CRLF
- - ENCODING_7BIT
- - ENCODING_8BIT
- - ENCODING_BASE64
- - ENCODING_BINARY
- - ENCODING_QUOTED_PRINTABLE
- - ENCRYPTION_SMTPS
- - ENCRYPTION_STARTTLS
- - FWS
- - ICAL_METHOD_ADD
- - ICAL_METHOD_CANCEL
- - ICAL_METHOD_COUNTER
- - ICAL_METHOD_DECLINECOUNTER
- - ICAL_METHOD_PUBLISH
- - ICAL_METHOD_REFRESH
- - ICAL_METHOD_REPLY
- - ICAL_METHOD_REQUEST
- - MAIL_MAX_LINE_LENGTH
- - MAX_LINE_LENGTH
- - STD_LINE_LENGTH
- - STOP_CONTINUE
- - STOP_CRITICAL
- - STOP_MESSAGE
- - VERSION
+ - CHARSET_ASCII
+ - CHARSET_ISO88591
+ - CHARSET_UTF8
+ - CONTENT_TYPE_MULTIPART_ALTERNATIVE
+ - CONTENT_TYPE_MULTIPART_MIXED
+ - CONTENT_TYPE_MULTIPART_RELATED
+ - CONTENT_TYPE_PLAINTEXT
+ - CONTENT_TYPE_TEXT_CALENDAR
+ - CONTENT_TYPE_TEXT_HTML
+ - CRLF
+ - ENCODING_7BIT
+ - ENCODING_8BIT
+ - ENCODING_BASE64
+ - ENCODING_BINARY
+ - ENCODING_QUOTED_PRINTABLE
+ - ENCRYPTION_SMTPS
+ - ENCRYPTION_STARTTLS
+ - FWS
+ - ICAL_METHOD_ADD
+ - ICAL_METHOD_CANCEL
+ - ICAL_METHOD_COUNTER
+ - ICAL_METHOD_DECLINECOUNTER
+ - ICAL_METHOD_PUBLISH
+ - ICAL_METHOD_REFRESH
+ - ICAL_METHOD_REPLY
+ - ICAL_METHOD_REQUEST
+ - MAIL_MAX_LINE_LENGTH
+ - MAX_LINE_LENGTH
+ - STD_LINE_LENGTH
+ - STOP_CONTINUE
+ - STOP_CRITICAL
+ - STOP_MESSAGE
+ - VERSION
- Properties
-
- - $action_function
- - $AllowEmpty
- - $AltBody
- - $AuthType
- - $Body
- - $CharSet
- - $ConfirmReadingTo
- - $ContentType
- - $Debugoutput
- - $DKIM_copyHeaderFields
- - $DKIM_domain
- - $DKIM_extraHeaders
- - $DKIM_identity
- - $DKIM_passphrase
- - $DKIM_private
- - $DKIM_private_string
- - $DKIM_selector
- - $do_verp
- - $dsn
- - $Encoding
- - $ErrorInfo
- - $From
- - $FromName
- - $Helo
- - $Host
- - $Hostname
- - $Ical
- - $Mailer
- - $MessageDate
- - $MessageID
- - $Password
- - $Port
- - $Priority
- - $Sender
- - $Sendmail
- - $SingleTo
- - $SMTPAuth
- - $SMTPAutoTLS
- - $SMTPDebug
- - $SMTPKeepAlive
- - $SMTPOptions
- - $SMTPSecure
- - $Subject
- - $Timeout
- - $Username
- - $UseSendmailOptions
- - $validator
- - $WordWrap
- - $XMailer
- - $all_recipients
- - $attachment
- - $bcc
- - $boundary
- - $cc
- - $CustomHeader
- - $error_count
- - $exceptions
- - $IcalMethods
- - $language
- - $lastMessageID
- - $LE
- - $mailHeader
- - $message_type
- - $MIMEBody
- - $MIMEHeader
- - $oauth
- - $RecipientsQueue
- - $ReplyTo
- - $ReplyToQueue
- - $sign_cert_file
- - $sign_extracerts_file
- - $sign_key_file
- - $sign_key_pass
- - $SingleToArray
- - $smtp
- - $SMTPXClient
- - $to
- - $uniqueid
+ - $action_function
+ - $AllowEmpty
+ - $AltBody
+ - $AuthType
+ - $Body
+ - $CharSet
+ - $ConfirmReadingTo
+ - $ContentType
+ - $Debugoutput
+ - $DKIM_copyHeaderFields
+ - $DKIM_domain
+ - $DKIM_extraHeaders
+ - $DKIM_identity
+ - $DKIM_passphrase
+ - $DKIM_private
+ - $DKIM_private_string
+ - $DKIM_selector
+ - $do_verp
+ - $dsn
+ - $Encoding
+ - $ErrorInfo
+ - $From
+ - $FromName
+ - $Helo
+ - $Host
+ - $Hostname
+ - $Ical
+ - $Mailer
+ - $MessageDate
+ - $MessageID
+ - $Password
+ - $Port
+ - $Priority
+ - $Sender
+ - $Sendmail
+ - $SingleTo
+ - $SMTPAuth
+ - $SMTPAutoTLS
+ - $SMTPDebug
+ - $SMTPKeepAlive
+ - $SMTPOptions
+ - $SMTPSecure
+ - $Subject
+ - $Timeout
+ - $Username
+ - $UseSendmailOptions
+ - $validator
+ - $WordWrap
+ - $XMailer
+ - $all_recipients
+ - $attachment
+ - $bcc
+ - $boundary
+ - $cc
+ - $CustomHeader
+ - $error_count
+ - $exceptions
+ - $IcalMethods
+ - $language
+ - $lastMessageID
+ - $LE
+ - $mailHeader
+ - $message_type
+ - $MIMEBody
+ - $MIMEHeader
+ - $oauth
+ - $RecipientsQueue
+ - $ReplyTo
+ - $ReplyToQueue
+ - $sign_cert_file
+ - $sign_extracerts_file
+ - $sign_key_file
+ - $sign_key_pass
+ - $SingleToArray
+ - $smtp
+ - $SMTPXClient
+ - $to
+ - $uniqueid
- Methods
-
- - __construct()
- - __destruct()
- - _mime_types()
- - addAddress()
- - addAttachment()
- - addBCC()
- - addCC()
- - addCustomHeader()
- - addEmbeddedImage()
- - addrAppend()
- - addReplyTo()
- - addrFormat()
- - addStringAttachment()
- - addStringEmbeddedImage()
- - alternativeExists()
- - attachmentExists()
- - base64EncodeWrapMB()
- - clearAddresses()
- - clearAllRecipients()
- - clearAttachments()
- - clearBCCs()
- - clearCCs()
- - clearCustomHeader()
- - clearCustomHeaders()
- - clearQueuedAddresses()
- - clearReplyTos()
- - createBody()
- - createHeader()
- - DKIM_Add()
- - DKIM_BodyC()
- - DKIM_HeaderC()
- - DKIM_QP()
- - DKIM_Sign()
- - encodeHeader()
- - encodeQ()
- - encodeQP()
- - encodeString()
- - filenameToType()
- - getAllRecipientAddresses()
- - getAttachments()
- - getBccAddresses()
- - getBoundaries()
- - getCcAddresses()
- - getCustomHeaders()
- - getLastMessageID()
- - getLE()
- - getMailMIME()
- - getOAuth()
- - getReplyToAddresses()
- - getSentMIMEMessage()
- - getSMTPInstance()
- - getSMTPXclientAttributes()
- - getToAddresses()
- - getTranslations()
- - has8bitChars()
- - hasLineLongerThanMax()
- - hasMultiBytes()
- - headerLine()
- - html2text()
- - idnSupported()
- - inlineImageExists()
- - isError()
- - isHTML()
- - isMail()
- - isQmail()
- - isSendmail()
- - isSMTP()
- - isValidHost()
- - mb_pathinfo()
- - msgHTML()
- - normalizeBreaks()
- - parseAddresses()
- - postSend()
- - preSend()
- - punyencodeAddress()
- - quotedString()
- - replaceCustomHeader()
- - rfcDate()
- - secureHeader()
- - send()
- - set()
- - setBoundaries()
- - setFrom()
- - setLanguage()
- - setOAuth()
- - setSMTPInstance()
- - setSMTPXclientAttribute()
- - setWordWrap()
- - sign()
- - smtpClose()
- - smtpConnect()
- - stripTrailingBreaks()
- - stripTrailingWSP()
- - textLine()
- - utf8CharBoundary()
- - validateAddress()
- - wrapText()
- - addAnAddress()
- - addOrEnqueueAnAddress()
- - attachAll()
- - cidExists()
- - doCallback()
- - edebug()
- - encodeFile()
- - endBoundary()
- - fileIsAccessible()
- - generateId()
- - getBoundary()
- - isPermittedPath()
- - isShellSafe()
- - lang()
- - mailSend()
- - sendmailSend()
- - serverHostname()
- - setError()
- - setLE()
- - setMessageType()
- - smtpSend()
- - validateEncoding()
- - getSmtpErrorMessage()
- - mailPassthru()
+ - __construct()
+ - __destruct()
+ - _mime_types()
+ - addAddress()
+ - addAttachment()
+ - addBCC()
+ - addCC()
+ - addCustomHeader()
+ - addEmbeddedImage()
+ - addrAppend()
+ - addReplyTo()
+ - addrFormat()
+ - addStringAttachment()
+ - addStringEmbeddedImage()
+ - alternativeExists()
+ - attachmentExists()
+ - base64EncodeWrapMB()
+ - clearAddresses()
+ - clearAllRecipients()
+ - clearAttachments()
+ - clearBCCs()
+ - clearCCs()
+ - clearCustomHeader()
+ - clearCustomHeaders()
+ - clearQueuedAddresses()
+ - clearReplyTos()
+ - createBody()
+ - createHeader()
+ - DKIM_Add()
+ - DKIM_BodyC()
+ - DKIM_HeaderC()
+ - DKIM_QP()
+ - DKIM_Sign()
+ - encodeHeader()
+ - encodeQ()
+ - encodeQP()
+ - encodeString()
+ - filenameToType()
+ - getAllRecipientAddresses()
+ - getAttachments()
+ - getBccAddresses()
+ - getBoundaries()
+ - getCcAddresses()
+ - getCustomHeaders()
+ - getLastMessageID()
+ - getLE()
+ - getMailMIME()
+ - getOAuth()
+ - getReplyToAddresses()
+ - getSentMIMEMessage()
+ - getSMTPInstance()
+ - getSMTPXclientAttributes()
+ - getToAddresses()
+ - getTranslations()
+ - has8bitChars()
+ - hasLineLongerThanMax()
+ - hasMultiBytes()
+ - headerLine()
+ - html2text()
+ - idnSupported()
+ - inlineImageExists()
+ - isError()
+ - isHTML()
+ - isMail()
+ - isQmail()
+ - isSendmail()
+ - isSMTP()
+ - isValidHost()
+ - mb_pathinfo()
+ - msgHTML()
+ - normalizeBreaks()
+ - parseAddresses()
+ - postSend()
+ - preSend()
+ - punyencodeAddress()
+ - quotedString()
+ - replaceCustomHeader()
+ - rfcDate()
+ - secureHeader()
+ - send()
+ - set()
+ - setBoundaries()
+ - setFrom()
+ - setLanguage()
+ - setOAuth()
+ - setSMTPInstance()
+ - setSMTPXclientAttribute()
+ - setWordWrap()
+ - sign()
+ - smtpClose()
+ - smtpConnect()
+ - stripTrailingBreaks()
+ - stripTrailingWSP()
+ - textLine()
+ - utf8CharBoundary()
+ - validateAddress()
+ - wrapText()
+ - addAnAddress()
+ - addOrEnqueueAnAddress()
+ - attachAll()
+ - cidExists()
+ - doCallback()
+ - edebug()
+ - encodeFile()
+ - endBoundary()
+ - fileIsAccessible()
+ - generateId()
+ - getBoundary()
+ - isPermittedPath()
+ - isShellSafe()
+ - lang()
+ - mailSend()
+ - sendmailSend()
+ - serverHostname()
+ - setError()
+ - setLE()
+ - setMessageType()
+ - smtpSend()
+ - validateEncoding()
+ - getSmtpErrorMessage()
+ - mailPassthru()
diff --git a/classes/PHPMailer-PHPMailer-POP3.html b/classes/PHPMailer-PHPMailer-POP3.html
index ea67f082..6a39380b 100644
--- a/classes/PHPMailer-PHPMailer-POP3.html
+++ b/classes/PHPMailer-PHPMailer-POP3.html
@@ -124,6 +124,7 @@
PHPMailer POP-Before-SMTP Authentication Class.
+
Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication.
- This class does not support APOP authentication.
@@ -185,6 +186,8 @@ If you want a more complete class there are other POP3 classes for PHP available
+
+
Table of Contents
@@ -204,21 +207,21 @@ If you want a more complete class there are other POP3 classes for PHP available
-
- DEBUG_CLIENT
+ DEBUG_CLIENT
= 2
- Debug level to show client -> server and server -> client messages.
-
- DEBUG_OFF
+ DEBUG_OFF
= 0
- Debug level for no output.
-
- DEBUG_SERVER
+ DEBUG_SERVER
= 1
@@ -226,28 +229,28 @@ If you want a more complete class there are other POP3 classes for PHP available
also shows clients connection errors or errors from server
-
- DEFAULT_PORT
+ DEFAULT_PORT
= 110
- Default POP3 port number.
-
- DEFAULT_TIMEOUT
+ DEFAULT_TIMEOUT
= 30
- Default timeout in seconds.
-
- LE
+ LE
= "\r\n"
- Line break constant.
-
- VERSION
+ VERSION
= '6.9.1'
@@ -263,63 +266,63 @@ also shows clients connection errors or errors from server
-
- $do_debug
+ $do_debug
: int
- POP3 class debug output mode.
-
- $host
+ $host
: string
- POP3 mail server hostname.
-
- $password
+ $password
: string
- POP3 password.
-
- $port
+ $port
: int
- POP3 port number.
-
- $tval
+ $tval
: int
- POP3 Timeout Value in seconds.
-
- $username
+ $username
: string
- POP3 username.
-
- $connected
+ $connected
: bool
- Are we connected?
-
- $errors
+ $errors
: array<string|int, mixed>
- Error container.
-
- $pop_conn
+ $pop_conn
: resource
@@ -334,77 +337,77 @@ also shows clients connection errors or errors from server
-
- authorise()
+ authorise()
: bool
- Authenticate with a POP3 server.
-
- connect()
+ connect()
: bool
- Connect to a POP3 server.
-
- disconnect()
+ disconnect()
: mixed
- Disconnect from the POP3 server.
-
- getErrors()
+ getErrors()
: array<string|int, mixed>
- Get an array of error messages, if any.
-
- login()
+ login()
: bool
- Log in to the POP3 server.
-
- popBeforeSmtp()
+ popBeforeSmtp()
: bool
- Simple static wrapper for all-in-one POP before SMTP.
-
- catchWarning()
+ catchWarning()
: mixed
- POP3 connection error handler.
-
- checkResponse()
+ checkResponse()
: bool
- Checks the POP3 server response.
-
- getResponse()
+ getResponse()
: string
- Get a response from the POP3 server.
-
- sendString()
+ sendString()
: int
- Send raw data to the POP3 server.
-
- setError()
+ setError()
: mixed
@@ -414,9 +417,6 @@ also shows clients connection errors or errors from server
-
-
-
@@ -440,6 +440,7 @@ also shows clients connection errors or errors from server
Debug level to show client -> server and server -> client messages.
+
public
int
@@ -452,6 +453,8 @@ also shows clients connection errors or errors from server
+
+
@@ -469,6 +472,7 @@ also shows clients connection errors or errors from server
Debug level for no output.
+
public
int
@@ -481,6 +485,8 @@ also shows clients connection errors or errors from server
+
+
@@ -499,6 +505,7 @@ also shows clients connection errors or errors from server
Debug level to show server -> client messages
also shows clients connection errors or errors from server
+
public
int
@@ -511,6 +518,8 @@ also shows clients connection errors or errors from server
+
+
@@ -528,6 +537,7 @@ also shows clients connection errors or errors from server
Default POP3 port number.
+
public
int
@@ -540,6 +550,8 @@ also shows clients connection errors or errors from server
+
+
@@ -557,6 +569,7 @@ also shows clients connection errors or errors from server
Default timeout in seconds.
+
public
int
@@ -569,6 +582,8 @@ also shows clients connection errors or errors from server
+
+
@@ -586,6 +601,7 @@ also shows clients connection errors or errors from server
Line break constant.
+
public
mixed
@@ -598,6 +614,8 @@ also shows clients connection errors or errors from server
+
+
@@ -615,6 +633,7 @@ also shows clients connection errors or errors from server
The POP3 PHPMailer Version number.
+
public
string
@@ -627,6 +646,8 @@ also shows clients connection errors or errors from server
+
+
@@ -660,6 +681,7 @@ also shows clients connection errors or errors from server
POP3 class debug output mode.
+
public
int
@@ -707,6 +729,8 @@ Options:
+
+
POP3 mail server hostname.
+
public
string
@@ -741,6 +766,8 @@ Options:
+
+
POP3 password.
+
public
string
@@ -775,6 +803,8 @@ Options:
+
+
POP3 port number.
+
public
int
@@ -809,6 +840,8 @@ Options:
+
+
POP3 Timeout Value in seconds.
+
public
int
@@ -843,6 +877,8 @@ Options:
+
+
POP3 username.
+
public
string
@@ -877,6 +914,8 @@ Options:
+
+
Are we connected?
+
protected
bool
@@ -911,6 +951,8 @@ Options:
+
+
Error container.
+
protected
array<string|int, mixed>
@@ -945,6 +988,8 @@ Options:
+
+
Resource handle for the POP3 connection socket.
+
protected
resource
@@ -979,6 +1025,8 @@ Options:
+
+
@@ -1014,6 +1062,7 @@ Options:
+
A connect, login, disconnect sequence
appropriate for POP-before SMTP authorisation.
@@ -1072,6 +1121,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
bool
@@ -1105,6 +1156,7 @@ appropriate for POP-before SMTP authorisation.
+
Parameters
-
@@ -1132,6 +1184,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
bool
@@ -1167,6 +1221,9 @@ appropriate for POP-before SMTP authorisation.
+
+
+
@@ -1199,6 +1256,9 @@ appropriate for POP-before SMTP authorisation.
+
+
+
Return values
@@ -1232,6 +1292,7 @@ appropriate for POP-before SMTP authorisation.
+
Does not support APOP (RFC 2828, 4949).
@@ -1255,6 +1316,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
bool
@@ -1288,6 +1351,7 @@ appropriate for POP-before SMTP authorisation.
+
Parameters
-
@@ -1342,6 +1406,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
bool
@@ -1375,6 +1441,7 @@ appropriate for POP-before SMTP authorisation.
+
Parameters
-
@@ -1410,6 +1477,8 @@ appropriate for POP-before SMTP authorisation.
+
+
+
Looks for for +OK or -ERR.
@@ -1453,6 +1523,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
bool
@@ -1486,6 +1558,7 @@ appropriate for POP-before SMTP authorisation.
+
Parameters
-
@@ -1501,6 +1574,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
string
@@ -1534,6 +1609,7 @@ appropriate for POP-before SMTP authorisation.
+
Parameters
-
@@ -1547,6 +1623,8 @@ appropriate for POP-before SMTP authorisation.
+
+
Return values
int
@@ -1579,6 +1657,7 @@ appropriate for POP-before SMTP authorisation.
+
Also display debug output if it's enabled.
@@ -1596,6 +1675,8 @@ appropriate for POP-before SMTP authorisation.
+
+
@@ -1710,45 +1791,45 @@ appropriate for POP-before SMTP authorisation.
- Constants
-
- - DEBUG_CLIENT
- - DEBUG_OFF
- - DEBUG_SERVER
- - DEFAULT_PORT
- - DEFAULT_TIMEOUT
- - LE
- - VERSION
+ - DEBUG_CLIENT
+ - DEBUG_OFF
+ - DEBUG_SERVER
+ - DEFAULT_PORT
+ - DEFAULT_TIMEOUT
+ - LE
+ - VERSION
- Properties
-
- Methods
-
- - authorise()
- - connect()
- - disconnect()
- - getErrors()
- - login()
- - popBeforeSmtp()
- - catchWarning()
- - checkResponse()
- - getResponse()
- - sendString()
- - setError()
+ - authorise()
+ - connect()
+ - disconnect()
+ - getErrors()
+ - login()
+ - popBeforeSmtp()
+ - catchWarning()
+ - checkResponse()
+ - getResponse()
+ - sendString()
+ - setError()
diff --git a/classes/PHPMailer-PHPMailer-SMTP.html b/classes/PHPMailer-PHPMailer-SMTP.html
index 0af1b308..ff0c0c3c 100644
--- a/classes/PHPMailer-PHPMailer-SMTP.html
+++ b/classes/PHPMailer-PHPMailer-SMTP.html
@@ -124,6 +124,7 @@
PHPMailer RFC821 SMTP email transport class.
+
Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
@@ -172,6 +173,8 @@
+
+
Table of Contents
@@ -191,63 +194,63 @@
-
- DEBUG_CLIENT
+ DEBUG_CLIENT
= 1
- Debug level to show client -> server messages.
-
- DEBUG_CONNECTION
+ DEBUG_CONNECTION
= 3
- Debug level to show connection status, client -> server and server -> client messages.
-
- DEBUG_LOWLEVEL
+ DEBUG_LOWLEVEL
= 4
- Debug level to show all messages.
-
- DEBUG_OFF
+ DEBUG_OFF
= 0
- Debug level for no output.
-
- DEBUG_SERVER
+ DEBUG_SERVER
= 2
- Debug level to show client -> server and server -> client messages.
-
- DEFAULT_PORT
+ DEFAULT_PORT
= 25
- The SMTP port to use if one is not specified.
-
- DEFAULT_SECURE_PORT
+ DEFAULT_SECURE_PORT
= 465
- The SMTPs port to use if one is not specified.
-
- LE
+ LE
= "\r\n"
- SMTP line break constant.
-
- MAX_LINE_LENGTH
+ MAX_LINE_LENGTH
= 998
@@ -255,7 +258,7 @@
*excluding* a trailing CRLF break.
-
- MAX_REPLY_LENGTH
+ MAX_REPLY_LENGTH
= 512
@@ -263,7 +266,7 @@
*including* a trailing CRLF line break.
-
- VERSION
+ VERSION
= '6.9.1'
@@ -279,70 +282,70 @@
-
- $Debugoutput
+ $Debugoutput
: string|callable|LoggerInterface
- How to handle debug output.
-
- $do_debug
+ $do_debug
: int
- Debug output level.
-
- $do_verp
+ $do_verp
: bool
- Whether to use VERP.
-
- $Timelimit
+ $Timelimit
: int
- How long to wait for commands to complete, in seconds.
-
- $Timeout
+ $Timeout
: int
- The timeout value for connection, in seconds.
-
- $xclient_allowed_attributes
+ $xclient_allowed_attributes
: array<string|int, mixed>
- Allowed SMTP XCLIENT attributes.
-
- $error
+ $error
: array<string|int, mixed>
- Error information, if any, for the last SMTP command.
-
- $helo_rply
+ $helo_rply
: string|null
- The reply the server sent to us for HELO.
-
- $last_reply
+ $last_reply
: string
- The most recent reply received from the server.
-
- $last_smtp_transaction_id
+ $last_smtp_transaction_id
: string|bool|null
@@ -350,21 +353,21 @@
if one was detected.
-
- $server_caps
+ $server_caps
: array<string|int, mixed>|null
- The set of SMTP extensions sent in reply to EHLO command.
-
- $smtp_conn
+ $smtp_conn
: resource|null
- The socket for the server connection.
-
- $smtp_transaction_id_patterns
+ $smtp_transaction_id_patterns
: array<string|int, string>
@@ -379,77 +382,77 @@ if one was detected.
-
- authenticate()
+ authenticate()
: bool
- Perform SMTP authentication.
-
- client_send()
+ client_send()
: int|bool
- Send raw data to the server.
-
- close()
+ close()
: mixed
- Close the socket and clean up the state of the class.
-
- connect()
+ connect()
: bool
- Connect to an SMTP server.
-
- connected()
+ connected()
: bool
- Check connection state.
-
- data()
+ data()
: bool
- Send an SMTP DATA command.
-
- getDebugLevel()
+ getDebugLevel()
: int
- Get debug output level.
-
- getDebugOutput()
+ getDebugOutput()
: string
- Get debug output method.
-
- getError()
+ getError()
: array<string|int, mixed>
- Get the latest error.
-
- getLastReply()
+ getLastReply()
: string
- Get the last reply from the server.
-
- getLastTransactionID()
+ getLastTransactionID()
: bool|string|null
@@ -457,182 +460,182 @@ if one was detected.
If no reply has been received yet, it will return null.
-
- getServerExt()
+ getServerExt()
: string|bool|null
- Get metadata about the SMTP server from its HELO/EHLO response.
-
- getServerExtList()
+ getServerExtList()
: array<string|int, mixed>|null
- Get SMTP extensions available on the server.
-
- getTimeout()
+ getTimeout()
: int
- Get SMTP timeout.
-
- getVerp()
+ getVerp()
: bool
- Get VERP address generation mode.
-
- hello()
+ hello()
: bool
- Send an SMTP HELO or EHLO command.
-
- mail()
+ mail()
: bool
- Send an SMTP MAIL command.
-
- noop()
+ noop()
: bool
- Send an SMTP NOOP command.
-
- quit()
+ quit()
: bool
- Send an SMTP QUIT command.
-
- recipient()
+ recipient()
: bool
- Send an SMTP RCPT command.
-
- reset()
+ reset()
: bool
- Send an SMTP RSET command.
-
- sendAndMail()
+ sendAndMail()
: bool
- Send an SMTP SAML command.
-
- setDebugLevel()
+ setDebugLevel()
: mixed
- Set debug output level.
-
- setDebugOutput()
+ setDebugOutput()
: mixed
- Set debug output method.
-
- setTimeout()
+ setTimeout()
: mixed
- Set SMTP timeout.
-
- setVerp()
+ setVerp()
: mixed
- Enable or disable VERP address generation.
-
- startTLS()
+ startTLS()
: bool
- Initiate a TLS (encrypted) session.
-
- turn()
+ turn()
: bool
- Send an SMTP TURN command.
-
- verify()
+ verify()
: bool
- Send an SMTP VRFY command.
-
- xclient()
+ xclient()
: bool
- Send SMTP XCLIENT command to server and check its return code.
-
- edebug()
+ edebug()
: mixed
- Output debugging info via a user-selected method.
-
- errorHandler()
+ errorHandler()
: mixed
- Reports an error number and string.
-
- get_lines()
+ get_lines()
: string
- Read the SMTP server's response.
-
- getSMTPConnection()
+ getSMTPConnection()
: false|resource
- Create connection to the SMTP server.
-
- hmac()
+ hmac()
: string
- Calculate an MD5 HMAC hash.
-
- parseHelloFields()
+ parseHelloFields()
: mixed
- Parse a reply to HELO/EHLO command to discover server extensions.
-
- recordLastTransactionID()
+ recordLastTransactionID()
: bool|string|null
@@ -640,21 +643,21 @@ If no reply has been received yet, it will return null.
a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
-
- sendCommand()
+ sendCommand()
: bool
- Send a command to an SMTP server and check its return code.
-
- sendHello()
+ sendHello()
: bool
- Send an SMTP HELO or EHLO command.
-
- setError()
+ setError()
: mixed
@@ -664,9 +667,6 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
-
-
-
@@ -690,6 +690,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Debug level to show client -> server messages.
+
public
int
@@ -702,6 +703,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -719,6 +722,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Debug level to show connection status, client -> server and server -> client messages.
+
public
int
@@ -731,6 +735,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -748,6 +754,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Debug level to show all messages.
+
public
int
@@ -760,6 +767,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -777,6 +786,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Debug level for no output.
+
public
int
@@ -789,6 +799,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -806,6 +818,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
Debug level to show client -> server and server -> client messages.
+
public
int
@@ -818,6 +831,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -835,6 +850,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
The SMTP port to use if one is not specified.
+
public
int
@@ -847,6 +863,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -864,6 +882,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
The SMTPs port to use if one is not specified.
+
public
int
@@ -876,6 +895,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -893,6 +914,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
SMTP line break constant.
+
public
string
@@ -905,6 +927,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -923,6 +947,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
The maximum line length allowed by RFC 5321 section 4.5.3.1.6,
*excluding* a trailing CRLF break.
+
public
int
@@ -948,7 +973,9 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
-
+
+
+
@@ -968,6 +995,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
The maximum line length allowed for replies in RFC 5321 section 4.5.3.1.5,
*including* a trailing CRLF line break.
+
public
int
@@ -993,7 +1021,9 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
-
+
+
+
@@ -1012,6 +1042,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
The PHPMailer SMTP version number.
+
public
string
@@ -1024,6 +1055,8 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
+
+
@@ -1057,6 +1090,7 @@ a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
How to handle debug output.
+
public
string|callable|LoggerInterface
@@ -1084,6 +1118,8 @@ level output is used:
+
+
Debug output level.
+
public
int
@@ -1127,6 +1164,8 @@ level output is used:
+
+
Whether to use VERP.
+
public
bool
@@ -1186,6 +1226,8 @@ level output is used:
+
+
How long to wait for commands to complete, in seconds.
+
public
int
@@ -1222,6 +1265,8 @@ level output is used:
+
+
The timeout value for connection, in seconds.
+
public
int
@@ -1274,6 +1320,8 @@ This needs to be quite high to function correctly with hosts using greetdelay as
+
+
Allowed SMTP XCLIENT attributes.
+
public
static array<string|int, mixed>
@@ -1325,6 +1374,8 @@ This needs to be quite high to function correctly with hosts using greetdelay as
+
+
Error information, if any, for the last SMTP command.
+
protected
array<string|int, mixed>
@@ -1359,6 +1411,8 @@ This needs to be quite high to function correctly with hosts using greetdelay as
+
+
The reply the server sent to us for HELO.
+
protected
string|null
@@ -1395,6 +1450,8 @@ This needs to be quite high to function correctly with hosts using greetdelay as
+
+
The most recent reply received from the server.
+
protected
string
@@ -1429,6 +1487,8 @@ This needs to be quite high to function correctly with hosts using greetdelay as
+
+
The last transaction ID issued in response to a DATA command,
if one was detected.
+
protected
string|bool|null
@@ -1464,6 +1525,8 @@ if one was detected.
+
+
The set of SMTP extensions sent in reply to EHLO command.
+
protected
array<string|int, mixed>|null
@@ -1504,6 +1568,8 @@ If null, no HELO/EHLO string has yet been received.
+
+
The socket for the server connection.
+
protected
resource|null
@@ -1538,6 +1605,8 @@ If null, no HELO/EHLO string has yet been received.
+
+
Patterns to extract an SMTP transaction id from reply to a DATA command.
+
protected
array<string|int, string>
@@ -1575,6 +1645,8 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
+
@@ -1610,6 +1682,7 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
Must be run after hello().
@@ -1670,6 +1743,8 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
+
Return values
bool
@@ -1707,6 +1782,7 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
Parameters
-
@@ -1731,6 +1807,8 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
+
Return values
int|bool
@@ -1767,6 +1845,7 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
Don't use this function without first trying to use QUIT.
@@ -1789,6 +1868,8 @@ MS ESMTP returns the message ID, which may not be correct for internal tracking.
+
+
+
Parameters
-
@@ -2769,6 +2911,8 @@ Implements RFC 821: SAML <SP> FROM:
<CRLF>.
+
+
+
Parameters
-
@@ -2813,6 +2958,8 @@ Implements RFC 821: SAML <SP> FROM:
<CRLF>.
+
+
+
Parameters
-
@@ -2855,6 +3003,8 @@ Implements RFC 821: SAML <SP> FROM:
<CRLF>.
+
+
Return values
@@ -2918,6 +3071,7 @@ Implements RFC 821: SAML <SP> FROM: <CRLF>.
+
This is an optional command for SMTP that this class does not support.
This method is here to make the RFC821 Definition complete for this class
and may be implemented in future.
@@ -2927,6 +3081,8 @@ Implements from RFC 821: TURN <CRLF>.
+
+
Return values
bool
@@ -2960,6 +3116,7 @@ Implements from RFC 821: TURN <CRLF>.
+
Parameters
-
@@ -2975,6 +3132,8 @@ Implements from RFC 821: TURN <CRLF>.
+
+
Return values
bool
@@ -3008,6 +3167,7 @@ Implements from RFC 821: TURN <CRLF>.
+
Parameters
-
@@ -3021,6 +3181,8 @@ Implements from RFC 821: TURN <CRLF>.
+
+
Return values
bool
@@ -3058,6 +3220,7 @@ Implements from RFC 821: TURN <CRLF>.
+
Parameters
-
@@ -3106,6 +3269,8 @@ Implements from RFC 821: TURN <CRLF>.
+
+
+
Parameters
-
@@ -3177,6 +3343,8 @@ Implements from RFC 821: TURN <CRLF>.
+
+
+
Either before eof or socket timeout occurs on the operation.
With SMTP we can tell if we have more lines to read if the
4th character is '-' symbol. If it is a space then we don't
@@ -3213,6 +3382,8 @@ need to read anything else.
+
+
Return values
string
@@ -3246,6 +3417,7 @@ need to read anything else.
+
Parameters
-
@@ -3288,6 +3460,8 @@ need to read anything else.
+
+
Return values
false|resource
@@ -3320,6 +3494,7 @@ need to read anything else.
+
Works like hash_hmac('md5', $data, $key)
in case that function is not available.
@@ -3348,6 +3523,8 @@ in case that function is not available.
+
+
Return values
string
@@ -3380,6 +3557,7 @@ in case that function is not available.
+
In case of HELO, the only parameter that can be discovered is a server name.
@@ -3399,6 +3577,8 @@ in case that function is not available.
+
+
+
Relies on the host providing the ID in response to a DATA command.
If no reply has been received yet, it will return null.
If no pattern was matched, it will return false.
@@ -3435,6 +3616,8 @@ If no pattern was matched, it will return false.
+
+
Return values
bool|string|null
@@ -3468,6 +3651,7 @@ If no pattern was matched, it will return false.
+
Parameters
-
@@ -3501,6 +3685,8 @@ If no pattern was matched, it will return false.
+
+
Return values
bool
@@ -3537,6 +3723,7 @@ If no pattern was matched, it will return false.
+
Low-level implementation used by hello().
@@ -3579,6 +3766,8 @@ If no pattern was matched, it will return false.
+
+
Return values
bool
@@ -3612,6 +3801,7 @@ If no pattern was matched, it will return false.
+
Parameters
-
@@ -3655,6 +3845,8 @@ If no pattern was matched, it will return false.
+
+
@@ -3769,82 +3961,82 @@ If no pattern was matched, it will return false.
Constants
- - DEBUG_CLIENT
- - DEBUG_CONNECTION
- - DEBUG_LOWLEVEL
- - DEBUG_OFF
- - DEBUG_SERVER
- - DEFAULT_PORT
- - DEFAULT_SECURE_PORT
- - LE
- - MAX_LINE_LENGTH
- - MAX_REPLY_LENGTH
- - VERSION
+ - DEBUG_CLIENT
+ - DEBUG_CONNECTION
+ - DEBUG_LOWLEVEL
+ - DEBUG_OFF
+ - DEBUG_SERVER
+ - DEFAULT_PORT
+ - DEFAULT_SECURE_PORT
+ - LE
+ - MAX_LINE_LENGTH
+ - MAX_REPLY_LENGTH
+ - VERSION
Properties
- - $Debugoutput
- - $do_debug
- - $do_verp
- - $Timelimit
- - $Timeout
- - $xclient_allowed_attributes
- - $error
- - $helo_rply
- - $last_reply
- - $last_smtp_transaction_id
- - $server_caps
- - $smtp_conn
- - $smtp_transaction_id_patterns
+ - $Debugoutput
+ - $do_debug
+ - $do_verp
+ - $Timelimit
+ - $Timeout
+ - $xclient_allowed_attributes
+ - $error
+ - $helo_rply
+ - $last_reply
+ - $last_smtp_transaction_id
+ - $server_caps
+ - $smtp_conn
+ - $smtp_transaction_id_patterns
Methods
- - authenticate()
- - client_send()
- - close()
- - connect()
- - connected()
- - data()
- - getDebugLevel()
- - getDebugOutput()
- - getError()
- - getLastReply()
- - getLastTransactionID()
- - getServerExt()
- - getServerExtList()
- - getTimeout()
- - getVerp()
- - hello()
- - mail()
- - noop()
- - quit()
- - recipient()
- - reset()
- - sendAndMail()
- - setDebugLevel()
- - setDebugOutput()
- - setTimeout()
- - setVerp()
- - startTLS()
- - turn()
- - verify()
- - xclient()
- - edebug()
- - errorHandler()
- - get_lines()
- - getSMTPConnection()
- - hmac()
- - parseHelloFields()
- - recordLastTransactionID()
- - sendCommand()
- - sendHello()
- - setError()
+ - authenticate()
+ - client_send()
+ - close()
+ - connect()
+ - connected()
+ - data()
+ - getDebugLevel()
+ - getDebugOutput()
+ - getError()
+ - getLastReply()
+ - getLastTransactionID()
+ - getServerExt()
+ - getServerExtList()
+ - getTimeout()
+ - getVerp()
+ - hello()
+ - mail()
+ - noop()
+ - quit()
+ - recipient()
+ - reset()
+ - sendAndMail()
+ - setDebugLevel()
+ - setDebugOutput()
+ - setTimeout()
+ - setVerp()
+ - startTLS()
+ - turn()
+ - verify()
+ - xclient()
+ - edebug()
+ - errorHandler()
+ - get_lines()
+ - getSMTPConnection()
+ - hmac()
+ - parseHelloFields()
+ - recordLastTransactionID()
+ - sendCommand()
+ - sendHello()
+ - setError()
diff --git a/css/base.css b/css/base.css
index 192607a8..030ba075 100644
--- a/css/base.css
+++ b/css/base.css
@@ -1216,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration.
word-break: break-all;
line-height: normal;
}
+
+ .phpdocumentor-on-this-page__content li.-deprecated {
+ text-decoration: line-through;
+ }
}
/* Used for screen readers and such */
diff --git a/css/template.css b/css/template.css
index 898b676c..875ebaff 100644
--- a/css/template.css
+++ b/css/template.css
@@ -126,6 +126,10 @@
flex: 0 1 auto;
}
+.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated {
+ text-decoration: line-through;
+}
+
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span {
flex: 1;
white-space: nowrap;
diff --git a/files/src-dsnconfigurator.html b/files/src-dsnconfigurator.html
index e4298f91..7b3c8c07 100644
--- a/files/src-dsnconfigurator.html
+++ b/files/src-dsnconfigurator.html
@@ -98,6 +98,7 @@
PHPMailer - PHP email creation and transport class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-exception.html b/files/src-exception.html
index 515c5858..da1bd071 100644
--- a/files/src-exception.html
+++ b/files/src-exception.html
@@ -98,6 +98,7 @@
PHPMailer Exception class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-oauth.html b/files/src-oauth.html
index c4b637d6..45224e82 100644
--- a/files/src-oauth.html
+++ b/files/src-oauth.html
@@ -98,6 +98,7 @@
PHPMailer - PHP email creation and transport class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-oauthtokenprovider.html b/files/src-oauthtokenprovider.html
index 9dd28f73..b41c0766 100644
--- a/files/src-oauthtokenprovider.html
+++ b/files/src-oauthtokenprovider.html
@@ -98,6 +98,7 @@
PHPMailer - PHP email creation and transport class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-phpmailer.html b/files/src-phpmailer.html
index 70c91069..6d25df9c 100644
--- a/files/src-phpmailer.html
+++ b/files/src-phpmailer.html
@@ -98,6 +98,7 @@
PHPMailer - PHP email creation and transport class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-pop3.html b/files/src-pop3.html
index 27a60e76..fb67519f 100644
--- a/files/src-pop3.html
+++ b/files/src-pop3.html
@@ -98,6 +98,7 @@
PHPMailer POP-Before-SMTP Authentication Class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents
diff --git a/files/src-smtp.html b/files/src-smtp.html
index 26909582..be3f885c 100644
--- a/files/src-smtp.html
+++ b/files/src-smtp.html
@@ -98,6 +98,7 @@
PHPMailer RFC821 SMTP email transport class.
+
PHP Version 5.5.
@@ -205,6 +206,8 @@ FITNESS FOR A PARTICULAR PURPOSE.
+
+
Table of Contents