Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe PHPMailer
+ Graphe d'héritage de PHPMailer:

Fonctions membres publiques

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

Fonctions membres publiques statiques

static parseAddresses ($addrstr, $useimap=true, $charset=self::CHARSET_ISO88591)
 
static validateAddress ($address, $patternselect=null)
 
static idnSupported ()
 
static rfcDate ()
 
static isValidHost ($host)
 
static _mime_types ($ext='')
 
static filenameToType ($filename)
 
static mb_pathinfo ($path, $options=null)
 
static normalizeBreaks ($text, $breaktype=null)
 
static stripTrailingWSP ($text)
 
static getLE ()
 
static hasLineLongerThanMax ($str)
 
static quotedString ($str)
 

Champs de données

const CHARSET_ASCII = 'us-ascii'
 
const CHARSET_ISO88591 = 'iso-8859-1'
 
const CHARSET_UTF8 = 'utf-8'
 
const CONTENT_TYPE_PLAINTEXT = 'text/plain'
 
const CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'
 
const CONTENT_TYPE_TEXT_HTML = 'text/html'
 
const CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'
 
const CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'
 
const CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'
 
const ENCODING_7BIT = '7bit'
 
const ENCODING_8BIT = '8bit'
 
const ENCODING_BASE64 = 'base64'
 
const ENCODING_BINARY = 'binary'
 
const ENCODING_QUOTED_PRINTABLE = 'quoted-printable'
 
const ENCRYPTION_STARTTLS = 'tls'
 
const ENCRYPTION_SMTPS = 'ssl'
 
const ICAL_METHOD_REQUEST = 'REQUEST'
 
const ICAL_METHOD_PUBLISH = 'PUBLISH'
 
const ICAL_METHOD_REPLY = 'REPLY'
 
const ICAL_METHOD_ADD = 'ADD'
 
const ICAL_METHOD_CANCEL = 'CANCEL'
 
const ICAL_METHOD_REFRESH = 'REFRESH'
 
const ICAL_METHOD_COUNTER = 'COUNTER'
 
const ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'
 
 $Priority
 
 $CharSet = self::CHARSET_ISO88591
 
 $ContentType = self::CONTENT_TYPE_PLAINTEXT
 
 $Encoding = self::ENCODING_8BIT
 
 $ErrorInfo = ''
 
 $From = ''
 
 $FromName = ''
 
 $Sender = ''
 
 $Subject = ''
 
 $Body = ''
 
 $AltBody = ''
 
 $Ical = ''
 
 $WordWrap = 0
 
 $Mailer = 'mail'
 
 $Sendmail = '/usr/sbin/sendmail'
 
 $UseSendmailOptions = true
 
 $ConfirmReadingTo = ''
 
 $Hostname = ''
 
 $MessageID = ''
 
 $MessageDate = ''
 
 $Host = 'localhost'
 
 $Port = 25
 
 $Helo = ''
 
 $SMTPSecure = ''
 
 $SMTPAutoTLS = true
 
 $SMTPAuth = false
 
 $SMTPOptions = []
 
 $Username = ''
 
 $Password = ''
 
 $AuthType = ''
 
 $Timeout = 300
 
 $dsn = ''
 
 $SMTPDebug = 0
 
 $Debugoutput = 'echo'
 
 $SMTPKeepAlive = false
 
 $SingleTo = false
 
 $do_verp = false
 
 $AllowEmpty = false
 
 $DKIM_selector = ''
 
 $DKIM_identity = ''
 
 $DKIM_passphrase = ''
 
 $DKIM_domain = ''
 
 $DKIM_copyHeaderFields = true
 
 $DKIM_extraHeaders = []
 
 $DKIM_private = ''
 
 $DKIM_private_string = ''
 
 $action_function = ''
 
 $XMailer = ''
 
const VERSION = '6.6.0'
 
const STOP_MESSAGE = 0
 
const STOP_CONTINUE = 1
 
const STOP_CRITICAL = 2
 
const CRLF = "\r\n"
 
const FWS = ' '
 
const MAIL_MAX_LINE_LENGTH = 63
 
const MAX_LINE_LENGTH = 998
 
const STD_LINE_LENGTH = 76
 

Attributs publics statiques

static $validator = 'php'
 

Fonctions membres protégées

 edebug ($str)
 
 addOrEnqueueAnAddress ($kind, $address, $name)
 
 addAnAddress ($kind, $address, $name='')
 
 sendmailSend ($header, $body)
 
 mailSend ($header, $body)
 
 smtpSend ($header, $body)
 
 generateId ()
 
 getBoundary ($boundary, $charSet, $contentType, $encoding)
 
 endBoundary ($boundary)
 
 setMessageType ()
 
 attachAll ($disposition_type, $boundary)
 
 encodeFile ($path, $encoding=self::ENCODING_BASE64)
 
 validateEncoding ($encoding)
 
 cidExists ($cid)
 
 setError ($msg)
 
 serverHostname ()
 
 lang ($key)
 
 doCallback ($isSent, $to, $cc, $bcc, $subject, $body, $from, $extra)
 

Fonctions membres protégées statiques

static isShellSafe ($string)
 
static isPermittedPath ($path)
 
static fileIsAccessible ($path)
 
static setLE ($le)
 

Attributs protégés

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

Attributs protégés statiques

static $IcalMethods
 
static $LE = self::CRLF
 

Fonctions membres privées

 mailPassthru ($to, $subject, $body, $header, $params)
 
 getSmtpErrorMessage ($base_key)
 

Description détaillée

PHPMailer - PHP email creation and transport class.

Auteur
Marcus Bointon (Synchro/coolbru) phpma.nosp@m.iler.nosp@m.@sync.nosp@m.hrom.nosp@m.edia..nosp@m.co.u.nosp@m.k
Jim Jagielski (jimjag) jimja.nosp@m.g@gm.nosp@m.ail.c.nosp@m.om
Andy Prevost (codeworxtech) codew.nosp@m.orxt.nosp@m.ech@u.nosp@m.sers.nosp@m..sour.nosp@m.cefo.nosp@m.rge.n.nosp@m.et
Brent R. Matzelle (original founder)

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $exceptions = null)

