Function Mail_dispatcher_base->build_mail_components
Definitions
sources/mail.php
- Implementation-specific e-mail dispatcher, passed with pre-prepared/tidied e-mail component details for us to use.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $subject_line | string | required parameter | N/A | N/A | The subject of the mail in plain text |
| $message_raw | LONG_TEXT | required parameter | N/A | N/A | The message, as Comcode |
| $to_emails | array | required parameter | N/A | N/A | To e-mail addresses |
| $to_names | array | required parameter | N/A | N/A | To names |
| $from_email | required parameter | N/A | N/A | Reply-to e-mail address | |
| $from_name | string | required parameter | N/A | N/A | From name |
| $lang | LANGUAGE_NAME | required parameter | N/A | N/A | Language |
| $theme | ID_TEXT | required parameter | N/A | N/A | Theme |
| $resource_guid | ID_TEXT | required parameter | N/A | N/A | The GUID of this mail message (blank: none) |
Return
- A huge ordered list of mail components
- Type: array
- Set: N/A
- Range: N/A