Docs For Class PHPMailer

$AltBody = ""

[line 96]

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.

Type:

string

[ Top ]

$attachment = array()

[line 217]

Tags:

access:

private

Type:

mixed

[ Top ]

$bcc = array()

[line 215]

Tags:

access:

private

Type:

mixed

[ Top ]

$Body = ""

[line 87]

Sets the Body of the message. This can be either an HTML or text body.

If HTML then run IsHTML(true).

Type:

string

[ Top ]

$boundary = array()

[line 220]

Tags:

access:

private

Type:

mixed

[ Top ]

$cc = array()

[line 214]

Tags:

access:

private

Type:

mixed

[ Top ]

$CharSet = "iso-8859-1"

[line 36]

Sets the CharSet of the message.

Type:

string

[ Top ]

$ConfirmReadingTo = ""

[line 134]

Sets the email address that a reading confirmation will be sent.

Type:

string

[ Top ]

$ContentType = "text/plain"

[line 42]

Sets the Content-type of the message.

Type:

string

[ Top ]

$CustomHeader = array()

[line 218]

Tags:

access:

private

Type:

mixed

[ Top ]

$Encoding = "8bit"

[line 49]

Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".

Type:

string

[ Top ]

$ErrorInfo = ""

[line 55]

Holds the most recent mailer error message.

Type:

string

[ Top ]

$error_count = 0

[line 222]

Tags:

access:

private

Type:

mixed

[ Top ]

$From = "root@localhost"

[line 61]

Sets the From email address for the message.

Type:

string

[ Top ]

$FromName = "Root User"

[line 67]

Sets the From name of the message.

Type:

string

[ Top ]

$Helo = ""

[line 168]

Sets the SMTP HELO of the message (Default is $Hostname).

Type:

string

[ Top ]

$Host = "localhost"

[line 156]

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.

Type:

string

[ Top ]

$Hostname = ""

[line 142]

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'.

Type:

string

[ Top ]

$language = array()

[line 221]

Tags:

access:

private

Type:

mixed

[ Top ]

$LE = "\n"

[line 223]

Tags:

access:

private

Type:

mixed

[ Top ]

$Mailer = "mail"

[line 109]

Method to send mail: ("mail", "sendmail", or "smtp").

Type:

string

[ Top ]

$message_type = ""

[line 219]

Tags:

access:

private

Type:

mixed

[ Top ]

$Password = ""

[line 186]

Sets SMTP password.

Type:

string

[ Top ]

$PluginDir = ""

[line 122]

Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.

Type:

string

[ Top ]

$Port = 25

[line 162]

Sets the default SMTP server port.

Type:

int

[ Top ]

$Priority = 3

[line 30]

Email priority (1 = High, 3 = Normal, 5 = low).

Type:

int

[ Top ]

$ReplyTo = array()

[line 216]

Tags:

access:

private

Type:

mixed

[ Top ]

$Sender = ""

[line 74]

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.

Type:

string

[ Top ]

$Sendmail = "/usr/sbin/sendmail"

[line 115]

Sets the path of the sendmail program.

Type:

string

[ Top ]

$smtp = NULL

[line 212]

Tags:

access:

private

Type:

mixed

[ Top ]

$SMTPAuth = false

[line 174]

Sets SMTP authentication. Utilizes the Username and Password variables.

Type:

bool

[ Top ]

$SMTPDebug = false

[line 199]

Sets SMTP class debugging on or off.

Type:

bool

[ Top ]

$SMTPKeepAlive = false

[line 207]

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().

Type:

bool

[ Top ]

$Subject = ""

[line 80]

Sets the Subject of the message.

Type:

string

[ Top ]

$Timeout = 10

[line 193]

Sets the SMTP server timeout in seconds. This function will not work with the win32 version.

Type:

int

[ Top ]

$to = array()

[line 213]

Tags:

access:

private

Type:

mixed

[ Top ]

$Username = ""

[line 180]

Sets SMTP username.

Type:

string

[ Top ]

$Version = "1.72"

[line 128]

Holds PHPMailer version.

Type:

string

[ Top ]

$WordWrap = 0

[line 103]

Sets word wrapping on the body of the message to a given number of characters.

Type:

int

[ Top ]

method AddAddress [line 286]

void AddAddress(
string
$address, [string
$name = ""])

Adds a "To" address.

Parameters:

string	$address
string	$name

[ Top ]

method AddAttachment [line 996]

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:

string	$path	Path to the attachment.
string	$name	Overrides the attachment name.
string	$encoding	File encoding (see $Encoding).
string	$type	File extension (MIME) type.