Constructor.

Paramètres
bool$exceptionsShould we throw external exceptions?

Références PHPMailer\$exceptions, et null.

◆ __destruct()

__destruct ( )

Destructor.

Références PHPMailer\smtpClose().

Documentation des fonctions membres

◆ _mime_types()

static _mime_types (   $ext = '')
static

Get the MIME type for a file extension.

Paramètres
string$extFile extension
Renvoie
string MIME type of file

◆ addAddress()

addAddress (   $address,
  $name = '' 
)

Add a "To" address.

Paramètres
string$addressThe email address to send to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, et PHPMailer\addOrEnqueueAnAddress().

◆ addAnAddress()

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

Add an address to one of the recipient arrays or to the ReplyTo array. Addresses that have been added already return false, but do not throw exceptions.

Paramètres
string$kindOne of 'to', 'cc', 'bcc', or 'ReplyTo'
string$addressThe email address to send, resp. to reply to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, PHPMailer\edebug(), elseif, PHPMailer\lang(), et PHPMailer\setError().

◆ addAttachment()

addAttachment (   $path,
  $name = '',
  $encoding = self::ENCODING_BASE64,
  $type = '',
  $disposition = 'attachment' 
)

Add an attachment from a path on the filesystem. Never use a user-supplied path to a file! Returns false if the file could not be found or read. Explicitly does not support passing URLs; PHPMailer is not an HTTP client. If you need to do that, fetch the resource yourself and pass it in via a local file or string.

Paramètres
string$pathPath to the attachment
string$nameOverrides the attachment name
string$encodingFile encoding (see $Encoding)
string$typeMIME type, e.g. image/jpeg; determined automatically from $path if not specified
string$dispositionDisposition to use
Exceptions
Exception
Renvoie
bool

Références $name, $path, $type, PHPMailer\edebug(), PHPMailer\lang(), PHPMailer\setError(), et PHPMailer\validateEncoding().

◆ addBCC()

addBCC (   $address,
  $name = '' 
)

Add a "BCC" address.

Paramètres
string$addressThe email address to send to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, et PHPMailer\addOrEnqueueAnAddress().

◆ addCC()

addCC (   $address,
  $name = '' 
)

Add a "CC" address.

Paramètres
string$addressThe email address to send to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, et PHPMailer\addOrEnqueueAnAddress().

◆ addCustomHeader()

addCustomHeader (   $name,
  $value = null 
)

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

Paramètres
string$nameCustom header name
string | null$valueHeader value
Exceptions
Exception

Références $name, $value, PHPMailer\lang(), et null.

◆ addEmbeddedImage()

addEmbeddedImage (   $path,
  $cid,
  $name = '',
  $encoding = self::ENCODING_BASE64,
  $type = '',
  $disposition = 'inline' 
)

Add an embedded (inline) attachment from a file. This can include images, sounds, and just about any other document type. These differ from 'regular' attachments in that they are intended to be displayed inline with the message, not just attached for download. This is used in HTML messages that embed the images the HTML refers to using the $cid value. Never use a user-supplied path to a file!

Paramètres
string$pathPath to the attachment
string$cidContent ID of the attachment; Use this to reference the content when using an embedded image in HTML
string$nameOverrides the attachment name
string$encodingFile encoding (see $Encoding)
string$typeFile MIME type
string$dispositionDisposition to use
Exceptions
Exception
Renvoie
bool True on successfully adding an attachment

Références $name, $path, $type, PHPMailer\edebug(), PHPMailer\lang(), PHPMailer\setError(), et PHPMailer\validateEncoding().

Référencé par PHPMailer\msgHTML().

◆ addOrEnqueueAnAddress()

addOrEnqueueAnAddress (   $kind,
  $address,
  $name 
)
protected

Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still be modified after calling this function), addition of such addresses is delayed until send(). Addresses that have been added already return false, but do not throw exceptions.

Paramètres
string$kindOne of 'to', 'cc', 'bcc', or 'ReplyTo'
string$addressThe email address to send, resp. to reply to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, $params, $this, PHPMailer\edebug(), elseif, PHPMailer\has8bitChars(), PHPMailer\lang(), et PHPMailer\setError().

Référencé par PHPMailer\addAddress(), PHPMailer\addBCC(), PHPMailer\addCC(), et PHPMailer\addReplyTo().

◆ addrAppend()

addrAppend (   $type,
  $addr 
)

Create recipient headers.

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

Références $type, et PHPMailer\addrFormat().

Référencé par PHPMailer\createHeader().

◆ addReplyTo()

addReplyTo (   $address,
  $name = '' 
)

Add a "Reply-To" address.

Paramètres
string$addressThe email address to reply to
string$name
Exceptions
Exception
Renvoie
bool true on success, false if address already used or invalid in some way

Références $name, et PHPMailer\addOrEnqueueAnAddress().

◆ addrFormat()

addrFormat (   $addr)

Format an address for use in a message header.

Paramètres
array$addrA 2-element indexed array, element 0 containing an address, element 1 containing a name like ['joe@e.nosp@m.xamp.nosp@m.le.co.nosp@m.m', 'Joe User']
Renvoie
string

Références PHPMailer\encodeHeader(), et PHPMailer\secureHeader().

Référencé par PHPMailer\addrAppend(), PHPMailer\createHeader(), et PHPMailer\mailSend().

◆ addStringAttachment()

addStringAttachment (   $string,
  $filename,
  $encoding = self::ENCODING_BASE64,
  $type = '',
  $disposition = 'attachment' 
)

Add a string or binary attachment (non-filesystem). This method can be used to attach ascii or binary data, such as a BLOB record from a database.

Paramètres
string$stringString attachment data
string$filenameName of the attachment
string$encodingFile encoding (see $Encoding)
string$typeFile extension (MIME) type
string$dispositionDisposition to use
Exceptions
Exception
Renvoie
bool True on successfully adding an attachment

