PHPMailer - PHP email transport class
| package | PHPMailer |
|---|---|
| author | Brent R. Matzelle |
| copyright | 2001 - 2003 Brent R. Matzelle |
AddAddress(string $address, string $name) : void
string
string
AddAttachment(string $path, string $name, string $encoding, string $type) : bool
Returns false if the file could not be found or accessed.
stringPath to the attachment.
stringOverrides the attachment name.
stringFile encoding (see $Encoding).
stringFile extension (MIME) type.
boolAddBCC(string $address, string $name) : void
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
string
string
AddCC(string $address, string $name) : void
Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
string
string
AddCustomHeader($custom_header) : void
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".
stringPath to the attachment.
stringContent ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
stringOverrides the attachment name.
stringFile encoding (see $Encoding).
stringFile extension (MIME) type.
boolAddReplyTo(string $address, string $name) : void
string
string
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.
stringString attachment data.
stringName of the attachment.
stringFile encoding (see $Encoding).
stringFile extension (MIME) type.
AddrAppend($type, $addr) : string
| access | private |
|---|
stringAddrFormat($addr) : string
| access | private |
|---|
stringAttachAll() : string
Returns an empty string on failure.
| access | private |
|---|
stringClearAddresses() : 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 | private |
|---|
stringCreateHeader() : string
| access | private |
|---|
stringEncodeFile($path, $encoding) : string
Returns an empty string on failure.
| access | private |
|---|
stringEncodeHeader($str, $position) : string
| access | private |
|---|
stringEncodeQ($str, $position) : string
| access | private |
|---|
stringEncodeQP($str) : string
| access | private |
|---|
stringEncodeString($str, $encoding) : string
Returns an empty string on failure.
| access | private |
|---|
stringEndBoundary($boundary)
| access | private |
|---|
FixEOL($str) : string
| access | private |
|---|
stringGetBoundary($boundary, $charSet, $contentType, $encoding)
| access | private |
|---|
HeaderLine($name, $value) : string
| access | private |
|---|
stringInlineImageExists() : bool
| access | private |
|---|
boolIsError() : bool
boolIsHTML(bool $bool) : void
bool
IsMail() : void
IsQmail() : void
IsSMTP() : void
IsSendmail() : void
MailSend($header, $body) : bool
| access | private |
|---|
boolRFCDate() : string
| access | private |
|---|
stringSend() : bool
If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.
boolSendmailSend($header, $body) : bool
| access | private |
|---|
boolServerHostname() : string
| access | private |
|---|
stringServerVar($varName) : mixed
Should work with both PHP 4.1.0+ as well as older versions. Returns an empty string if nothing is found.
| access | private |
|---|
mixedSetError($msg) : void
Returns void.
| access | private |
|---|
SetMessageType() : void
| access | private |
|---|
SetWordWrap() : void
| access | private |
|---|
SmtpClose() : void
SmtpConnect() : bool
Returns false if the operation failed.
| access | private |
|---|
boolSmtpSend($header, $body) : bool
Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
| access | private |
|---|
boolTextLine($value) : string
| access | private |
|---|
stringWrapText($message, $length, $qp_mode) : string
Original written by philippe.
| access | private |
|---|
string$AltBody : string
This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.
$Body : string
This can be either an HTML or text body. If HTML then run IsHTML(true).
$CharSet : string
$ConfirmReadingTo : string
$ContentType : string
$CustomHeader
$Encoding : string
Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
$ErrorInfo : string
$From : string
$FromName : string
$Helo
@var string
$Host : string
All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. "smtp1.example.com:25;smtp2.example.com"). Hosts will be tried in order.
$Hostname : string
If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
$LE
$Mailer : string
$Password
@var string
$PluginDir : string
This is now only useful if the SMTP class is in a different directory than the PHP include path.
$Port
@var int
$Priority : int
$ReplyTo
$SMTPAuth : bool
Utilizes the Username and Password variables.
$SMTPDebug
@var bool
$SMTPKeepAlive : bool
If this is set to true then to close the connection requires an explicit call to SmtpClose().
$Sender : string
If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
$Sendmail : string
$Subject : string
$Timeout : int
This function will not work with the win32 version.
$Username
@var string
$Version
@var string
$WordWrap : int
$bcc
$boundary
$cc
$error_count
$smtp
$to