[ Top ]

method AddBCC [line 314]

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:

string	$address
string	$name

[ Top ]

method AddCC [line 300]

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:

string	$address
string	$name

[ Top ]

method AddCustomHeader [line 1492]

void AddCustomHeader(

$custom_header)

Adds a custom header.

Parameters:

$custom_header

[ Top ]

method AddEmbeddedImage [line 1272]

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:

string	$path	Path to the attachment.
string	$cid	Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.
string	$name	Overrides the attachment name.
string	$encoding	File encoding (see $Encoding).
string	$type	File extension (MIME) type.

[ Top ]

method AddrAppend [line 620]

string AddrAppend(

$type, 
$addr)

Creates recipient headers.

Tags:

access:

private

Parameters:

	$type
	$addr

[ Top ]

method AddReplyTo [line 326]

void AddReplyTo(
string
$address, [string
$name = ""])

Adds a "Reply-to" address.

Parameters:

string	$address
string	$name

[ Top ]

method AddrFormat [line 638]

string AddrFormat(

$addr)

Formats an address correctly.

Tags:

access:

private

Parameters:

$addr

[ Top ]

method AddStringAttachment [line 1245]

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:

string	$string	String attachment data.
string	$filename	Name of the attachment.
string	$encoding	File encoding (see $Encoding).
string	$type	File extension (MIME) type.

[ Top ]

method AttachAll [line 1027]

string AttachAll(
)

Attaches all fs, string, and binary attachments to the message.

Returns an empty string on failure.

Tags:

access:

private

[ Top ]

method ClearAddresses [line 1326]

void ClearAddresses(
)

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

[ Top ]

method ClearAllRecipients [line 1359]

void ClearAllRecipients(
)

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

[ Top ]

method ClearAttachments [line 1370]

void ClearAttachments(
)

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

[ Top ]

method ClearBCCs [line 1342]

void ClearBCCs(
)

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

[ Top ]

method ClearCCs [line 1334]

void ClearCCs(
)

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

[ Top ]

method ClearCustomHeaders [line 1378]

void ClearCustomHeaders(
)

Clears all custom headers. Returns void.

[ Top ]

method ClearReplyTos [line 1350]

void ClearReplyTos(
)

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

[ Top ]

method CreateBody [line 855]

string CreateBody(
)

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

Tags:

access:

private

[ Top ]

method CreateHeader [line 757]

string CreateHeader(
)

Assembles message header.

Tags:

access:

private

[ Top ]

method EncodeFile [line 1084]

string EncodeFile(

$path, [
$encoding = "base64"])

Encodes attachment in requested format. Returns an empty string on failure.

Tags:

access:

private

Parameters:

	$path
	$encoding

[ Top ]

method EncodeHeader [line 1134]

string EncodeHeader(

$str, [
$position = 'text'])

Encode a header string to best of Q, B, quoted or none.

Tags:

access:

private

Parameters:

	$str
	$position

[ Top ]

method EncodeQ [line 1211]

string EncodeQ(

$str, [
$position = "text"])

Encode string to q encoding.

Tags:

access:

private

Parameters:

	$str
	$position

[ Top ]

method EncodeQP [line 1188]

string EncodeQP(

$str)

Encode string to quoted-printable.

Tags:

access:

private

Parameters:

$str

[ Top ]

method EncodeString [line 1103]

string EncodeString(

$str, [
$encoding = "base64"])

Encodes string to requested format. Returns an empty string on failure.

Tags:

access:

private

Parameters:

	$str
	$encoding

[ Top ]

method EndBoundary [line 941]

void EndBoundary(

$boundary)

Returns the end of a message boundary.

Tags:

access:

private

Parameters:

$boundary

[ Top ]

method FixEOL [line 1481]

string FixEOL(

$str)

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

Tags:

access:

private

Parameters:

$str

[ Top ]

method GetBoundary [line 921]

void GetBoundary(

$boundary, 
$charSet, 
$contentType, 
$encoding)

Returns the start of a message boundary.

Tags:

access:

private

Parameters:

	$boundary
	$charSet
	$contentType
	$encoding

[ Top ]

method HeaderLine [line 969]

string HeaderLine(

$name, 
$value)

Returns a formatted header line.

Tags:

access:

private

Parameters:

	$name
	$value

[ Top ]

method InlineImageExists [line 1304]

bool InlineImageExists(
)

Returns true if an inline attachment is present.

Tags:

access:

private

[ Top ]

method IsError [line 1472]

bool IsError(
)

