Function __global->add_periodic_newsletter
Definitions
sources/newsletter2.php
- Make a periodic newsletter.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: int
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $subject | LONG_TEXT | required parameter | N/A | N/A | Subject |
| $message | LONG_TEXT | required parameter | N/A | N/A | Message |
| $lang | LANGUAGE_NAME | required parameter | N/A | N/A | Language to send for |
| $send_details | LONG_TEXT | required parameter | N/A | N/A | The data sent in each newsletter |
| $html_only | BINARY | required parameter | N/A | N/A | Whether to send in HTML only |
| $from_email | SHORT_TEXT | required parameter | N/A | N/A | From address |
| $from_name | SHORT_TEXT | required parameter | N/A | N/A | From name |
| $priority | SHORT_INTEGER | required parameter | N/A | N/A | Priority |
| $spreadsheet_data | LONG_TEXT | required parameter | N/A | N/A | Spreadsheet data of who to send to (JSON) |
| $frequency | SHORT_TEXT | required parameter | N/A | N/A | Send frequency |
| $day | SHORT_INTEGER | required parameter | N/A | N/A | Weekday to send on |
| $in_full | BINARY | 0 | N/A | N/A | Embed full articles |
| $template | ID_TEXT | N/A | N/A | Mail template to use, e.g. MAIL | |
| $last_sent | ?TIME | Null | N/A | N/A | When was last sent (null: now) |
Return
- The ID
- Type: AUTO_LINK
- Set: N/A
- Range: N/A