Références $type, PHPMailer\edebug(), PHPMailer\lang(), PHPMailer\setError(), et PHPMailer\validateEncoding().

◆ addStringEmbeddedImage()

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

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

Paramètres
string$stringThe attachment binary data
string$cidContent ID of the attachment; Use this to reference the content when using an embedded image in HTML
string$nameA filename for the attachment. If this contains an extension, PHPMailer will attempt to set a MIME type for the attachment. For example 'file.jpg' would get an 'image/jpeg' MIME type.
string$encodingFile encoding (see $Encoding), defaults to 'base64'
string$typeMIME type - will be used in preference to any automatically derived type
string$dispositionDisposition to use
Exceptions
Exception
Renvoie
bool True on successfully adding an attachment

Références $name, $type, PHPMailer\edebug(), PHPMailer\lang(), PHPMailer\setError(), et PHPMailer\validateEncoding().

Référencé par PHPMailer\msgHTML().

◆ alternativeExists()

alternativeExists ( )

Check if this message has an alternative body set.

Renvoie
bool

Référencé par PHPMailer\msgHTML(), et PHPMailer\setMessageType().

◆ attachAll()

attachAll (   $disposition_type,
  $boundary 
)
protected

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

Paramètres
string$disposition_type
string$boundary
Exceptions
Exception
Renvoie
string

Références PHPMailer\$attachment, PHPMailer\$boundary, $name, $path, $type, PHPMailer\encodeFile(), PHPMailer\encodeHeader(), PHPMailer\encodeString(), PHPMailer\isError(), et PHPMailer\secureHeader().

Référencé par PHPMailer\createBody().

◆ attachmentExists()

attachmentExists ( )

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

Renvoie
bool

Références PHPMailer\$attachment.

Référencé par PHPMailer\setMessageType().

◆ base64EncodeWrapMB()

base64EncodeWrapMB (   $str,
  $linebreak = null 
)

Encode and wrap long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid.

Voir également
http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
Paramètres
string$strmulti-byte text to wrap encode
string$linebreakstring to use as linefeed/end-of-line
Renvoie
string

Références $i, Joomla\Database\Query\$offset, $start, et null.

Référencé par PHPMailer\encodeHeader().

◆ cidExists()

cidExists (   $cid)
protected

Check if an embedded attachment is present with this cid.

Paramètres
string$cid
Renvoie
bool

Références PHPMailer\$attachment.

Référencé par PHPMailer\msgHTML().

◆ clearAddresses()

clearAddresses ( )

Clear all To recipients.

Références PHPMailer\$to, et PHPMailer\clearQueuedAddresses().

◆ clearAllRecipients()

clearAllRecipients ( )

Clear all recipient types.

◆ clearAttachments()

clearAttachments ( )

Clear all filesystem, string, and binary attachments.

◆ clearBCCs()

clearBCCs ( )

Clear all BCC recipients.

Références PHPMailer\$bcc, et PHPMailer\clearQueuedAddresses().

◆ clearCCs()

clearCCs ( )

Clear all CC recipients.

Références PHPMailer\$cc, et PHPMailer\clearQueuedAddresses().

◆ clearCustomHeaders()

clearCustomHeaders ( )

Clear all custom headers.

◆ clearQueuedAddresses()

clearQueuedAddresses (   $kind)

Clear queued addresses of given kind.

Paramètres
string$kind'to', 'cc', or 'bcc'

Références $params.

Référencé par PHPMailer\clearAddresses(), PHPMailer\clearBCCs(), et PHPMailer\clearCCs().

◆ clearReplyTos()

clearReplyTos ( )

Clear all ReplyTo recipients.

◆ createBody()

◆ createHeader()

◆ DKIM_Add()

DKIM_Add (   $headers_line,
  $subject,
  $body 
)

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

Paramètres
string$headers_lineHeader lines
string$subjectSubject
string$bodyBody
Exceptions
Exception
Renvoie
string

Références $header, $subject, PHPMailer\DKIM_BodyC(), PHPMailer\DKIM_HeaderC(), PHPMailer\DKIM_QP(), PHPMailer\DKIM_Sign(), et elseif.

◆ DKIM_BodyC()

DKIM_BodyC (   $body)

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

Voir également
https://tools.ietf.org/html/rfc6376#section-3.4.3
Paramètres
string$bodyMessage Body
Renvoie
string

Référencé par PHPMailer\DKIM_Add().

◆ DKIM_HeaderC()

DKIM_HeaderC (   $signHeader)

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

Voir également
https://tools.ietf.org/html/rfc6376#section-3.4.2
Paramètres
string$signHeaderHeader
Renvoie
string

Références $heading, $key, et $value.

Référencé par PHPMailer\DKIM_Add().

◆ DKIM_QP()

DKIM_QP (   $txt)

Quoted-Printable-encode a DKIM header.

Paramètres
string$txt
Renvoie
string

Références $i.

Référencé par PHPMailer\DKIM_Add().

◆ DKIM_Sign()

DKIM_Sign (   $signHeader)

Generate a DKIM signature.

Paramètres
string$signHeader
Exceptions
Exception
Renvoie
string The DKIM signature value

Références PHPMailer\lang().

Référencé par PHPMailer\DKIM_Add().

◆ doCallback()

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

Perform a callback.

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

Références PHPMailer\$bcc, PHPMailer\$cc, $subject, et PHPMailer\$to.

Référencé par PHPMailer\mailSend(), et PHPMailer\smtpSend().

◆ edebug()

edebug (   $str)
protected

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

Voir également
PHPMailer::$Debugoutput
PHPMailer::$SMTPDebug
Paramètres
string$str

ForgottenDebugOutputInspection

Références ENT_QUOTES.

Référencé par PHPMailer\addAnAddress(), PHPMailer\addAttachment(), PHPMailer\addEmbeddedImage(), PHPMailer\addOrEnqueueAnAddress(), PHPMailer\addStringAttachment(), PHPMailer\addStringEmbeddedImage(), PHPMailer\encodeFile(), PHPMailer\mailPassthru(), et PHPMailer\smtpConnect().