Returns true if an error occurred.

[ Top ]

method IsHTML [line 235]

void IsHTML(
bool
$bool)

Sets message type to HTML.

Parameters:

bool

$bool

[ Top ]

method IsMail [line 254]

void IsMail(
)

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

[ Top ]

method IsQmail [line 270]

void IsQmail(
)

Sets Mailer to send message using the qmail MTA.

[ Top ]

method IsSendmail [line 262]

void IsSendmail(
)

Sets Mailer to send message using the $Sendmail program.

[ Top ]

method IsSMTP [line 246]

void IsSMTP(
)

Sets Mailer to send message using SMTP.

[ Top ]

method Lang [line 1458]

string Lang(

$key)

Returns a message in the appropriate language.

Tags:

access:

private

Parameters:

$key

[ Top ]

method MailSend [line 421]

bool MailSend(

$header, 
$body)

Sends mail using the PHP mail() function.

Tags:

access:

private

Parameters:

	$header
	$body

[ Top ]

method RFCDate [line 1403]

string RFCDate(
)

Returns the proper RFC 822 formatted date.

Tags:

access:

private

[ Top ]

method Send [line 343]

bool 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.

[ Top ]

method SendmailSend [line 391]

bool SendmailSend(

$header, 
$body)

Sends mail using the $Sendmail program.

Tags:

access:

private

Parameters:

	$header
	$body

[ Top ]

method ServerHostname [line 1442]

string ServerHostname(
)

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

Tags:

access:

private

[ Top ]

method ServerVar [line 1420]

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:

access:

private

Parameters:

$varName

[ Top ]

method SetError [line 1393]

void SetError(

$msg)

Adds the error message to the error container.

Returns void.

Tags:

access:

private

Parameters:

$msg

[ Top ]

method SetLanguage [line 596]

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:

access:

public

Parameters:

string	$lang_type	Type of language (e.g. Portuguese: "br")
string	$lang_path	Path to the language file directory

[ Top ]

method SetMessageType [line 950]

void SetMessageType(
)

Sets the message type.

Tags:

access:

private

[ Top ]

method SetWordWrap [line 735]

void SetWordWrap(
)

Set the body wrapping.

Tags:

access:

private

[ Top ]

method SmtpClose [line 576]

void SmtpClose(
)

Closes the active SMTP session if one exists.

[ Top ]

method SmtpConnect [line 526]

bool SmtpConnect(
)

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

Tags:

access:

private

[ Top ]

method SmtpSend [line 459]

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:

access:

private

Parameters:

	$header
	$body

[ Top ]

method TextLine [line 978]

string TextLine(

$value)

Returns a formatted mail line.

Tags:

access:

private

Parameters:

$value

[ Top ]

method WrapText [line 657]

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:

access:

private

Parameters:

	$message
	$length
	$qp_mode

[ Top ]

Class: PHPMailer

Class Overview

Author(s):

Copyright:

Variables

Methods

Class Details

Tags:

Class Variables

$AltBody = ""

$attachment = array()

Tags:

$bcc = array()

Tags:

$Body = ""

$boundary = array()

Tags:

$cc = array()

Tags:

$CharSet = "iso-8859-1"

$ConfirmReadingTo = ""

$ContentType = "text/plain"

$CustomHeader = array()

Tags:

$Encoding = "8bit"

$ErrorInfo = ""

$error_count = 0

Tags:

$From = "root@localhost"

$FromName = "Root User"

$Helo = ""

$Host = "localhost"

$Hostname = ""

$language = array()

Tags:

$LE = "\n"

Tags:

$Mailer = "mail"

$message_type = ""

Tags:

$Password = ""

$PluginDir = ""

$Port = 25

$Priority = 3

$ReplyTo = array()

Tags:

$Sender = ""

$Sendmail = "/usr/sbin/sendmail"

$smtp = NULL

Tags:

$SMTPAuth = false

$SMTPDebug = false

$SMTPKeepAlive = false

$Subject = ""

$Timeout = 10

$to = array()

Tags:

$Username = ""

$Version = "1.72"

$WordWrap = 0

Class Methods

method AddAddress [line 286]

Parameters:

method AddAttachment [line 996]

Parameters:

method AddBCC [line 314]

Parameters:

method AddCC [line 300]

Parameters:

method AddCustomHeader [line 1492]

Parameters:

method AddEmbeddedImage [line 1272]

Parameters:

method AddrAppend [line 620]

Tags:

Parameters:

method AddReplyTo [line 326]

Parameters:

method AddrFormat [line 638]

Tags: