Function Mail_dispatcher_base->log_message
Definitions
sources/mail.php
- Log a message into the database.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $queued | boolean | required parameter | N/A | N/A | Whether the message is to be queued rather than just logged |
| $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_extended | LONG_TEXT | required parameter | N/A | N/A | The alternate Comcode to display in the web version of the message (blank: should be identical to $message_raw) |
| $to_emails | array | required parameter | N/A | N/A | The destination (recipient) e-mail addresses [array of strings] |
| $to_names | array | required parameter | N/A | N/A | The recipient names [array of strings] |
| $from_email | required parameter | N/A | N/A | The reply-to address (blank: site staff address) | |
| $from_name | string | required parameter | N/A | N/A | The from name (blank: site name) |
| $resource_guid | string | required parameter | N/A | N/A | The GUID for this message, passed by reference (blank: none generated) |
Return
- The queue ID (null: could not log)
- Type: ?AUTO_LINK
- Set: N/A
- Range: N/A