◆ encodeFile()

encodeFile (   $path,
  $encoding = self::ENCODING_BASE64 
)
protected

Encode a file attachment in requested format. Returns an empty string on failure.

Paramètres
string$pathThe full path to the file
string$encodingThe encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
Renvoie
string

Références $path, PHPMailer\edebug(), PHPMailer\encodeString(), PHPMailer\lang(), et PHPMailer\setError().

Référencé par PHPMailer\attachAll().

◆ encodeHeader()

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

Encode a header value (not including its label) optimally. Picks shortest of Q, B, or none. Result includes folding if needed. See RFC822 definitions for phrase, comment and text positions.

Paramètres
string$strThe header value to encode
string$positionWhat context the string will be used in
Renvoie
string

Références PHPMailer\$CharSet, $position, PHPMailer\base64EncodeWrapMB(), elseif, PHPMailer\encodeQ(), PHPMailer\has8bitChars(), PHPMailer\hasMultiBytes(), et PHPMailer\wrapText().

Référencé par PHPMailer\addrFormat(), PHPMailer\attachAll(), PHPMailer\createHeader(), et PHPMailer\mailPassthru().

◆ encodeQ()

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

Encode a string using Q encoding.

Voir également
http://tools.ietf.org/html/rfc2047#section-4.2
Paramètres
string$strthe text to encode
string$positionWhere the text is going to be used, see the RFC for what that means
Renvoie
string

Références $position.

Référencé par PHPMailer\encodeHeader().

◆ encodeQP()

encodeQP (   $string)

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

Paramètres
string$stringThe text to encode
Renvoie
string

Référencé par PHPMailer\encodeString().

◆ encodeString()

encodeString (   $str,
  $encoding = self::ENCODING_BASE64 
)

Encode a string in requested format. Returns an empty string on failure.

Paramètres
string$strThe text to encode
string$encodingThe encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
Exceptions
Exception
Renvoie
string

Références PHPMailer\encodeQP(), PHPMailer\lang(), et PHPMailer\setError().

Référencé par PHPMailer\attachAll(), PHPMailer\createBody(), et PHPMailer\encodeFile().

◆ endBoundary()

endBoundary (   $boundary)
protected

Return the end of a message boundary.

Paramètres
string$boundary
Renvoie
string

Références PHPMailer\$boundary.

Référencé par PHPMailer\createBody().

◆ fileIsAccessible()

static fileIsAccessible (   $path)
staticprotected

Check whether a file path is safe, accessible, and readable.

Paramètres
string$pathA relative or absolute path to a file
Renvoie
bool

Références $path.

◆ filenameToType()

static filenameToType (   $filename)
static

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

Paramètres
string$filenameA file name or full path, does not need to exist as a file
Renvoie
string

◆ generateId()

generateId ( )
protected

Create a unique ID to use for boundaries.

Renvoie
string

CryptographicallySecureRandomnessInspection

Références elseif.

Référencé par PHPMailer\createBody().

◆ getAllRecipientAddresses()

getAllRecipientAddresses ( )

Allows for public read access to 'all_recipients' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Renvoie
array

Références PHPMailer\$all_recipients.

◆ getAttachments()

getAttachments ( )

Return the array of attachments.

Renvoie
array

Références PHPMailer\$attachment.

◆ getBccAddresses()

getBccAddresses ( )

Allows for public read access to 'bcc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Renvoie
array

Références PHPMailer\$bcc.

◆ getBoundary()

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

Return the start of a message boundary.

Paramètres
string$boundary
string$charSet
string$contentType
string$encoding
Renvoie
string

Références PHPMailer\$boundary, PHPMailer\$CharSet, PHPMailer\$ContentType, PHPMailer\$Encoding, $result, PHPMailer\headerLine(), et PHPMailer\textLine().

Référencé par PHPMailer\createBody().

◆ getCcAddresses()

getCcAddresses ( )

Allows for public read access to 'cc' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Renvoie
array

Références PHPMailer\$cc.

◆ getCustomHeaders()

getCustomHeaders ( )

Returns all custom headers.

Renvoie
array

Références PHPMailer\$CustomHeader.

◆ getLastMessageID()

getLastMessageID ( )

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

Renvoie
string

◆ getLE()

static getLE ( )
static

Return the current line break format string.

Renvoie
string

◆ getMailMIME()

getMailMIME ( )

Get the message MIME type headers.

Renvoie
string

Références $result, PHPMailer\headerLine(), et PHPMailer\textLine().

Référencé par PHPMailer\createBody(), et PHPMailer\createHeader().

◆ getOAuth()

getOAuth ( )

Get the OAuthTokenProvider instance.

Renvoie
OAuthTokenProvider

Références PHPMailer\$oauth.

◆ getReplyToAddresses()

getReplyToAddresses ( )

Allows for public read access to 'ReplyTo' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Renvoie
array

Références PHPMailer\$ReplyTo.

◆ getSentMIMEMessage()

getSentMIMEMessage ( )

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

Voir également
PHPMailer::preSend()
Renvoie
string

Références PHPMailer\$MIMEBody.

◆ getSmtpErrorMessage()

getSmtpErrorMessage (   $base_key)
private

Build an error message starting with a generic one and adding details if possible.

Paramètres
string$base_key
Renvoie
string

Références $message, et PHPMailer\lang().

Référencé par PHPMailer\smtpConnect().

◆ getSMTPInstance()

getSMTPInstance ( )

Get an instance to use for SMTP operations. Override this function to load your own SMTP implementation, or set one with setSMTPInstance.

Renvoie
SMTP

Références PHPMailer\$smtp.

Référencé par PHPMailer\smtpConnect().

◆ getToAddresses()

getToAddresses ( )

Allows for public read access to 'to' property. Before the send() call, queued addresses (i.e. with IDN) are not yet included.

Renvoie
array

Références PHPMailer\$to.

◆ getTranslations()

getTranslations ( )

Get the array of strings for the current language.

Renvoie
array

Références PHPMailer\$language, language, et PHPMailer\setLanguage().

◆ has8bitChars()

has8bitChars (   $text)

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

Paramètres
string$text
Renvoie
bool

Références $text.

Référencé par PHPMailer\addOrEnqueueAnAddress(), PHPMailer\createBody(), et PHPMailer\encodeHeader().

◆ hasLineLongerThanMax()

static hasLineLongerThanMax (   $str)
static

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

Paramètres
string$str
Renvoie
bool

◆ hasMultiBytes()

hasMultiBytes (   $str)

Check if a string contains multi-byte characters.

Paramètres
string$strmulti-byte text to wrap encode
Renvoie
bool

Référencé par PHPMailer\encodeHeader().

◆ headerLine()

headerLine (   $name,
  $value 
)

Format a header line.

Paramètres
string$name
string | int$value
Renvoie
string

Références $name, et $value.

Référencé par PHPMailer\createBody(), PHPMailer\createHeader(), PHPMailer\getBoundary(), et PHPMailer\getMailMIME().

◆ html2text()

html2text (   $html,
  $advanced = false 
)

Convert an HTML string into plain text. This is used by msgHTML(). Note - older versions of this function used a bundled advanced converter which was removed for license reasons in #232. Example usage:

//Use default conversion
$plain = $mail->html2text($html);
//Use your own custom converter
$plain = $mail->html2text($html, function($html) {
$converter = new MyHtml2text($html);
return $converter->get_text();
});
Paramètres
string$htmlThe HTML text to convert
bool | callable$advancedAny boolean value to use the internal converter, or provide your own callable for custom conversion. Never pass user-supplied data into this parameter
Renvoie
string

Références $html, et ENT_QUOTES.

Référencé par PHPMailer\msgHTML().

◆ idnSupported()

static idnSupported ( )
static

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

Renvoie
bool true if required functions for IDN support are present

◆ inlineImageExists()

inlineImageExists ( )

Check if an inline attachment is present.

Renvoie
bool

Références PHPMailer\$attachment.

Référencé par PHPMailer\setMessageType().

◆ isError()

isError ( )

Check if an error occurred.

Renvoie
bool True if an error did occur

Référencé par PHPMailer\attachAll(), et PHPMailer\createBody().

◆ isHTML()

isHTML (   $isHtml = true)

Sets message type to HTML or plain.

Paramètres
bool$isHtmlTrue for HTML mode

Référencé par PHPMailer\msgHTML().

◆ isMail()

isMail ( )

Send messages using PHP's mail() function.

Référencé par Mail\useSendmail(), et Mail\useSmtp().

◆ isPermittedPath()

static isPermittedPath (   $path)
staticprotected

Check whether a file path is of a permitted type. Used to reject URLs and phar files from functions that access local file paths, such as addAttachment.

Paramètres
string$pathA relative or absolute path to a file
Renvoie
bool

Références $path.

◆ isQmail()

isQmail ( )

Send messages using qmail.

◆ isSendmail()

isSendmail ( )

Send messages using $Sendmail.

◆ isShellSafe()

static isShellSafe (   $string)
staticprotected

Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters. Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.

Voir également
https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report
Paramètres
string$stringThe string to be validated
Renvoie
bool

◆ isSMTP()

isSMTP ( )

Send messages using SMTP.

Référencé par Mail\useSmtp().

◆ isValidHost()

static isValidHost (   $host)
static

Validate whether a string contains a valid value to use as a hostname or IP address. IPv6 addresses must include [], e.g. [::1], not just ::1.

Paramètres
string$hostThe host name or IP address to check
Renvoie
bool

◆ lang()

◆ mailPassthru()

mailPassthru (   $to,
  $subject,
  $body,
  $header,
  $params 
)
private

Call mail() in a safe_mode-aware fashion. Also, unless sendmail_path points to sendmail (or something that claims to be sendmail), don't pass params (not a perfect fix, but it will do).

Paramètres
string$toTo
string$subjectSubject
string$bodyMessage Body
string$headerAdditional Header(s)
string | null$paramsParams
Renvoie
bool

Références $header, $params, $result, $subject, PHPMailer\$to, PHPMailer\edebug(), PHPMailer\encodeHeader(), null, et PHPMailer\secureHeader().

Référencé par PHPMailer\mailSend().

◆ mailSend()

mailSend (   $header,
  $body 
)
protected

Send mail using the PHP mail() function.

Voir également
http://www.php.net/manual/en/book.mail.php
Paramètres
string$headerThe message headers
string$bodyThe message body
Exceptions
Exception
Renvoie
bool

Références $header, $params, $result, PHPMailer\$to, PHPMailer\addrFormat(), PHPMailer\doCallback(), PHPMailer\lang(), PHPMailer\mailPassthru(), et null.

◆ mb_pathinfo()

static mb_pathinfo (   $path,
  $options = null 
)
static

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

Voir également
http://www.php.net/manual/en/function.pathinfo.php#107461
Paramètres
string$pathA filename or path, does not need to exist as a file
int | string$optionsEither a PATHINFO_* constant, or a string name to return only the specified piece
Renvoie
string|array

Références $options, et $path.

◆ msgHTML()

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

Create a message body from an HTML string. Automatically inlines images and creates a plain-text version by converting the HTML, overwriting any existing values in Body and AltBody. Do not source $message content from user input! $basedir is prepended when handling relative URLs, e.g.

and must not be empty will look for an image file in $basedir/images/a.png and convert it to inline. If you don't provide a $basedir, relative paths will be left untouched (and thus probably break in email) Converts data-uri images into embedded attachments. If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.

Paramètres
string$messageHTML message string
string$basedirAbsolute path to a base directory to prepend to relative paths to images
bool | callable$advancedWhether to use the internal HTML to text converter or your own custom converter
Renvoie
string The transformed message body
Exceptions
Exception
Voir également
PHPMailer::html2text()

Références PHPMailer\$Body, $data, $images, $message, $url, PHPMailer\addEmbeddedImage(), PHPMailer\addStringEmbeddedImage(), PHPMailer\alternativeExists(), PHPMailer\cidExists(), elseif, PHPMailer\html2text(), et PHPMailer\isHTML().

◆ normalizeBreaks()

static normalizeBreaks (   $text,
  $breaktype = null 
)
static

Normalize line breaks in a string. Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format. Defaults to CRLF (for message bodies) and preserves consecutive breaks.

Paramètres
string$text
string$breaktypeWhat kind of line break to use; defaults to static::$LE
Renvoie
string

Références $text, et null.

◆ parseAddresses()

static parseAddresses (   $addrstr,
  $useimap = true,
  $charset = self::CHARSET_ISO88591 
)
static

Parse and validate a string containing one or more RFC822-style comma-separated email addresses of the form "display name <address>" into an array of name/address pairs. Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available. Note that quotes in the name part are removed.

Voir également
http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation
Paramètres
string$addrstrThe address list string
bool$useimapWhether to use the IMAP extension to parse the list
string$charsetThe charset to use when decoding the address list string.
Renvoie
array

Références $list, et $name.

◆ postSend()

postSend ( )

Actually send a message via the selected mechanism.

Exceptions
Exception
Renvoie
bool

◆ preSend()

preSend ( )

Prepare a message for sending.

Exceptions
Exception
Renvoie
bool

◆ punyencodeAddress()

punyencodeAddress (   $address)

Converts IDN in given email address to its ASCII form, also known as punycode, if possible. Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet. This function silently returns unmodified address if:

  • No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form)
  • Conversion to punycode is impossible (e.g. required PHP functions are not available) or fails for any reason (e.g. domain contains characters not allowed in an IDN).
Voir également
PHPMailer::$CharSet
Paramètres
string$addressThe email address to convert
Renvoie
string The encoded address in ASCII form

◆ quotedString()

static quotedString (   $str)
static

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

Paramètres
string$str
Renvoie
string
Voir également
RFC822 3.4.1

◆ rfcDate()

static rfcDate ( )
static

Return an RFC 822 formatted date.

Renvoie
string

◆ secureHeader()

secureHeader (   $str)

Strip newlines to prevent header injection.

Paramètres
string$str
Renvoie
string

Référencé par PHPMailer\addrFormat(), PHPMailer\attachAll(), PHPMailer\createHeader(), et PHPMailer\mailPassthru().

◆ send()

send ( )

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

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

◆ sendmailSend()

sendmailSend (   $header,
  $body 
)
protected

Send mail using the $Sendmail program.

Voir également
PHPMailer::$Sendmail
Paramètres
string$headerThe message headers
string$bodyThe message body
Exceptions
Exception
Renvoie
bool

Références $header.

◆ serverHostname()

serverHostname ( )
protected

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

Renvoie
string

Références PHPMailer\$Hostname, $result, et elseif.

Référencé par PHPMailer\createHeader(), et PHPMailer\smtpConnect().

◆ set()

set (   $name,
  $value = '' 
)

