Function __global->send_newsletter
Definitions
sources/newsletter.php
- Send out the newsletter.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: object
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $message | LONG_TEXT | required parameter | N/A | N/A | The newsletter message |
| $subject | SHORT_TEXT | required parameter | N/A | N/A | The newsletter subject |
| $language | 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 | 0 | N/A | N/A | Whether to only send in HTML format |
| $from_email | Blank (empty string) | N/A | N/A | Override the e-mail address the mail is sent from (blank: staff address) | |
| $from_name | string | Blank (empty string) | N/A | N/A | Override the name the mail is sent from (blank: site name) |
| $priority | integer | 3 | N/A | N/A | The message priority (1=urgent, 3=normal, 5=low) |
| $spreadsheet_data | array | [] | N/A | N/A | Spreadsheet data of extra subscribers. This is in the same software newsletter spreadsheet format that we export elsewhere. |
| $mail_template | ID_TEXT | N/A | N/A | The template used to show the e-mail |
Return
- UI
- Type: Tempcode
- Set: N/A
- Range: N/A