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= 'base64'
, string $type= 'application/octet-stream'
) : boolean
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.
boolean
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($custom_header) : void
access | public |
---|
AddEmbeddedImage(string $path, string $cid, string $name= ''
, string $encoding= 'base64'
, string $type= 'application/octet-stream'
) : boolean
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.
boolean
AddReplyTo(string $address, string $name = ''
) : boolean
string
string
boolean
AddStringAttachment(string $string, string $filename, string $encoding= 'base64'
, string $type= 'application/octet-stream'
) : 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, $cid, $filename= ''
, $encoding= 'base64'
, $type= 'application/octet-stream'
)
AddrAppend($type, $addr) : string
access | public |
---|
string
AddrFormat($addr) : string
access | public |
---|
string
AlternativeExists()
AttachmentExists()
Base64EncodeWrapMB(string $str) : 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
ClearAddresses() : void
ClearAllRecipients() : void
ClearAttachments() : void
ClearBCCs() : void
ClearCCs() : void
ClearCustomHeaders() : void
ClearReplyTos() : void
CreateBody() : string
access | public |
---|
string
The assembled message bodyCreateHeader() : string
access | public |
---|
string
The assembled headerDKIM_Add(string $headers_line, string $subject, string $body)
access | public |
---|
string
Header lines
string
Subject
string
Body
DKIM_BodyC(string $body)
access | public |
---|
string
Message Body
DKIM_HeaderC(string $s)
access | public |
---|
string
Header
DKIM_QP($txt)
access | public |
---|
DKIM_Sign(string $s)
access | public |
---|
string
Header
EncodeHeader($str, $position = 'text'
) : string
access | public |
---|
string
EncodeQ(string $str, string $position = 'text'
) : 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= 76
, boolean $space_conv= false
) : string
see | |
---|---|
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
EncodeQPphp($input= ''
, integer $line_max= 76
, $space_conv= false
) : string
Only uses standard PHP, slow, but will always work
access | public |
---|
integer
Number of chars allowed on a line before wrapping
string
EncodeString(string $str, string $encoding = 'base64'
) : 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($str) : string
access | public |
---|
string
GetAttachments() : array
array
GetMailMIME() : string
access | public |
---|
string
GetSentMIMEMessage() : string
access | public |
---|
string
GetTranslations() : array
array
HasMultiBytes(string $str) : boolean
access | public |
---|
string
multi-byte text to wrap encode
boolean
HeaderLine($name, $value) : string
access | public |
---|
string
InlineImageExists() : boolean
access | public |
---|
boolean
IsError() : boolean
access | public |
---|
boolean
IsHTML(boolean $ishtml = true
) : void
boolean
IsMail() : void
IsQmail() : void
IsSMTP() : void
IsSendmail() : void
MsgHTML($message, $basedir = ''
) : \$message
access | public |
---|
\$message
RFCDate() : string
access | public |
---|---|
static |
string
SecureHeader(string $str) : string
access | public |
---|
string
String
string
Send() : boolean
boolean
SetFrom(string $address, string $name= ''
, $auto= 1
) : boolean
string
string
boolean
SetLanguage(string $langcode= 'en'
, string $lang_path= 'language/'
)
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
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() : boolean
TextLine($value) : string
access | public |
---|
string
UTF8CharBoundary(string $encodedText, integer $maxLength) : integer
Original written by Colin Brown.
access | public |
---|
string
utf-8 QP text
integer
find last character boundary prior to this length
integer
ValidateAddress(string $address) : boolean
link | Original pattern found here |
---|---|
static | |
access | public |
string
The email address to check
boolean
WrapText(string $message, integer $length, boolean $qp_mode = false
) : string
Original written by philippe.
access | public |
---|
string
The message to wrap
integer
The line length to wrap to
boolean
Whether to run in Quoted-Printable mode
string
__construct(boolean $exceptions = false
)
boolean
Should we throw external exceptions?
_mime_types(string $ext = ''
) : string
access | public |
---|---|
static |
string
File extension
string
MIME type of extset(string $name, mixed $value = ''
)
Usage Example: $page->set('X-Priority', '3');
access | public |
---|---|
todo | Should this not be using __set() magic function? |
string
Parameter Name
mixed
Parameter Value NOTE: will not work with arrays, there are no arrays to set/reset
AddAnAddress(string $kind, string $address, string $name = ''
) : boolean
access | protected |
---|
string
One of 'to', 'cc', 'bcc', 'ReplyTo'
string
The email address to send to
string
boolean
true on success, false if address already used or invalid in some wayAttachAll($disposition_type, $boundary) : string
Returns an empty string on failure.
access | protected |
---|
string
EncodeFile(string $path, string $encoding = 'base64'
) : string
EndBoundary($boundary) : string
access | protected |
---|
string
GetBoundary($boundary, $charSet, $contentType, $encoding) : string
access | protected |
---|
string
Lang($key) : string
access | protected |
---|
string
MailSend(string $header, string $body) : boolean
access | protected |
---|
string
The message headers
string
The message body
boolean
PostSend()
PreSend()
SendmailSend(string $header, string $body) : boolean
access | protected |
---|
string
The message headers
string
The message body
boolean
ServerHostname() : string
access | protected |
---|
string
SetError($msg) : void
access | protected |
---|
SetMessageType() : void
access | protected |
---|
SmtpSend(string $header, string $body) : boolean
doCallback($isSent, $to, $cc, $bcc, $subject, $body)
$AltBody : string
''
$Body : string
''
If HTML then run IsHTML(true).
$CharSet : string
'iso-8859-1'
$ConfirmReadingTo : string
''
$ContentType : string
'text/plain'
$DKIM_domain : string
''
$DKIM_identity : string
''
$DKIM_passphrase : string
''
$DKIM_private : string
''
$DKIM_selector : string
'phpmailer'
$Encoding : string
'8bit'
$ErrorInfo : string
''
$From : string
'root@localhost'
$FromName : string
'Root User'
$Helo : string
''
$Host : string
'localhost'
Hosts will be tried in order.
$Hostname : string
''
$LE : string
"\n"
$Mailer : string
'mail'
$MessageID : string
''
If empty, a unique id will be generated.
$Password : string
''
$PluginDir : string
''
$Port : integer
25
$Priority : integer
3
$SMTPAuth : boolean
false
$SMTPDebug : boolean
false
$SMTPKeepAlive : boolean
false
$SMTPSecure : string
''
Options are "", "ssl" or "tls"
$Sender : string
''
$Sendmail : string
'/usr/sbin/sendmail'
$SingleTo : boolean
false
$SingleToArray : boolean
array()
$Subject : string
''
$Timeout : integer
10
This function will not work with the win32 version.
$Username : string
''
$Version : string
'5.2.1'
$WordWrap : integer
0
$XMailer : string
''
$action_function : string
''
$CustomHeader
array()
$MIMEBody : string
''
access | protected |
---|
$MIMEHeader : string
''
access | protected |
---|
$ReplyTo
array()
$SentMIMEMessage : string
''
access | protected |
---|
$all_recipients
array()
$bcc
array()
$boundary
array()
$cc
array()
$error_count
0
$exceptions
false
$language
array()
$sign_cert_file
''
$sign_key_file
''
$sign_key_pass
''
$smtp
NULL
$to
array()
STOP_CONTINUE = 1
STOP_CRITICAL = 2
STOP_MESSAGE = 0