AddAddress()
AddAttachment()
AddBCC()
AddCC()
AddCustomHeader()
AddEmbeddedImage()
AddReplyTo()
AddStringAttachment()
AddStringEmbeddedImage()
AddrAppend()
AddrFormat()
AlternativeExists()
AttachmentExists()
Base64EncodeWrapMB()
ClearAddresses()
ClearAllRecipients()
ClearAttachments()
ClearBCCs()
ClearCCs()
ClearCustomHeaders()
ClearReplyTos()
CreateBody()
CreateHeader()
DKIM_Add()
DKIM_BodyC()
DKIM_HeaderC()
DKIM_QP()
DKIM_Sign()
EncodeHeader()
EncodeQ()
EncodeQP()
EncodeString()
FixEOL()
GetAttachments()
GetMailMIME()
GetSentMIMEMessage()
GetTranslations()
HasMultiBytes()
HeaderLine()
InlineImageExists()
IsError()
IsHTML()
IsMail()
IsQmail()
IsSMTP()
IsSendmail()
MsgHTML()
PostSend()
PreSend()
RFCDate()
SecureHeader()
Send()
SetFrom()
SetLanguage()
SetWordWrap()
Sign()
SmtpClose()
SmtpConnect()
TextLine()
UTF8CharBoundary()
ValidateAddress()
WrapText()
__construct()
_mime_types()
set()
AddAnAddress()
AttachAll()
EncodeFile()
EndBoundary()
GetBoundary()
Lang()
MailSend()
SendmailSend()
ServerHostname()
SetError()
SetMessageType()
SmtpSend()
doCallback()
edebug()
mail_passthru()
$AltBody
$AuthType
$Body
$CharSet
$ConfirmReadingTo
$ContentType
$DKIM_domain
$DKIM_identity
$DKIM_passphrase
$DKIM_private
$DKIM_selector
$Debugoutput
$Encoding
$ErrorInfo
$From
$FromName
$Helo
$Host
$Hostname
$LE
$Mailer
$MessageDate
$MessageID
$Password
$PluginDir
$Port
$Priority
$Realm
$ReturnPath
$SMTPAuth
$SMTPDebug
$SMTPKeepAlive
$SMTPSecure
$Sender
$Sendmail
$SingleTo
$SingleToArray
$Subject
$Timeout
$UseSendmailOptions
$Username
$Version
$WordWrap
$Workstation
$XMailer
$action_function
$CustomHeader
$MIMEBody
$MIMEHeader
$ReplyTo
$all_recipients
$attachment
$bcc
$boundary
$cc
$error_count
$exceptions
$language
$mailHeader
$message_type
$sign_cert_file
$sign_key_file
$sign_key_pass
$smtp
$to
CRLF
STOP_CONTINUE
STOP_CRITICAL
STOP_MESSAGE
PHP email creation and transport class
package | PHPMailer |
---|
AddAddress(string $address, string $name) : boolean
string
string
boolean
true on success, false if address already usedAddAttachment(string $path, string $name, string $encoding, string $type) : bool
Returns false if the file could not be found or accessed.
string
Path to the attachment.
string
Overrides the attachment name.
string
File encoding (see $Encoding).
string
File extension (MIME) type.
\phpmailerException |
---|
bool
AddBCC(string $address, string $name) : boolean
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
string
string
boolean
true on success, false if address already usedAddCC(string $address, string $name) : boolean
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
string
string
boolean
true on success, false if address already usedAddCustomHeader(string $name, string $value) : void
$name value can be overloaded to contain both header name and value (name:value)
access | public |
---|
string
custom header name
string
header value
AddEmbeddedImage(string $path, string $cid, string $name, string $encoding, string $type) : bool
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".
string
Path to the attachment.
string
Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
string
Overrides the attachment name.
string
File encoding (see $Encoding).
string
File extension (MIME) type.
bool
AddReplyTo(string $address, string $name) : boolean
string
string
boolean
AddStringAttachment(string $string, string $filename, string $encoding, string $type) : void
This method can be used to attach ascii or binary data, such as a BLOB record from a database.
string
String attachment data.
string
Name of the attachment.
string
File encoding (see $Encoding).
string
File extension (MIME) type.
AddStringEmbeddedImage(string $string, string $cid, string $name, string $encoding, string $type) : bool
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".
string
The attachment.
string
Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
string
Overrides the attachment name.
string
File encoding (see $Encoding).
string
File extension (MIME) type.
bool
AddrAppend(string $type, array $addr) : string
access | public |
---|
string
array
string
AddrFormat(string $addr) : string
access | public |
---|
string
string
AlternativeExists() : bool
bool
AttachmentExists() : bool
bool
Base64EncodeWrapMB(string $str, string $lf) : string
Adapted from a function by paravoid at http://uk.php.net/manual/en/function.mb-encode-mimeheader.php
access | public |
---|
string
multi-byte text to wrap encode
string
string to use as linefeed/end-of-line
string
ClearAddresses() : void
Returns void.
ClearAllRecipients() : void
Returns void.
ClearAttachments() : void
Returns void.
ClearBCCs() : void
Returns void.
ClearCCs() : void
Returns void.
ClearCustomHeaders() : void
Returns void.
ClearReplyTos() : void
Returns void.
CreateBody() : string
Returns an empty string on failure.
access | public |
---|
\phpmailerException |
---|
string
The assembled message bodyCreateHeader() : string
access | public |
---|
string
The assembled headerDKIM_Add(string $headers_line, string $subject, string $body) : string
access | public |
---|
string
Header lines
string
Subject
string
Body
string
DKIM_BodyC(string $body) : string
access | public |
---|
string
Message Body
string
DKIM_HeaderC(string $s) : string
access | public |
---|
string
Header
string
DKIM_QP(string $txt) : string
access | public |
---|
string
string
DKIM_Sign(string $s) : string
access | public |
---|
string
Header
string
EncodeHeader(string $str, string $position) : string
access | public |
---|
string
string
string
EncodeQ(string $str, string $position) : string
link | http://tools.ietf.org/html/rfc2047 |
---|---|
access | public |
string
the text to encode
string
Where the text is going to be used, see the RFC for what that means
string
EncodeQP(string $string, integer $line_max, boolean $space_conv) : string
see | \global\EncodeQPphp() |
---|---|
access | public |
author | Marcus Bointon |
string
the text to encode
integer
Number of chars allowed on a line before wrapping
boolean
Dummy param for compatibility with existing EncodeQP function
string
EncodeString(string $str, string $encoding) : string
Returns an empty string on failure.
access | public |
---|
string
The text to encode
string
The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
string
FixEOL(string $str) : string
access | public |
---|
string
String to FixEOL
string
GetAttachments() : array
array
GetMailMIME() : string
access | public |
---|
string
GetSentMIMEMessage() : string
Only really valid post PreSend().
access | public |
---|
string
GetTranslations() : array
array
HasMultiBytes(string $str) : bool
access | public |
---|
string
multi-byte text to wrap encode
bool
HeaderLine(string $name, string $value) : string
access | public |
---|
string
string
string
InlineImageExists() : bool
access | public |
---|
bool
IsError() : bool
access | public |
---|
bool
IsHTML(bool $ishtml) : void
bool
IsMail() : void
IsQmail() : void
IsSMTP() : void
IsSendmail() : void
MsgHTML(string $message, string $basedir) : string
access | public |
---|
string
Text to be HTML modified
string
baseline directory for path
string
$messagePostSend() : bool
PreSend() : bool
RFCDate() : string
access | public |
---|---|
static |
string
SecureHeader(string $str) : string
access | public |
---|
string
String
string
Send() : bool
If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.
\phpmailerException |
---|
bool
SetFrom(string $address, string $name, int $auto) : boolean
string
string
int
Also set Reply-To and Sender
\phpmailerException |
---|
boolean
SetLanguage(string $langcode, string $lang_path) : bool
Returns false if it cannot load the language file. The default language is English.
access | public |
---|
string
ISO 639-1 2-character language code (e.g. Portuguese: "br")
string
Path to the language file directory
bool
SetWordWrap() : void
access | public |
---|
Sign($cert_filename, string $key_filename, string $key_pass)
access | public |
---|
string
Parameter File Name
string
Password for private key
SmtpClose() : void
SmtpConnect() : bool