Mail Gateway Message Branding
Branding allows the creation of a user experience in line with the company profile. The available branding capabilities in the H/OS 2 platform can be divided into two sections; quarantine-branding and this "mail message" branding (internally generated mail messages).
Contents |
Create a new mail template
If you would like to brand the mail messages that the appliance send, you may upload template files for each type of message. These templates contains dynamic variables written within brace brackets (eg. {MAIL_TO}). Each template type has it's own set of available variables. Template files can be downloaded from http://appliance-ip/download/templates_domain.tgz. Replace appliance-ip with the appliance's IP address. You have to be logged in to download it. If any of the templates are missing, the default will be used.
Note: Localized templates are available at; http://appliance-ip/download/templates_domain-sv_SE.tgz (eg. sv_SE and de_DE).
logo.png
This image can be replaced.
plain_mail.html
The plain mail template is used by HSL and the WrapMessage() function.
| Variable | Default | Description |
|---|---|---|
| {MAIL_FROM} | no default | original sender |
| {MESSAGE} | no default | value set by for example WrapMessage() in HSL. |
| {SUBJECT} | no default | value set by for example WrapMessage() in HSL. |
license_user_error.html
The license_user_error mail template is sent to the sending/receiving user when a message to him cannot be delivered due to a license issue.
| Variable | Default | Description |
|---|---|---|
| {MESSAGE_FROM} | no default | address of sender / or recipient |
| {MAIL_FROM} | noreply@example.org | Value of configuration key system_contact_mail. |
| {SIGNATURE} | Example Admin | Value of configuration key system_contact_name |
domain_report.html
The domain report template is used when sending domain statistics reports.
| Variable | Default | Description |
|---|---|---|
| {MAIL_FROM} | noreply@example.org | If sent from the system the default is the value of the configuration key system_contact_mail. |
| {SIGNATURE} | Example Admin | Value of configuration key system_contact_name |
| {STATISTICS} | no default | Statistics |
| {DOMAIN} | no default | Primary domain for report. |
| {SCHEDULE} | no default | Time for report (M 7:30) |
| {TIMESTAMP} | no default | Time of domain for report (DD MMM YYYY) |
| {TIMESTAMPLONG} | no default | Full timestamp of domain for report |
quarantine_new_user.html
Template for quarantine invitations. Subject is fetched from the title-tag in the template.
| Variable | Default | Description |
|---|---|---|
| {MAIL_TO} | no default | Mail address of recipient. |
| {MAIL_FROM} | noreply@example.org | If sent from the system the default is the value of the configuration key system_contact_mail. |
| {SIGNATURE} | Example Admin | Value of configuration key system_contact_name |
| {QUARANTINE_URL} | no default | value set by for quarantine profile. |
| {QUARANTINE_ACCOUNT} | no default | user account for quarantine. |
| {QUARANTINE_PASSWORD} | no default | password for quarantine. |
quarantine_forgot_password.html
Template used to send out new password (see documentation about Quarantine templates and mail_template setting). Subject is fetched from the title-tag in the template.
| Variable | Default | Description |
|---|---|---|
| {MAIL_TO} | no default | Mail address of recipient. |
| {MAIL_FROM} | noreply@example.org | If sent from the system the default is the value of the configuration key system_contact_mail. |
| {SIGNATURE} | Example Admin | Value of configuration key system_contact_name |
| {QUARANTINE_ACCOUNT} | no default | user account for quarantine. |
| {QUARANTINE_PASSWORD} | no default | password for quarantine. |
| {REQUEST_IP} | no default | IP address of request |
quarantine_report.html
Template for mail quarantine reports. Subject is fetched from the title-tag in the template.
| Variable | Default | Description |
|---|---|---|
| {MAIL_TO} | no default | Mail address of recipient. |
| {MAIL_FROM} | noreply@example.org | If sent from the system the default is the value of the configuration key system_contact_mail. |
| {SIGNATURE} | Example Admin | Value of configuration key system_contact_name |
| {QUARANTINE_URL} | no default | value set by for quarantine profile. |
| {QUARANTINE_ACCOUNT} | no default | user account for quarantine. |
| {QUARANTINE_HASHKEY} | no default | hashkey for quarantine. |
| {QUARANTINE_MESSAGE_COUNT} | no default | unread mail in quarantine |
| {QUARANTINE_MESSAGES} | no default | table containg mail, no headers are included and each mail is 1-tr and 3-td. |
| {QUARANTINE_PROFILE} | no default | current mailprofile:X |
Upload your template
Templates are stored on the internal FTP in the SPG, to add a new one, create a folder in the templates/domain/ (if this folder does not exist, which it probably do not do - create it first) name as your profile (eg. my_template_1) and upload your template files file.
The folder structure should at least look like this.
ftp://address/
|- templates/
|- domain/
|- my_template_1/
|- logo.png
|- plain_mail.html
|- ...
Use your template
Select your custom template for one of the Mail Gateway domains, on the Domains section in the Web Administration.
