Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe PHPMailer
+ Graphe d'héritage de PHPMailer:

Liste de tous les membres

Fonctions membres publiques

 __construct ($exceptions=false)
 IsHTML ($ishtml=true)
 IsSMTP ()
 IsMail ()
 IsSendmail ()
 IsQmail ()
 AddAddress ($address, $name= '')
 AddCC ($address, $name= '')
 AddBCC ($address, $name= '')
 AddReplyTo ($address, $name= '')
 SetFrom ($address, $name= '', $auto=1)
 Send ()
 SmtpConnect ()
 SmtpClose ()
 SetLanguage ($langcode= 'en', $lang_path= 'language/')
 GetTranslations ()
 AddrAppend ($type, $addr)
 AddrFormat ($addr)
 WrapText ($message, $length, $qp_mode=false)
 UTF8CharBoundary ($encodedText, $maxLength)
 SetWordWrap ()
 CreateHeader ()
 GetMailMIME ()
 GetSentMIMEMessage ()
 CreateBody ()
 HeaderLine ($name, $value)
 TextLine ($value)
 AddAttachment ($path, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
 GetAttachments ()
 EncodeString ($str, $encoding= 'base64')
 EncodeHeader ($str, $position= 'text')
 HasMultiBytes ($str)
 Base64EncodeWrapMB ($str)
 EncodeQPphp ($input= '', $line_max=76, $space_conv=false)
 EncodeQP ($string, $line_max=76, $space_conv=false)
 EncodeQ ($str, $position= 'text')
 AddStringAttachment ($string, $filename, $encoding= 'base64', $type= 'application/octet-stream')
 AddEmbeddedImage ($path, $cid, $name= '', $encoding= 'base64', $type= 'application/octet-stream')
 AddStringEmbeddedImage ($string, $cid, $filename= '', $encoding= 'base64', $type= 'application/octet-stream')
 InlineImageExists ()
 AttachmentExists ()
 AlternativeExists ()
 ClearAddresses ()
 ClearCCs ()
 ClearBCCs ()
 ClearReplyTos ()
 ClearAllRecipients ()
 ClearAttachments ()
 ClearCustomHeaders ()
 IsError ()
 FixEOL ($str)
 AddCustomHeader ($custom_header)
 MsgHTML ($message, $basedir= '')
 set ($name, $value= '')
 SecureHeader ($str)
 Sign ($cert_filename, $key_filename, $key_pass)
 DKIM_QP ($txt)
 DKIM_Sign ($s)
 DKIM_HeaderC ($s)
 DKIM_BodyC ($body)
 DKIM_Add ($headers_line, $subject, $body)

Fonctions membres publiques statiques

static ValidateAddress ($address)
static RFCDate ()
static _mime_types ($ext= '')

Attributs publics

 $Priority = 3
 $CharSet = 'iso-8859-1'
 $ContentType = 'text/plain'
 $Encoding = '8bit'
 $ErrorInfo = ''
 $From = 'root@localhost'
 $FromName = 'Root User'
 $Sender = ''
 $Subject = ''
 $Body = ''
 $AltBody = ''
 $WordWrap = 0
 $Mailer = 'mail'
 $Sendmail = '/usr/sbin/sendmail'
 $PluginDir = ''
 $ConfirmReadingTo = ''
 $Hostname = ''
 $MessageID = ''
 $Host = 'localhost'
 $Port = 25
 $Helo = ''
 $SMTPSecure = ''
 $SMTPAuth = false
 $Username = ''
 $Password = ''
 $Timeout = 10
 $SMTPDebug = false
 $SMTPKeepAlive = false
 $SingleTo = false
 $SingleToArray = array()
 $LE = "\n"
 $DKIM_selector = 'phpmailer'
 $DKIM_identity = ''
 $DKIM_passphrase = ''
 $DKIM_domain = ''
 $DKIM_private = ''
 $action_function = ''
 $Version = '5.2.1'
 $XMailer = ''
const STOP_MESSAGE = 0
const STOP_CONTINUE = 1
const STOP_CRITICAL = 2

Fonctions membres protégées

 AddAnAddress ($kind, $address, $name= '')
 PreSend ()
 PostSend ()
 SendmailSend ($header, $body)
 MailSend ($header, $body)
 SmtpSend ($header, $body)
 GetBoundary ($boundary, $charSet, $contentType, $encoding)
 EndBoundary ($boundary)
 SetMessageType ()
 AttachAll ($disposition_type, $boundary)
 EncodeFile ($path, $encoding= 'base64')
 SetError ($msg)
 ServerHostname ()
 Lang ($key)
 doCallback ($isSent, $to, $cc, $bcc, $subject, $body)

Attributs protégés

 $MIMEBody = ''
 $MIMEHeader = ''
 $SentMIMEMessage = ''
 $smtp = NULL
 $to = array()
 $cc = array()
 $bcc = array()
 $ReplyTo = array()
 $all_recipients = array()
 $attachment = array()
 $CustomHeader = array()
 $message_type = ''
 $boundary = array()
 $language = array()
 $error_count = 0
 $sign_cert_file = ''
 $sign_key_file = ''
 $sign_key_pass = ''
 $exceptions = false

Documentation des constructeurs et destructeur

PHPMailer::__construct (   $exceptions = false)

Constructor

Paramètres:
boolean$exceptionsShould we throw external exceptions?

Références $exceptions.


Documentation des fonctions membres

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

Gets the MIME type of the embedded or inline image

Paramètres:
stringFile extension public
Renvoie:
string MIME type of ext

Référencé par MsgHTML().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AddAddress (   $address,
  $name = '' 
)

Adds a "To" address.

Paramètres:
string$address
string$name
Renvoie:
boolean true on success, false if address already used

Références $name, et AddAnAddress().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::AddAnAddress (   $kind,
  $address,
  $name = '' 
)
protected

Adds an address to one of the recipient arrays Addresses that have been added already return false, but do not throw exceptions

Paramètres:
string$kindOne of 'to', 'cc', 'bcc', 'ReplyTo'
string$addressThe email address to send to
string$name
Renvoie:
boolean true on success, false if address already used or invalid in some way protected

Références $name, Lang(), et SetError().

Référencé par AddAddress(), AddBCC(), AddCC(), AddReplyTo(), et SetFrom().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AddAttachment (   $path,
  $name = '',
  $encoding = 'base64',
  $type = 'application/octet-stream' 
)

Adds an attachment from a path on the filesystem. Returns false if the file could not be found or accessed.

Paramètres:
string$pathPath to the attachment.
string$nameOverrides the attachment name.
string$encodingFile encoding (see $Encoding).
string$typeFile extension (MIME) type.
Renvoie:
bool

Références $name, $path, $type, Lang(), SetError(), et STOP_CRITICAL.

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::AddBCC (   $address,
  $name = '' 
)

Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

Paramètres:
string$address
string$name
Renvoie:
boolean true on success, false if address already used

Références $name, et AddAnAddress().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::AddCC (   $address,
  $name = '' 
)

Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

Paramètres:
string$address
string$name
Renvoie:
boolean true on success, false if address already used

Références $name, et AddAnAddress().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::AddCustomHeader (   $custom_header)

Adds a custom header. public

Renvoie:
void
PHPMailer::AddEmbeddedImage (   $path,
  $cid,
  $name = '',
  $encoding = 'base64',
  $type = 'application/octet-stream' 
)

Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use "image/jpeg" and for GIF images use "image/gif".

Paramètres:
string$pathPath to the attachment.
string$cidContent ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
string$nameOverrides the attachment name.
string$encodingFile encoding (see $Encoding).
string$typeFile extension (MIME) type.
Renvoie:
bool

Références $name, $path, $type, Lang(), et SetError().

Référencé par MsgHTML().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AddrAppend (   $type,
  $addr 
)

Creates recipient headers. public

Renvoie:
string

Références $LE, $type, et AddrFormat().

Référencé par CreateHeader(), et PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AddReplyTo (   $address,
  $name = '' 
)

Adds a "Reply-to" address.

Paramètres:
string$address
string$name
Renvoie:
boolean

Références $name, et AddAnAddress().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::AddrFormat (   $addr)

Formats an address correctly. public

Renvoie:
string

Références EncodeHeader(), et SecureHeader().

Référencé par AddrAppend(), CreateHeader(), et MailSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AddStringAttachment (   $string,
  $filename,
  $encoding = 'base64',
  $type = 'application/octet-stream' 
)

Adds a string or binary attachment (non-filesystem) to the list. 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.
Renvoie:
void

Références $type.

PHPMailer::AddStringEmbeddedImage (   $string,
  $cid,
  $filename = '',
  $encoding = 'base64',
  $type = 'application/octet-stream' 
)

Références $type.

PHPMailer::AlternativeExists ( )

Référencé par SetMessageType().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AttachAll (   $disposition_type,
  $boundary 
)
protected

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

Renvoie:
string

Références $attachment, $boundary, $mime, $name, $path, $type, EncodeFile(), EncodeHeader(), EncodeString(), IsError(), et SecureHeader().

Référencé par CreateBody().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::AttachmentExists ( )

Références $attachment.

Référencé par SetMessageType().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::Base64EncodeWrapMB (   $str)

Correctly encodes and wraps long multibyte strings for mail headers without breaking lines within a character. Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php public

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

Références $i, et $LE.

Référencé par EncodeHeader().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::ClearAddresses ( )

Clears all recipients assigned in the TO array. Returns void.

Renvoie:
void

Références $to.

PHPMailer::ClearAllRecipients ( )

Clears all recipients assigned in the TO, CC and BCC array. Returns void.

Renvoie:
void
PHPMailer::ClearAttachments ( )

Clears all previously set filesystem, string, and binary attachments. Returns void.

Renvoie:
void
PHPMailer::ClearBCCs ( )

Clears all recipients assigned in the BCC array. Returns void.

Renvoie:
void

Références $bcc.

PHPMailer::ClearCCs ( )

Clears all recipients assigned in the CC array. Returns void.

Renvoie:
void

Références $cc.

PHPMailer::ClearCustomHeaders ( )

Clears all custom headers. Returns void.

Renvoie:
void
PHPMailer::ClearReplyTos ( )

Clears all recipients assigned in the ReplyTo array. Returns void.

Renvoie:
void
PHPMailer::CreateBody ( )

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

Renvoie:
string The assembled message body

Références $file, $LE, AttachAll(), elseif, EncodeString(), EndBoundary(), GetBoundary(), GetMailMIME(), HeaderLine(), IsError(), Lang(), NULL, SetWordWrap(), et TextLine().

Référencé par PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::CreateHeader ( )

Assembles message header. public

Renvoie:
string The assembled header

Références $FromName, AddrAppend(), AddrFormat(), elseif, EncodeHeader(), GetMailMIME(), HeaderLine(), SecureHeader(), et ServerHostname().

Référencé par PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

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

Create the DKIM header, body, as new header

public

Paramètres:
string$headers_lineHeader lines
string$subjectSubject
string$bodyBody

Références $to, DKIM_BodyC(), DKIM_HeaderC(), DKIM_QP(), DKIM_Sign(), et elseif.

Référencé par PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::DKIM_BodyC (   $body)

Generate DKIM Canonicalization Body

public

Paramètres:
string$bodyMessage Body

Référencé par DKIM_Add().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::DKIM_HeaderC (   $s)

Generate DKIM Canonicalization Header

public

Paramètres:
string$sHeader

Références $key.

Référencé par DKIM_Add().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::DKIM_QP (   $txt)

Set the private key file and password to sign the message.

public

Paramètres:
string$key_filenameParameter File Name
string$key_passPassword for private key

Références $i.

Référencé par DKIM_Add().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::DKIM_Sign (   $s)

Generate DKIM signature

public

Paramètres:
string$sHeader

Référencé par DKIM_Add().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::doCallback (   $isSent,
  $to,
  $cc,
  $bcc,
  $subject,
  $body 
)
protected

Références $bcc, $cc, $params, et $to.

Référencé par MailSend(), SendmailSend(), et SmtpSend().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::EncodeFile (   $path,
  $encoding = 'base64' 
)
protected

Encodes 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'
Voir également:
EncodeFile() protected
Renvoie:
string

Références $path, EncodeString(), Lang(), et SetError().

Référencé par AttachAll().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

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

Encode a header string to best (shortest) of Q, B, quoted or none. public

Renvoie:
string

Références Base64EncodeWrapMB(), EncodeQ(), HasMultiBytes(), et WrapText().

Référencé par AddrFormat(), AttachAll(), CreateHeader(), MailSend(), et PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

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

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

Référencé par EncodeHeader().

+ Voici le graphe des appelants de cette fonction :

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

Encode string to RFC2045 (6.7) quoted-printable format Uses a PHP5 stream filter to do the encoding about 64x faster than the old version Also results in same content as you started with after decoding

Voir également:
EncodeQPphp() public
Paramètres:
string$stringthe text to encode
integer$line_maxNumber of chars allowed on a line before wrapping
boolean$space_convDummy param for compatibility with existing EncodeQP function
Renvoie:
string
Auteur:
Marcus Bointon

Références $params, et EncodeQPphp().

Référencé par EncodeString().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::EncodeQPphp (   $input = '',
  $line_max = 76,
  $space_conv = false 
)

Encode string to quoted-printable. Only uses standard PHP, slow, but will always work public

Paramètres:
string$stringthe text to encode
integer$line_maxNumber of chars allowed on a line before wrapping
Renvoie:
string

Références $i, $output, et elseif.

Référencé par EncodeQP().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::EncodeString (   $str,
  $encoding = 'base64' 
)

Encodes string to 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' public
Renvoie:
string

Références $LE, EncodeQP(), FixEOL(), Lang(), et SetError().

Référencé par AttachAll(), CreateBody(), et EncodeFile().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::EndBoundary (   $boundary)
protected

Returns the end of a message boundary. protected

Renvoie:
string

Références $boundary, et $LE.

Référencé par CreateBody().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::FixEOL (   $str)

Changes every end of line from CR or LF to CRLF. public

Renvoie:
string

Référencé par EncodeString(), et WrapText().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::GetAttachments ( )

Return the current array of attachments

Renvoie:
array

Références $attachment.

PHPMailer::GetBoundary (   $boundary,
  $charSet,
  $contentType,
  $encoding 
)
protected

Returns the start of a message boundary. protected

Renvoie:
string

Références $boundary, $CharSet, $ContentType, $Encoding, $LE, HeaderLine(), et TextLine().

Référencé par CreateBody().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::GetMailMIME ( )

Returns the message MIME. public

Renvoie:
string

Références HeaderLine(), et TextLine().

Référencé par CreateBody(), et CreateHeader().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::GetSentMIMEMessage ( )

Returns the MIME message (headers and body). Only really valid post PreSend(). public

Renvoie:
string

Références $SentMIMEMessage.

PHPMailer::GetTranslations ( )

Return the current array of language strings

Renvoie:
array

Références $language.

PHPMailer::HasMultiBytes (   $str)

Checks if a string contains multibyte characters. public

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

Référencé par EncodeHeader().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::HeaderLine (   $name,
  $value 
)

Returns a formatted header line. public

Renvoie:
string

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

Référencé par CreateBody(), CreateHeader(), GetBoundary(), GetMailMIME(), et PreSend().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::InlineImageExists ( )

Returns true if an inline attachment is present. public

Renvoie:
bool

Références $attachment.

Référencé par SetMessageType().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::IsError ( )

Returns true if an error occurred. public

Renvoie:
bool

Référencé par AttachAll(), et CreateBody().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::IsHTML (   $ishtml = true)

Sets message type to HTML.

Paramètres:
bool$ishtml
Renvoie:
void

Référencé par MsgHTML().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::IsMail ( )

Sets Mailer to send message using PHP mail() function.

Renvoie:
void
PHPMailer::IsQmail ( )

Sets Mailer to send message using the qmail MTA.

Renvoie:
void
PHPMailer::IsSendmail ( )

Sets Mailer to send message using the $Sendmail program.

Renvoie:
void
PHPMailer::IsSMTP ( )

Sets Mailer to send message using SMTP.

Renvoie:
void
PHPMailer::Lang (   $key)
protected

Returns a message in the appropriate language. protected

Renvoie:
string

Références $key, language, et SetLanguage().

Référencé par AddAnAddress(), AddAttachment(), AddEmbeddedImage(), CreateBody(), EncodeFile(), EncodeString(), MailSend(), PreSend(), SendmailSend(), set(), SetError(), SetFrom(), SmtpConnect(), et SmtpSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::MailSend (   $header,
  $body 
)
protected

Sends mail using the PHP mail() function.

Paramètres:
string$headerThe message headers
string$bodyThe message body protected
Renvoie:
bool

Références $key, $params, $to, AddrFormat(), doCallback(), EncodeHeader(), Lang(), et SecureHeader().

Référencé par PostSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::MsgHTML (   $message,
  $basedir = '' 
)

Evaluates the message and returns modifications for inline images and backgrounds public

Renvoie:
$message

Références $i, $images, $message, $url, _mime_types(), AddEmbeddedImage(), ENT_QUOTES, et IsHTML().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::PostSend ( )
protected

Références MailSend(), SendmailSend(), SetError(), et SmtpSend().

Référencé par Send().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::PreSend ( )
protected

Références $MIMEHeader, AddrAppend(), CreateBody(), CreateHeader(), DKIM_Add(), EncodeHeader(), HeaderLine(), Lang(), SecureHeader(), SetError(), et SetMessageType().

Référencé par Send().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static PHPMailer::RFCDate ( )
static

Returns the proper RFC 822 formatted date. public

Renvoie:
string
PHPMailer::SecureHeader (   $str)

Strips newlines to prevent header injection. public

Paramètres:
string$strString
Renvoie:
string

Référencé par AddrFormat(), AttachAll(), CreateHeader(), MailSend(), et PreSend().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::Send ( )

Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.

Renvoie:
bool

Réimplémentée dans JMail.

Références PostSend(), PreSend(), et SetError().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::SendmailSend (   $header,
  $body 
)
protected

Sends mail using the $Sendmail program.

Paramètres:
string$headerThe message headers
string$bodyThe message body protected
Renvoie:
bool

Références $key, doCallback(), et Lang().

Référencé par PostSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::ServerHostname ( )
protected

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

Renvoie:
string

Références $Hostname, et elseif.

Référencé par CreateHeader(), et SmtpConnect().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::set (   $name,
  $value = '' 
)

Set (or reset) Class Objects (variables)

Usage Example: $page->set('X-Priority', '3');

public

Paramètres:
string$nameParameter Name
mixed$valueParameter Value NOTE: will not work with arrays, there are no arrays to set/reset

Références $name, Lang(), SetError(), et STOP_CRITICAL.

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::SetError (   $msg)
protected

Adds the error message to the error container. protected

Renvoie:
void

Références Lang().

Référencé par AddAnAddress(), AddAttachment(), AddEmbeddedImage(), EncodeFile(), EncodeString(), PostSend(), PreSend(), Send(), set(), et SetFrom().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::SetFrom (   $address,
  $name = '',
  $auto = 1 
)

Set the From and FromName properties

Paramètres:
string$address
string$name
Renvoie:
boolean

Références $name, AddAnAddress(), Lang(), et SetError().

+ Voici le graphe d'appel pour cette fonction :

PHPMailer::SetLanguage (   $langcode = 'en',
  $lang_path = 'language/' 
)

Sets the language for all class error messages. Returns false if it cannot load the language file. The default language is English.

Paramètres:
string$langcodeISO 639-1 2-character language code (e.g. Portuguese: "br")
string$lang_pathPath to the language file directory public

Références $PHPMAILER_LANG, et language.

Référencé par Lang().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::SetMessageType ( )
protected

Sets the message type. protected

Renvoie:
void

Références AlternativeExists(), AttachmentExists(), et InlineImageExists().

Référencé par PreSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::SetWordWrap ( )

Set the body wrapping. public

Renvoie:
void

Références WrapText().

Référencé par CreateBody().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::Sign (   $cert_filename,
  $key_filename,
  $key_pass 
)

Set the private key file and password to sign the message.

public

Paramètres:
string$key_filenameParameter File Name
string$key_passPassword for private key
PHPMailer::SmtpClose ( )

Closes the active SMTP session if one exists.

Renvoie:
void
PHPMailer::SmtpConnect ( )

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

Renvoie:
bool

Références $Port, $SMTPDebug, Lang(), et ServerHostname().

Référencé par SmtpSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::SmtpSend (   $header,
  $body 
)
protected

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

Paramètres:
string$headerThe message headers
string$bodyThe message body SMTP protected
Renvoie:
bool

Références $bcc, $cc, $to, doCallback(), Lang(), et SmtpConnect().

Référencé par PostSend().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

PHPMailer::TextLine (   $value)

Returns a formatted mail line. public

Renvoie:
string

Références $LE.

Référencé par CreateBody(), GetBoundary(), et GetMailMIME().

+ Voici le graphe des appelants de cette fonction :

PHPMailer::UTF8CharBoundary (   $encodedText,
  $maxLength 
)

Finds last character boundary prior to maxLength in a utf-8 quoted (printable) encoded string. Original written by Colin Brown. public

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

Références elseif.

Référencé par WrapText().

+ Voici le graphe des appelants de cette fonction :

static PHPMailer::ValidateAddress (   $address)
static

Check that a string looks roughly like an email address should Static so it can be used without instantiation Tries to use PHP built-in validator in the filter extension (from PHP 5.2), falls back to a reasonably competent regex validator Conforms approximately to RFC2822 Original pattern found here string $address The email address to check boolean public

PHPMailer::WrapText (   $message,
  $length,
  $qp_mode = false 
)

Wraps message for use with mailers that do not automatically perform wrapping and for quoted-printable. Original written by philippe.

Paramètres:
string$messageThe message to wrap
integer$lengthThe line length to wrap to
boolean$qp_modeWhether to run in Quoted-Printable mode public
Renvoie:
string

Références $i, $LE, $message, elseif, FixEOL(), et UTF8CharBoundary().

Référencé par EncodeHeader(), et SetWordWrap().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :


Documentation des données membres

PHPMailer::$action_function = ''
PHPMailer::$all_recipients = array()
protected
PHPMailer::$AltBody = ''
PHPMailer::$attachment = array()
protected
PHPMailer::$bcc = array()
protected

Référencé par ClearBCCs(), doCallback(), et SmtpSend().

PHPMailer::$Body = ''
PHPMailer::$boundary = array()
protected

Référencé par AttachAll(), EndBoundary(), et GetBoundary().

PHPMailer::$cc = array()
protected

Référencé par ClearCCs(), doCallback(), et SmtpSend().

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

Réimplémentée dans JMail.

Référencé par GetBoundary().

PHPMailer::$ConfirmReadingTo = ''
PHPMailer::$ContentType = 'text/plain'

Référencé par GetBoundary().

PHPMailer::$CustomHeader = array()
protected
PHPMailer::$DKIM_domain = ''
PHPMailer::$DKIM_identity = ''
PHPMailer::$DKIM_passphrase = ''
PHPMailer::$DKIM_private = ''
PHPMailer::$DKIM_selector = 'phpmailer'
PHPMailer::$Encoding = '8bit'

Référencé par GetBoundary().

PHPMailer::$error_count = 0
protected
PHPMailer::$ErrorInfo = ''
PHPMailer::$exceptions = false
protected

Référencé par __construct().

PHPMailer::$From = 'root@localhost'
PHPMailer::$FromName = 'Root User'

Référencé par CreateHeader().

PHPMailer::$Helo = ''
PHPMailer::$Host = 'localhost'
PHPMailer::$Hostname = ''

Référencé par ServerHostname().

PHPMailer::$language = array()
protected

Référencé par GetTranslations().

PHPMailer::$Mailer = 'mail'
PHPMailer::$message_type = ''
protected
PHPMailer::$MessageID = ''
PHPMailer::$MIMEBody = ''
protected
PHPMailer::$MIMEHeader = ''
protected

Référencé par PreSend().

PHPMailer::$Password = ''
PHPMailer::$PluginDir = ''
PHPMailer::$Port = 25

Référencé par SmtpConnect().

PHPMailer::$Priority = 3
PHPMailer::$ReplyTo = array()
protected
PHPMailer::$Sender = ''
PHPMailer::$Sendmail = '/usr/sbin/sendmail'
PHPMailer::$SentMIMEMessage = ''
protected

Référencé par GetSentMIMEMessage().

PHPMailer::$sign_cert_file = ''
protected
PHPMailer::$sign_key_file = ''
protected
PHPMailer::$sign_key_pass = ''
protected
PHPMailer::$SingleTo = false
PHPMailer::$SingleToArray = array()
PHPMailer::$smtp = NULL
protected
PHPMailer::$SMTPAuth = false
PHPMailer::$SMTPDebug = false

Référencé par SmtpConnect().

PHPMailer::$SMTPKeepAlive = false
PHPMailer::$SMTPSecure = ''
PHPMailer::$Subject = ''
PHPMailer::$Timeout = 10
PHPMailer::$to = array()
protected
PHPMailer::$Username = ''
PHPMailer::$Version = '5.2.1'
PHPMailer::$WordWrap = 0
PHPMailer::$XMailer = ''
const PHPMailer::STOP_CONTINUE = 1
const PHPMailer::STOP_CRITICAL = 2

Référencé par AddAttachment(), et set().

const PHPMailer::STOP_MESSAGE = 0

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