Function Hook_task_send_newsletter->run
Definitions
sources/hooks/systems/tasks/send_newsletter.php
- Run the task hook.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $message_id | integer | required parameter | N/A | N/A | The newsletter message in the newsletter archive |
| $message_raw | LONG_TEXT | required parameter | N/A | N/A | The newsletter message |
| $subject | SHORT_TEXT | required parameter | N/A | N/A | The newsletter subject |
| $lang | LANGUAGE_NAME | required parameter | N/A | N/A | The language |
| $send_details | array | required parameter | N/A | N/A | A map describing what newsletters the newsletter is being sent to |
| $html_only | BINARY | required parameter | N/A | N/A | Whether to only send in HTML format |
| $from_email | required parameter | N/A | N/A | Override the e-mail address the mail is sent from (blank: staff address) | |
| $from_name | string | required parameter | N/A | N/A | Override the name the mail is sent from (blank: site name) |
| $priority | integer | required parameter | N/A | N/A | The message priority (1=urgent, 3=normal, 5=low) |
| $spreadsheet_data | array | required parameter | N/A | N/A | Spreadsheet data of extra subscribers (blank: none). This is in the same newsletter spreadsheet format that we export elsewhere. |
| $mail_template | ID_TEXT | required parameter | N/A | N/A | The template used to show the e-mail |
Return
- A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
- Type: ?array
- Set: N/A
- Range: N/A