Docs For Class EMail

## EMail

Description

Lightweight class for sending an e-mail.

Located in /EMail.php (line 16)

Method Summary
EMail EMail ([string $subject = ""], [string $to = ""])
string AddBcc (string $recipient)
string AddCc (string $recipient)
string AddErrorsTo (string $recipient)
string AddReplyTo (string $recipient)
string AddTo (string $recipient)
void Send (string $recipient)
string SetBody ( $body, string $recipient)
string SetFrom ( $sender, string $recipient)
string SetSender ( $sender, string $recipient)
string SetSubject ( $subject, string $recipient)
string _AppendDelimited (stringref &$onto, string $extra)
Methods
Constructor EMail (line 82)

Create the e-mail, optionally assigning the subject and primary recipient.

EMail EMail ([string $subject = ""], [string $to = ""])

- string $subject: The subject line of the email.
- string $to: A comma-separated list of addresses for the primary recipient(s).

AddBcc (line 131)

Add another Bcc recipient to the email

- return: The new Bcc recipient list.

string AddBcc (string $recipient)

- string $recipient: The email address to append.

AddCc (line 122)

Add another Cc recipient to the email

- return: The new Cc recipient list.

string AddCc (string $recipient)

- string $recipient: The email address to append.

AddErrorsTo (line 149)

Add another Error recipient to the email

- return: The new Error recipient list.

string AddErrorsTo (string $recipient)

- string $recipient: The email address to append.

AddReplyTo (line 140)

Add another Reply-to address to the email

- return: The new Reply-to list.

string AddReplyTo (string $recipient)

- string $recipient: The email address to append.

AddTo (line 113)

Add another recipient to the email

- return: The new recipient list.

string AddTo (string $recipient)

- string $recipient: The email address to append.

Send (line 202)

Actually send the email

void Send (string $recipient)

- string $recipient: The email address to append.

SetBody (line 192)

Set the body of the e-mail.

- return: The new body of the e-mail.

string SetBody ( $body, string $recipient)

- string $recipient: The email address to append.
- $body

SetFrom (line 159)

Set the visible From address for the e-mail.

- return: The new From address

string SetFrom ( $sender, string $recipient)

- string $recipient: The visible From address
- $sender

SetSender (line 170)

Set the envelope sender address for the e-mail.

- return: The new envelope sender address.

string SetSender ( $sender, string $recipient)

- string $recipient: The e-mail address for the sender
- $sender

SetSubject (line 181)

Set the subject line for the email

- return: The new subject line.

string SetSubject ( $subject, string $recipient)

- string $recipient: The new subject line.
- $subject

_AppendDelimited (line 101)

Append something with a comma delimter onto the existing referenced string

- return: The new string.

string _AppendDelimited (stringref &$onto, string $extra)

- stringref &$onto: The string we will be appending to.
- string $extra: What we will be appending

Documentation generated on Fri, 13 Jan 2012 23:40:15 +1300 by phpDocumentor 1.4.3