Function Mail_dispatcher_base->tidy_parameters
Definitions
sources/mail.php
- Tidy up complex input data, and make some conclusions. Returns by reference.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
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 | The destination (recipient) e-mail address(es) [array of strings] (null: site staff address) |
| $to_names | ?mixed | required parameter | N/A | N/A | The recipient name(s). Array or string. (null: site name) |
| $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 |