$AltBody = ""
[line 104]
Sets the text-only body of the message. 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.
$attachment = array()
[line 225]
Tags:
$bcc = array()
[line 223]
Tags:
$Body = ""
[line 95]
Sets the Body of the message. This can be either an HTML or text body.
If HTML then run IsHTML(true).
$boundary = array()
[line 228]
Tags:
$cc = array()
[line 222]
Tags:
$CharSet = "iso-8859-1"
[line 44]
Sets the CharSet of the message.
$ConfirmReadingTo = ""
[line 142]
Sets the email address that a reading confirmation will be sent.
$ContentType = "text/plain"
[line 50]
Sets the Content-type of the message.
$CustomHeader = array()
[line 226]
Tags:
$Encoding = "8bit"
[line 57]
Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".
$ErrorInfo = ""
[line 63]
Holds the most recent mailer error message.
$error_count = 0
[line 230]
Tags:
$From = "root@localhost"
[line 69]
Sets the From email address for the message.
$FromName = "Root User"
[line 75]
Sets the From name of the message.
$Helo = ""
[line 176]
Sets the SMTP HELO of the message (Default is $Hostname).
$Host = "localhost"
[line 164]
Sets the SMTP hosts. 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 = ""
[line 150]
Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.
$language = array()
[line 229]
Tags:
$LE = "\n"
[line 231]
Tags:
$Mailer = "mail"
[line 117]
Method to send mail: ("mail", "sendmail", or "smtp").
$message_type = ""
[line 227]
Tags:
$Password = ""
[line 194]
Sets SMTP password.
$PluginDir = ""
[line 130]
Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.
$Port = 25
[line 170]
Sets the default SMTP server port.
$Priority = 3
[line 38]
Email priority (1 = High, 3 = Normal, 5 = low).
$ReplyTo = array()
[line 224]
Tags:
$Sender = ""
[line 82]
Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.
$Sendmail = "/usr/sbin/sendmail"
[line 123]
Sets the path of the sendmail program.
$smtp = NULL
[line 220]
Tags:
$SMTPAuth = false
[line 182]
Sets SMTP authentication. Utilizes the Username and Password variables.
$SMTPDebug = false
[line 207]
Sets SMTP class debugging on or off.
$SMTPKeepAlive = false
[line 215]
Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().
$Subject = ""
[line 88]
Sets the Subject of the message.
$Timeout = 10
[line 201]
Sets the SMTP server timeout in seconds. This function will not work with the win32 version.
$to = array()
[line 221]
Tags:
$Username = ""
[line 188]
Sets SMTP username.
$Version = "1.73"
[line 136]
Holds PHPMailer version.
$WordWrap = 0
[line 111]
Sets word wrapping on the body of the message to a given number of characters.
method AddAddress [line 294]
void AddAddress(
string
$address, [string
$name = ""])
|
|
Adds a "To" address.
Parameters:
method AddAttachment [line 1004]
bool AddAttachment(
string
$path, [string
$name = ""], [string
$encoding = "base64"], [string
$type = "application/octet-stream"])
|
|
Adds an attachment from a path on the filesystem.
Returns false if the file could not be found or accessed.
Parameters:
method AddBCC [line 322]
void AddBCC(
string
$address, [string
$name = ""])
|
|
Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Parameters:
method AddCC [line 308]
void AddCC(
string
$address, [string
$name = ""])
|
|
Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.
Parameters:
method AddCustomHeader [line 1502]
void AddCustomHeader(
$custom_header)
|
|
Adds a custom header.
Parameters:
method AddEmbeddedImage [line 1282]
bool AddEmbeddedImage(
string
$path, string
$cid, [string
$name = ""], [string
$encoding = "base64"], [string
$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".
Parameters:
method AddrAppend [line 628]
string AddrAppend(
$type,
$addr)
|
|
Creates recipient headers.
Tags:
Parameters:
method AddReplyTo [line 334]
void AddReplyTo(
string
$address, [string
$name = ""])
|
|
Adds a "Reply-to" address.
Parameters:
method AddrFormat [line 646]
string AddrFormat(
$addr)
|
|
Formats an address correctly.
Tags:
Parameters:
method AddStringAttachment [line 1255]
void AddStringAttachment(
string
$string, string
$filename, [string
$encoding = "base64"], [string
$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.
Parameters:
method AttachAll [line 1035]
Attaches all fs, string, and binary attachments to the message.
Returns an empty string on failure.
Tags:
method ClearAddresses [line 1336]
Clears all recipients assigned in the TO array. Returns void.
method ClearAllRecipients [line 1369]
void ClearAllRecipients(
)
|
|
Clears all recipients assigned in the TO, CC and BCC array. Returns void.
method ClearAttachments [line 1380]
Clears all previously set filesystem, string, and binary attachments. Returns void.
method ClearBCCs [line 1352]
Clears all recipients assigned in the BCC array. Returns void.
method ClearCCs [line 1344]
Clears all recipients assigned in the CC array. Returns void.
method ClearCustomHeaders [line 1388]
void ClearCustomHeaders(
)
|
|
Clears all custom headers. Returns void.
method ClearReplyTos [line 1360]
Clears all recipients assigned in the ReplyTo array. Returns void.
method CreateBody [line 863]
Assembles the message body. Returns an empty string on failure.
Tags:
method CreateHeader [line 765]
Assembles message header.
Tags:
method EncodeFile [line 1092]
string EncodeFile(
$path, [
$encoding = "base64"])
|
|
Encodes attachment in requested format. Returns an empty string on failure.
Tags:
Parameters:
method EncodeHeader [line 1145]
string EncodeHeader(
$str, [
$position = 'text'])
|
|
Encode a header string to best of Q, B, quoted or none.
Tags:
Parameters:
method EncodeQ [line 1221]
string EncodeQ(
$str, [
$position = "text"])
|
|
Encode string to q encoding.
Tags:
Parameters:
method EncodeQP [line 1198]
Encode string to quoted-printable.
Tags:
Parameters:
method EncodeString [line 1114]
string EncodeString(
$str, [
$encoding = "base64"])
|
|
Encodes string to requested format. Returns an empty string on failure.
Tags:
Parameters:
method EndBoundary [line 949]
void EndBoundary(
$boundary)
|
|
Returns the end of a message boundary.
Tags:
Parameters:
method FixEOL [line 1491]
Changes every end of line from CR or LF to CRLF.
Tags:
Parameters:
method GetBoundary [line 929]
void GetBoundary(
$boundary,
$charSet,
$contentType,
$encoding)
|
|
Returns the start of a message boundary.
Tags:
Parameters:
method HeaderLine [line 977]
string HeaderLine(
$name,
$value)
|
|
Returns a formatted header line.
Tags:
Parameters:
method InlineImageExists [line 1314]
bool InlineImageExists(
)
|
|
Returns true if an inline attachment is present.
Tags:
method IsError [line 1482]
Returns true if an error occurred.
method IsHTML [line 243]
Sets message type to HTML.
Parameters:
method IsMail [line 262]
Sets Mailer to send message using PHP mail() function.
method IsQmail [line 278]
Sets Mailer to send message using the qmail MTA.
method IsSendmail [line 270]
Sets Mailer to send message using the $Sendmail program.
method IsSMTP [line 254]
Sets Mailer to send message using SMTP.
method Lang [line 1468]
Returns a message in the appropriate language.
Tags:
Overridden in child classes as:
- C_mailer::Lang()
- Returns a message in the appropriate language.
Parameters:
method MailSend [line 429]
bool MailSend(
$header,
$body)
|
|
Sends mail using the PHP mail() function.
Tags:
Parameters:
method RFCDate [line 1413]
Returns the proper RFC 822 formatted date.
Tags:
method Send [line 351]
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.
method SendmailSend [line 399]
bool SendmailSend(
$header,
$body)
|
|
Sends mail using the $Sendmail program.
Tags:
Parameters:
method ServerHostname [line 1452]
Returns the server hostname or 'localhost.localdomain' if unknown.
Tags:
method ServerVar [line 1430]
mixed ServerVar(
$varName)
|
|
Returns the appropriate server variable. Should work with both PHP 4.1.0+ as well as older versions. Returns an empty string if nothing is found.
Tags:
Parameters:
method SetError [line 1403]
Adds the error message to the error container.
Returns void.
Tags:
Overridden in child classes as:
- C_mailer::SetError()
- Replace the default SetError
Parameters:
method SetLanguage [line 604]
bool SetLanguage(
string
$lang_type, [string
$lang_path = "language/"])
|
|
Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.
Tags:
Parameters:
method SetMessageType [line 958]
Sets the message type.
Tags:
method SetWordWrap [line 743]
Set the body wrapping.
Tags:
method SmtpClose [line 584]
Closes the active SMTP session if one exists.
method SmtpConnect [line 534]
Initiates a connection to an SMTP server. Returns false if the operation failed.
Tags:
method SmtpSend [line 467]
bool SmtpSend(
$header,
$body)
|
|
Sends mail via SMTP using PhpSMTP (Author: Chris Ryan). Returns bool. Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
Tags:
Parameters:
method TextLine [line 986]
Returns a formatted mail line.
Tags:
Parameters:
method WrapText [line 665]
string 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.
Tags:
Parameters: