Definition at line 16 of file EMail.php.
◆ __construct()
EMail::__construct |
( |
| $subject = "", |
|
|
| $to = "" ) |
#- Create the e-mail, optionally assigning the subject and primary recipient.
- Parameters
-
string | $subject | The subject line of the email. |
string | $to | A comma-separated list of addresses for the primary recipient(s). |
Definition at line 82 of file EMail.php.
◆ _AppendDelimited()
EMail::_AppendDelimited |
( |
& | $onto, |
|
|
| $extra ) |
|
private |
Append something with a comma delimter onto the existing referenced string
- Parameters
-
stringref | &$onto | The string we will be appending to. |
string | $extra | What we will be appending |
- Returns
- string The new string.
Definition at line 101 of file EMail.php.
◆ AddBcc()
EMail::AddBcc |
( |
| $recipient | ) |
|
Add another Bcc recipient to the email
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new Bcc recipient list.
Definition at line 139 of file EMail.php.
◆ AddCc()
EMail::AddCc |
( |
| $recipient | ) |
|
Add another Cc recipient to the email
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new Cc recipient list.
Definition at line 130 of file EMail.php.
◆ AddErrorsTo()
EMail::AddErrorsTo |
( |
| $recipient | ) |
|
Add another Error recipient to the email
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new Error recipient list.
Definition at line 157 of file EMail.php.
◆ AddReplyTo()
EMail::AddReplyTo |
( |
| $recipient | ) |
|
Add another Reply-to address to the email
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new Reply-to list.
Definition at line 148 of file EMail.php.
◆ AddTo()
EMail::AddTo |
( |
| $recipient | ) |
|
Add another recipient to the email
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new recipient list.
Definition at line 113 of file EMail.php.
◆ Pretend()
EMail::Pretend |
( |
| $additional_headers = "" | ) |
|
Don't actually send the email, just output it directly in the stream(!). We use this method when we're doing regression testing.
- Parameters
-
string | $additional_headers | Any additional headers that are needed. |
Definition at line 246 of file EMail.php.
◆ PretendLog()
EMail::PretendLog |
( |
| $additional_headers = "" | ) |
|
Don't actually send the email, just log it.
- Parameters
-
string | $additional_headers | Any additional headers that are needed. |
Definition at line 227 of file EMail.php.
◆ Send()
EMail::Send |
( |
| $additional_headers = "" | ) |
|
Actually send the email
- Parameters
-
string | $additional_headers | Any additional headers that are needed. |
Definition at line 210 of file EMail.php.
◆ SetBody()
Set the body of the e-mail.
- Parameters
-
string | $recipient | The email address to append. |
- Returns
- string The new body of the e-mail.
Definition at line 200 of file EMail.php.
◆ SetFrom()
EMail::SetFrom |
( |
| $sender | ) |
|
Set the visible From address for the e-mail.
- Parameters
-
string | $recipient | The visible From address |
- Returns
- string The new From address
Definition at line 167 of file EMail.php.
◆ SetSender()
EMail::SetSender |
( |
| $sender | ) |
|
Set the envelope sender address for the e-mail.
- Parameters
-
string | $recipient | The e-mail address for the sender |
- Returns
- string The new envelope sender address.
Definition at line 178 of file EMail.php.
◆ SetSubject()
EMail::SetSubject |
( |
| $subject | ) |
|
Set the subject line for the email
- Parameters
-
string | $recipient | The new subject line. |
- Returns
- string The new subject line.
Definition at line 189 of file EMail.php.
◆ To()
Get the current recipient list.
- Returns
- string The current recipient list.
Definition at line 121 of file EMail.php.
◆ $Bcc
◆ $Body
◆ $Cc
◆ $ErrorsTo
◆ $From
◆ $ReplyTo
◆ $Sender
◆ $Subject
◆ $To
The documentation for this class was generated from the following file: