Function __global->newsletter_preview
Definitions
sources/newsletter.php
- Generate a newsletter preview in full HTML and full text.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: array
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $message_raw | string | required parameter | N/A | N/A | The message |
| $subject | string | required parameter | N/A | N/A | The subject |
| $lang | LANGUAGE_NAME | required parameter | N/A | N/A | The language |
| $html_only | boolean | required parameter | N/A | N/A | Send in HTML only |
| $forename | ?string | Null | N/A | N/A | Forename (null: reasonable default) |
| $surname | ?string | Null | N/A | N/A | Surname (null: reasonable default) |
| $name | ?string | Null | N/A | N/A | Name (null: reasonable default) |
| $email_address | ?string | Null | N/A | N/A | E-mail address (null: reasonable default) |
| $send_id | ?string | Null | N/A | N/A | Send ID (null: reasonable default) |
| $hash | ?string | Null | N/A | N/A | Password hash (null: reasonable default) |
| $template | ID_TEXT | N/A | N/A | The mail template to preview with |
Return
- A triple: HTML version, Text version, Whether the e-mail has to be fully HTML
- Type: array
- Set: N/A
- Range: N/A