Docs For Class PHPMailer

## Class PHPMailer

Description

PHPMailer - PHP email transport class

- copyright:

  2001 - 2003 Brent R. Matzelle

- author:

  Brent R. Matzelle

Located in Program_Root/class.phpmailer.php (line 20)

Variable Summary
string $AltBody
string $Body
string $CharSet
string $ConfirmReadingTo
string $ContentType
string $Encoding
string $ErrorInfo
string $From
string $FromName
string $Helo
string $Host
string $Hostname
string $Mailer
string $Password
string $PluginDir
int $Port
int $Priority
string $Sender
string $Sendmail
bool $SMTPAuth
bool $SMTPDebug
bool $SMTPKeepAlive
string $Subject
int $Timeout
string $Username
string $Version
int $WordWrap
Method Summary
void AddAddress (string $address, [string $name = ""])
bool AddAttachment (string $path, [string $name = ""], [string $encoding = "base64"], [string $type = "application/octet-stream"])
void AddBCC (string $address, [string $name = ""])
void AddCC (string $address, [string $name = ""])
void AddCustomHeader (mixed $custom_header)
bool AddEmbeddedImage (string $path, string $cid, [string $name = ""], [string $encoding = "base64"], [string $type = "application/octet-stream"])
void AddReplyTo (string $address, [string $name = ""])
void AddStringAttachment (string $string, string $filename, [string $encoding = "base64"], [string $type = "application/octet-stream"])
void ClearAddresses ()
void ClearAllRecipients ()
void ClearAttachments ()
void ClearBCCs ()
void ClearCCs ()
void ClearCustomHeaders ()
void ClearReplyTos ()
bool IsError ()
void IsHTML (bool $bool)
void IsMail ()
void IsQmail ()
void IsSendmail ()
void IsSMTP ()
bool Send ()
bool SetLanguage (string $lang_type, [string $lang_path = ""])
void SmtpClose ()
Variables
string $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.

string $Body = "" (line 87)

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

If HTML then run IsHTML(true).

string $CharSet = "iso-8859-1" (line 36)

Sets the CharSet of the message.

string $ConfirmReadingTo = "" (line 134)

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

string $ContentType = "text/plain" (line 42)

Sets the Content-type of the message.

string $Encoding = "8bit" (line 49)

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

string $ErrorInfo = "" (line 55)

Holds the most recent mailer error message.

string $From = "root@localhost" (line 61)

Sets the From email address for the message.

string $FromName = "Root User" (line 67)

Sets the From name of the message.

string $Helo = "" (line 169)

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

string $Host = "localhost" (line 157)

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.

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

string $Mailer = "mail" (line 109)

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

string $Password = "" (line 187)

Sets SMTP password.

string $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.

int $Port = 25 (line 163)

Sets the default SMTP server port.

int $Priority = 3 (line 30)

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

string $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.

string $Sendmail = "/usr/sbin/sendmail" (line 115)

Sets the path of the sendmail program.

bool $SMTPAuth = false (line 175)

Sets SMTP authentication. Utilizes the Username and Password variables.

bool $SMTPDebug = false (line 200)

Sets SMTP class debugging on or off.

bool $SMTPKeepAlive = false (line 208)

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

string $Subject = "" (line 80)

Sets the Subject of the message.

int $Timeout = 10 (line 194)

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

string $Username = "" (line 181)

Sets SMTP username.

string $Version = "1.71" (line 128)

Holds PHPMailer version.

int $WordWrap = 0 (line 103)

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

Methods
AddAddress (line 287)

Adds a "To" address.

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

- string $address
- string $name

AddAttachment (line 1000)

Adds an attachment from a path on the filesystem.

Returns false if the file could not be found or accessed.

bool AddAttachment (string $path, [string $name = ""], [string $encoding = "base64"], [string $type = "application/octet-stream"])

- string $path:

  Path to the attachment.

- string $name:

  Overrides the attachment name.

- string $encoding:

  File encoding (see $Encoding).

- string $type:

  File extension (MIME) type.

AddBCC (line 315)

Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

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

- string $address
- string $name

AddCC (line 301)

Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.

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

- string $address
- string $name

AddCustomHeader (line 1525)

Adds a custom header.

void AddCustomHeader (mixed $custom_header)
AddEmbeddedImage (line 1275)

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

bool AddEmbeddedImage (string $path, string $cid, [string $name = ""], [string $encoding = "base64"], [string $type = "application/octet-stream"])

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

AddReplyTo (line 327)

Adds a "Reply-to" address.

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

- string $address
- string $name

AddStringAttachment (line 1248)

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.

void AddStringAttachment (string $string, string $filename, [string $encoding = "base64"], [string $type = "application/octet-stream"])

- string $string:

  String attachment data.

- string $filename:

  Name of the attachment.

- string $encoding:

  File encoding (see $Encoding).

- string $type:

  File extension (MIME) type.

ClearAddresses (line 1329)

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

void ClearAddresses ()
ClearAllRecipients (line 1362)

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

void ClearAllRecipients ()
ClearAttachments (line 1373)

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

void ClearAttachments ()
ClearBCCs (line 1345)

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

void ClearBCCs ()
ClearCCs (line 1337)

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

void ClearCCs ()
ClearCustomHeaders (line 1381)

Clears all custom headers. Returns void.

void ClearCustomHeaders ()
ClearReplyTos (line 1353)

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

void ClearReplyTos ()
IsError (line 1505)

Returns true if an error occurred.

bool IsError ()
IsHTML (line 236)

Sets message type to HTML.

void IsHTML (bool $bool)

- bool $bool

IsMail (line 255)

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

void IsMail ()
IsQmail (line 271)

Sets Mailer to send message using the qmail MTA.

void IsQmail ()
IsSendmail (line 263)

Sets Mailer to send message using the $Sendmail program.

void IsSendmail ()
IsSMTP (line 247)

Sets Mailer to send message using SMTP.

void IsSMTP ()
Send (line 344)

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.

bool Send ()
SetLanguage (line 599)

Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.

- access: public

bool SetLanguage (string $lang_type, [string $lang_path = ""])

- string $lang_type:

  Type of language (e.g. Portuguese: "br")

- string $lang_path:

  Path to the language file directory

SmtpClose (line 579)

Closes the active SMTP session if one exists.

void SmtpClose ()

Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by phpDocumentor 1.2.0