Function Mail_dispatcher_base->dispatch
Definitions
sources/mail.php
- Send out the e-mail according to the current dispatcher configuration.
- Visibility: public
- 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 |
| $message_web | LONG_TEXT | required parameter | N/A | N/A | The alternate message to use in the web version, as Comcode (blank: same as $message_raw) |
| $to_emails | ?array | Null | N/A | N/A | The destination (recipient) e-mail address(es) [array of strings] (null: site staff address) |
| $to_names | ?mixed | Null | N/A | N/A | The recipient name(s). Array or string. (null: site name) |
| $from_email | Blank (empty string) | N/A | N/A | The reply-to address (blank: site staff address) | |
| $from_name | string | Blank (empty string) | N/A | N/A | The from name (blank: site name) |
Return
- A pair: Whether it worked, and an error message (null: skipped)
- Type: ?array
- Set: N/A
- Range: N/A