Email message.
More...
|
static | factory (array $options=[]) |
| Create an email instance form an array of options. More...
|
|
Email message.
Definition at line 15 of file Email.php.
Elgg\Email::addAttachment |
( |
|
$attachment | ) |
|
Add an attachment.
- Parameters
-
mixed | $attachment | or or or an array |
- See also
- ::factory()
- Returns
- self
Definition at line 224 of file Email.php.
Elgg\Email::addHeader |
( |
|
$name, |
|
|
|
$value |
|
) |
| |
Adds/replaces an HTTP/IMF header.
- Parameters
-
string | $name | Header name |
mixed | $value | Header value |
- Returns
- self
Definition at line 191 of file Email.php.
static Elgg\Email::factory |
( |
array |
$options = [] | ) |
|
|
static |
Create an email instance form an array of options.
- Parameters
-
array | $options | Options 'from' - ElggEntity, or email string, or 'to' - ElggEntity, or email string, or 'subject' - subject string 'body' - body string 'params' - additional parameters 'headers' - HTTP/IMF headers |
- Returns
Definition at line 64 of file Email.php.
Elgg\Email::getAttachments |
( |
| ) |
|
Get all attachments.
- Returns
- []
Definition at line 249 of file Email.php.
Returns email body.
- Returns
- string
Definition at line 161 of file Email.php.
Returns sender address.
- Returns
Definition at line 104 of file Email.php.
Elgg\Email::getHeaders |
( |
| ) |
|
Returns headers.
- Returns
- array
Definition at line 211 of file Email.php.
Elgg\Email::getParams |
( |
| ) |
|
Returns additional params.
- Returns
- array
Definition at line 180 of file Email.php.
Elgg\Email::getSubject |
( |
| ) |
|
Returns the subject.
- Returns
- string
Definition at line 142 of file Email.php.
Returns recipient address.
- Returns
Definition at line 123 of file Email.php.
static Elgg\Email::prepareFrom |
( |
|
$from | ) |
|
|
staticprotected |
Converts mixed input to an instance of Zend addres.
- Parameters
-
- Returns
- Address
- Exceptions
-
Definition at line 260 of file Email.php.
static Elgg\Email::prepareTo |
( |
|
$to | ) |
|
|
staticprotected |
Converts mixed input to an instance of Zend addres.
- Parameters
-
- Returns
- Address
- Exceptions
-
Definition at line 292 of file Email.php.
Elgg\Email::setBody |
( |
|
$body = '' | ) |
|
Sets the email message body.
- Parameters
-
- Returns
- self
Definition at line 152 of file Email.php.
Elgg\Email::setFrom |
( |
Address |
$from | ) |
|
Sets sender address.
- Parameters
-
\Elgg\Email\Address | $from | Sender address |
- Returns
- self
Definition at line 95 of file Email.php.
Elgg\Email::setHeaders |
( |
array |
$headers = [] | ) |
|
Replaces header bag.
- Parameters
-
- Returns
- self
Definition at line 202 of file Email.php.
Elgg\Email::setParams |
( |
array |
$params = [] | ) |
|
Sets additional params.
- Parameters
-
- Returns
- self
Definition at line 171 of file Email.php.
Elgg\Email::setSubject |
( |
|
$subject = '' | ) |
|
Sets email subject.
- Parameters
-
- Returns
- self
Definition at line 133 of file Email.php.
Sets recipient address.
- Parameters
-
\Elgg\Email\Address | $to | Recipient address |
- Returns
- self
Definition at line 114 of file Email.php.
Elgg\Email::$attachments = [] |
|
protected |
Elgg\Email::$headers = [] |
|
protected |
The documentation for this class was generated from the following file: