Function __global->send_newsletter
Definitions
sources/newsletter.php
- Send out the newsletter.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: object
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $message | LONG_TEXT | No | No | required parameter | N/A | N/A | The newsletter message |
| $subject | SHORT_TEXT | No | No | required parameter | N/A | N/A | The newsletter subject |
| $language | LANGUAGE_NAME | No | No | required parameter | N/A | N/A | The language |
| $send_details | array | No | No | required parameter | N/A | N/A | A map describing what newsletters the newsletter is being sent to |
| $html_only | BINARY | No | No | 0 | N/A | N/A | Whether to only send in HTML format |
| $from_email | No | No | Blank (empty string) | N/A | N/A | Override the e-mail address the mail is sent from (blank: staff address) | |
| $from_name | string | No | No | Blank (empty string) | N/A | N/A | Override the name the mail is sent from (blank: site name) |
| $priority | integer | No | No | 3 | N/A | 1 5 | The message priority (1=urgent, 3=normal, 5=low) |
| $spreadsheet_data | array | No | No | [] | 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 | No | No | N/A | N/A | The template used to show the e-mail |
Returns
- UI
- Type: Tempcode
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Send out the newsletter.
*
* @param LONG_TEXT $message The newsletter message
* @param SHORT_TEXT $subject The newsletter subject
* @param LANGUAGE_NAME $language The language
* @param array $send_details A map describing what newsletters the newsletter is being sent to
* @param BINARY $html_only Whether to only send in HTML format
* @param EMAIL $from_email Override the e-mail address the mail is sent from (blank: staff address)
* @param string $from_name Override the name the mail is sent from (blank: site name)
* @param integer $priority The message priority (1=urgent, 3=normal, 5=low)
* @range 1 5
* @param array $spreadsheet_data Spreadsheet data of extra subscribers. This is in the same software newsletter spreadsheet format that we export elsewhere.
* @param ID_TEXT $mail_template The template used to show the e-mail
* @return Tempcode UI
*/
function send_newsletter(string $message, string $subject, string $language, array $send_details, int $html_only = 0, string $from_email = '', string $from_name = '', int $priority = 3, array $spreadsheet_data = [], string $mail_template = 'MAIL') : object
* Send out the newsletter.
*
* @param LONG_TEXT $message The newsletter message
* @param SHORT_TEXT $subject The newsletter subject
* @param LANGUAGE_NAME $language The language
* @param array $send_details A map describing what newsletters the newsletter is being sent to
* @param BINARY $html_only Whether to only send in HTML format
* @param EMAIL $from_email Override the e-mail address the mail is sent from (blank: staff address)
* @param string $from_name Override the name the mail is sent from (blank: site name)
* @param integer $priority The message priority (1=urgent, 3=normal, 5=low)
* @range 1 5
* @param array $spreadsheet_data Spreadsheet data of extra subscribers. This is in the same software newsletter spreadsheet format that we export elsewhere.
* @param ID_TEXT $mail_template The template used to show the e-mail
* @return Tempcode UI
*/
function send_newsletter(string $message, string $subject, string $language, array $send_details, int $html_only = 0, string $from_email = '', string $from_name = '', int $priority = 3, array $spreadsheet_data = [], string $mail_template = 'MAIL') : object
