Function __global->newsletter_prepare
Definitions
sources/newsletter.php
- Prepare a newsletter, with the Tempcode/Wrapper/Substitution flow.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: string
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $message_raw | string | required parameter | N/A | N/A | The unprocessed newsletter message |
| $subject | SHORT_TEXT | required parameter | N/A | N/A | The newsletter subject |
| $lang | ?LANGUAGE_NAME | Null | N/A | N/A | User language (null: default site language) |
| $forename | SHORT_TEXT | Blank (empty string) | N/A | N/A | Subscribers forename (blank: unknown) |
| $surname | SHORT_TEXT | Blank (empty string) | N/A | N/A | Subscribers surname (blank: unknown) |
| $name | ?SHORT_TEXT | Null | N/A | N/A | Subscribers name (or username) (null: generic) |
| $email_address | Blank (empty string) | N/A | N/A | Subscribers e-mail address | |
| $send_id | ID_TEXT | Blank (empty string) | N/A | N/A | Specially encoded ID of subscriber (begins either 'n' for newsletter subscriber, or 'm' for member - then has normal subscriber/member ID following) |
| $hash | SHORT_TEXT | Blank (empty string) | N/A | N/A | Password hash of subscriber (blank: can not unsubscribe by URL) |
| $extra_mappings | array | [] | N/A | N/A | Extra mappings to be substituted |
| $wrapper_tpl | ?string | NEWSLETTER_DEFAULT_FCOMCODE | N/A | N/A | Wrapper template (null: do not wrap) |
Return
- The processed newsletter message
- Type: string
- Set: N/A
- Range: N/A