Set or reset instance properties. You should avoid this function - it's more verbose, less efficient, more error-prone and harder to debug than setting properties directly. Usage Example: ‘$mail->set('SMTPSecure’, static::ENCRYPTION_STARTTLS);` is the same as: $mail->SMTPSecure = static::ENCRYPTION_STARTTLS;.

Paramètres
string$nameThe property name to set
mixed$valueThe value to set the property to
Renvoie
bool

Références $name, $this, $value, PHPMailer\lang(), et PHPMailer\setError().

◆ setError()

◆ setFrom()

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

Set the From and FromName properties.

Paramètres
string$address
string$name
bool$autoWhether to also set the Sender address, defaults to true
Exceptions
Exception
Renvoie
bool

Référencé par Mail\setSender().

◆ setLanguage()

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

Set the language for error messages. The default language is English.

Paramètres
string$langcodeISO 639-1 2-character language code (e.g. French is "fr") Optionally, the language code can be enhanced with a 4-character script annotation and/or a 2-character country annotation.
string$lang_pathPath to the language file directory, with trailing separator (slash) Do not set this from user input!
Renvoie
bool Returns true if the requested language was loaded, false otherwise.

Références $PHPMAILER_LANG, __DIR__, et language.

Référencé par PHPMailer\getTranslations(), et PHPMailer\lang().

◆ setLE()

static setLE (   $le)
staticprotected

Set the line break format string, e.g. "\r\n".

Paramètres
string$le

◆ setMessageType()

setMessageType ( )
protected

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

Références $type, PHPMailer\alternativeExists(), PHPMailer\attachmentExists(), et PHPMailer\inlineImageExists().

◆ setOAuth()

setOAuth ( OAuthTokenProvider  $oauth)

Set an OAuthTokenProvider instance.

Références PHPMailer\$oauth.

◆ setSMTPInstance()

setSMTPInstance ( SMTP  $smtp)

Provide an instance to use for SMTP operations.

Renvoie
SMTP

Références PHPMailer\$smtp.

◆ setWordWrap()

setWordWrap ( )

Apply word wrapping to the message body. Wraps the message body to the number of chars set in the WordWrap property. You should only do this to plain-text bodies as wrapping HTML tags may break them. This is called automatically by createBody(), so you don't need to call it yourself.

Références PHPMailer\wrapText().

Référencé par PHPMailer\createBody().

◆ sign()

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

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

Paramètres
string$cert_filename
string$key_filename
string$key_passPassword for private key
string$extracerts_filenameOptional path to chain certificate

◆ smtpClose()

smtpClose ( )

Close the active SMTP session if one exists.

Références null.

Référencé par PHPMailer\__destruct().

◆ smtpConnect()

smtpConnect (   $options = null)

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

Paramètres
array$optionsAn array of options compatible with stream_context_create()
Exceptions
Exception
Renvoie
bool

Références PHPMailer\$Helo, $message, $options, PHPMailer\$Port, $prefix, PHPMailer\$SMTPOptions, PHPMailer\$SMTPSecure, $this, PHPMailer\edebug(), elseif, PHPMailer\getSmtpErrorMessage(), PHPMailer\getSMTPInstance(), PHPMailer\lang(), null, et PHPMailer\serverHostname().

Référencé par PHPMailer\smtpSend().

◆ smtpSend()

smtpSend (   $header,
  $body 
)
protected

Send mail via SMTP. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.

Voir également
PHPMailer::setSMTPInstance() to use a different class.
Paramètres
string$headerThe message headers
string$bodyThe message body
Exceptions
Exception
Renvoie
bool

Références PHPMailer\$From, $header, PHPMailer\$Sender, $this, PHPMailer\$to, PHPMailer\doCallback(), PHPMailer\lang(), PHPMailer\setError(), et PHPMailer\smtpConnect().

◆ stripTrailingWSP()

static stripTrailingWSP (   $text)
static

Remove trailing breaks from a string.

Paramètres
string$text
Renvoie
string The text to remove breaks from

Références $text.

◆ textLine()

textLine (   $value)

Return a formatted mail line.

Paramètres
string$value
Renvoie
string

Références $value.

Référencé par PHPMailer\createBody(), PHPMailer\getBoundary(), et PHPMailer\getMailMIME().

◆ utf8CharBoundary()

utf8CharBoundary (   $encodedText,
  $maxLength 
)

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

Paramètres
string$encodedTextutf-8 QP text
int$maxLengthFind the last character boundary prior to this length
Renvoie
int

Références elseif.

Référencé par PHPMailer\wrapText().

◆ validateAddress()

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

Check that a string looks like an email address. Validation patterns supported:

  • auto Pick best pattern automatically;
  • pcre8 Use the squiloople.com pattern, requires PCRE > 8.0;
  • pcre Use old PCRE implementation;
  • php Use PHP built-in FILTER_VALIDATE_EMAIL;
  • html5 Use the pattern given by the HTML5 spec for 'email' type form input elements.
  • noregex Don't use a regex: super fast, really dumb. Alternatively you may pass in a callable to inject your own validator, for example:
PHPMailer::validateAddress('user@example.com', function($address) {
return (strpos($address, '@') !== false);
});

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

Paramètres
string$addressThe email address to check
string | callable$patternselectWhich pattern to use
Renvoie
bool

◆ validateEncoding()

validateEncoding (   $encoding)
protected

Validate encodings.

Paramètres
string$encoding
Renvoie
bool

Référencé par PHPMailer\addAttachment(), PHPMailer\addEmbeddedImage(), PHPMailer\addStringAttachment(), et PHPMailer\addStringEmbeddedImage().

◆ wrapText()

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

Word-wrap message. For use with mailers that do not automatically perform wrapping and for quoted-printable encoded messages. Original written by philippe.

Paramètres
string$messageThe message to wrap
int$lengthThe line length to wrap to
bool$qp_modeWhether to run in Quoted-Printable mode
Renvoie
string

Références $message, elseif, et PHPMailer\utf8CharBoundary().

Référencé par PHPMailer\encodeHeader(), et PHPMailer\setWordWrap().

Documentation des champs

◆ $action_function

$action_function = ''

◆ $all_recipients

$all_recipients = []
protected

◆ $AllowEmpty

$AllowEmpty = false

◆ $AltBody

$AltBody = ''

◆ $attachment

◆ $AuthType

$AuthType = ''

◆ $bcc

◆ $Body

$Body = ''

Référencé par PHPMailer\msgHTML().

◆ $boundary

$boundary = []
protected

◆ $cc

◆ $CharSet

$CharSet = self::CHARSET_ISO88591

◆ $ConfirmReadingTo

$ConfirmReadingTo = ''

◆ $ContentType

$ContentType = self::CONTENT_TYPE_PLAINTEXT

Référencé par PHPMailer\getBoundary().

◆ $CustomHeader

$CustomHeader = []
protected

Référencé par PHPMailer\getCustomHeaders().

◆ $Debugoutput

$Debugoutput = 'echo'

◆ $DKIM_copyHeaderFields

$DKIM_copyHeaderFields = true

◆ $DKIM_domain

$DKIM_domain = ''

◆ $DKIM_extraHeaders

$DKIM_extraHeaders = []

◆ $DKIM_identity

$DKIM_identity = ''

◆ $DKIM_passphrase

$DKIM_passphrase = ''

◆ $DKIM_private

$DKIM_private = ''

◆ $DKIM_private_string

$DKIM_private_string = ''

◆ $DKIM_selector

$DKIM_selector = ''

◆ $do_verp

$do_verp = false

◆ $dsn

$dsn = ''

Comma separated list of DSN notifications 'NEVER' under no circumstances a DSN must be returned to the sender. If you use NEVER all other notifications will be ignored. 'SUCCESS' will notify you when your mail has arrived at its destination. 'FAILURE' will arrive if an error occurred during delivery. 'DELAY' will notify you if there is an unusual delay in delivery, but the actual delivery's outcome (success or failure) is not yet decided.

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

◆ $Encoding

$Encoding = self::ENCODING_8BIT

◆ $error_count

$error_count = 0
protected

Référencé par PHPMailer\setError().

◆ $ErrorInfo

$ErrorInfo = ''

◆ $exceptions

$exceptions = false
protected

◆ $From

$From = ''

Référencé par PHPMailer\smtpSend().

◆ $FromName

$FromName = ''

◆ $Helo

$Helo = ''

Référencé par PHPMailer\smtpConnect().

◆ $Host

$Host = 'localhost'

◆ $Hostname

$Hostname = ''

Référencé par PHPMailer\serverHostname().

◆ $Ical

$Ical = ''

◆ $IcalMethods

$IcalMethods
staticprotected
Valeur initiale :
= [
self::ICAL_METHOD_REQUEST,
self::ICAL_METHOD_PUBLISH,
self::ICAL_METHOD_REPLY,
self::ICAL_METHOD_ADD,
self::ICAL_METHOD_CANCEL,
self::ICAL_METHOD_REFRESH,
self::ICAL_METHOD_COUNTER,
self::ICAL_METHOD_DECLINECOUNTER,
]

◆ $language

◆ $lastMessageID

$lastMessageID = ''
protected

◆ $LE

$LE = self::CRLF
staticprotected

◆ $Mailer

$Mailer = 'mail'

◆ $mailHeader

$mailHeader = ''
protected

◆ $message_type

$message_type = ''
protected

◆ $MessageDate

$MessageDate = ''

◆ $MessageID

$MessageID = ''

Référencé par PHPMailer\createHeader().

◆ $MIMEBody

$MIMEBody = ''
protected

Référencé par PHPMailer\getSentMIMEMessage().

◆ $MIMEHeader

$MIMEHeader = ''
protected

◆ $oauth

$oauth
protected

◆ $Password

$Password = ''

◆ $Port

$Port = 25

Référencé par PHPMailer\smtpConnect().

◆ $Priority

$Priority

◆ $RecipientsQueue

$RecipientsQueue = []
protected

◆ $ReplyTo

$ReplyTo = []
protected

◆ $ReplyToQueue

$ReplyToQueue = []
protected

◆ $Sender

$Sender = ''

Référencé par PHPMailer\smtpSend().

◆ $Sendmail

$Sendmail = '/usr/sbin/sendmail'

◆ $sign_cert_file

$sign_cert_file = ''
protected

◆ $sign_extracerts_file

$sign_extracerts_file = ''
protected

◆ $sign_key_file

$sign_key_file = ''
protected

◆ $sign_key_pass

$sign_key_pass = ''
protected

◆ $SingleTo

$SingleTo = false

◆ $SingleToArray

$SingleToArray = []
protected

◆ $smtp

$smtp
protected

◆ $SMTPAuth

$SMTPAuth = false

◆ $SMTPAutoTLS

$SMTPAutoTLS = true

◆ $SMTPDebug

$SMTPDebug = 0

◆ $SMTPKeepAlive

$SMTPKeepAlive = false

◆ $SMTPOptions

$SMTPOptions = []

Référencé par PHPMailer\smtpConnect().

◆ $SMTPSecure

$SMTPSecure = ''

Référencé par PHPMailer\smtpConnect().

◆ $Subject

$Subject = ''

◆ $Timeout

$Timeout = 300

◆ $to

◆ $uniqueid

$uniqueid = ''
protected

Référencé par PHPMailer\createBody().

◆ $Username

$Username = ''

◆ $UseSendmailOptions

$UseSendmailOptions = true

◆ $validator

$validator = 'php'
static

◆ $WordWrap

$WordWrap = 0

◆ $XMailer

$XMailer = ''

◆ CHARSET_ASCII

const CHARSET_ASCII = 'us-ascii'

◆ CHARSET_ISO88591

const CHARSET_ISO88591 = 'iso-8859-1'

◆ CHARSET_UTF8

const CHARSET_UTF8 = 'utf-8'

◆ CONTENT_TYPE_MULTIPART_ALTERNATIVE

const CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative'

◆ CONTENT_TYPE_MULTIPART_MIXED

const CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed'

◆ CONTENT_TYPE_MULTIPART_RELATED

const CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related'

◆ CONTENT_TYPE_PLAINTEXT

const CONTENT_TYPE_PLAINTEXT = 'text/plain'

◆ CONTENT_TYPE_TEXT_CALENDAR

const CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar'

◆ CONTENT_TYPE_TEXT_HTML

const CONTENT_TYPE_TEXT_HTML = 'text/html'

◆ CRLF

const CRLF = "\r\n"

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

◆ ENCODING_7BIT

const ENCODING_7BIT = '7bit'

◆ ENCODING_8BIT

const ENCODING_8BIT = '8bit'

◆ ENCODING_BASE64

const ENCODING_BASE64 = 'base64'

◆ ENCODING_BINARY

const ENCODING_BINARY = 'binary'

◆ ENCODING_QUOTED_PRINTABLE

const ENCODING_QUOTED_PRINTABLE = 'quoted-printable'

◆ ENCRYPTION_SMTPS

const ENCRYPTION_SMTPS = 'ssl'

◆ ENCRYPTION_STARTTLS

const ENCRYPTION_STARTTLS = 'tls'

◆ FWS

const FWS = ' '

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

◆ ICAL_METHOD_ADD

const ICAL_METHOD_ADD = 'ADD'

◆ ICAL_METHOD_CANCEL

const ICAL_METHOD_CANCEL = 'CANCEL'

◆ ICAL_METHOD_COUNTER

const ICAL_METHOD_COUNTER = 'COUNTER'

◆ ICAL_METHOD_DECLINECOUNTER

const ICAL_METHOD_DECLINECOUNTER = 'DECLINECOUNTER'

◆ ICAL_METHOD_PUBLISH

const ICAL_METHOD_PUBLISH = 'PUBLISH'

◆ ICAL_METHOD_REFRESH

const ICAL_METHOD_REFRESH = 'REFRESH'

◆ ICAL_METHOD_REPLY

const ICAL_METHOD_REPLY = 'REPLY'

◆ ICAL_METHOD_REQUEST

const ICAL_METHOD_REQUEST = 'REQUEST'

◆ MAIL_MAX_LINE_LENGTH

const MAIL_MAX_LINE_LENGTH = 63

◆ MAX_LINE_LENGTH

const MAX_LINE_LENGTH = 998

◆ STD_LINE_LENGTH

const STD_LINE_LENGTH = 76

◆ STOP_CONTINUE

const STOP_CONTINUE = 1

◆ STOP_CRITICAL

const STOP_CRITICAL = 2

◆ STOP_MESSAGE

const STOP_MESSAGE = 0

◆ VERSION

const VERSION = '6.6.0'

La documentation de cette classe a été générée à partir du fichier suivant :