Overview
The 'Email' tab is divided into three subsections: 'SMTP Configuration' for setting up SMTP server details, 'Notification Email' for configuring where notifications are sent to, and 'Backup Summary' for configuring daily summary emails.
SMTP Configuration
This section allows Email server settings to be configured, including security settings.
|
Option
|
Description
|
|---|---|
| Sender's Email Address | The email address the summary emails will be sent from. |
| SMTP Server | The address (DNS or IP) of the SMTP server to use for sending. |
| Connection Type and Port |
The type of connection used by the SMTP server. Supported options are: Plain Text Secure Sockets (SSL/TLS) Transport Layer Security (STARTTLS) |
| Authentication |
The authentication method used by the SMTP server. Supported options are: None Auto-Detect Challenge/Response Authentication (CRAM-MD5) Secure Username/Password login (AUTH LOGIN) Username/Password login (AUTH PLAIN) Microsoft NT LAN Manager (NTLM) |
| Username and Password | The username and password for the SMTP server. If left blank, no username will be used. |
| Test Email | Sends a test message to the recipients entered in the test box. If there are errors in the send, they will be reported back. |
Notification Email
This section allows the recipients and subject to be specified for notification emails. These settings are applied to any notification emails sent according to the 'Notifications' section of the SiteManager Platform 'Settings'.
|
Option
|
Description
|
|---|---|
| Recipients' Email Addresses | Email addresses to send notification emails - may be a semicolon-separated list. |
| Email Subject | Subject to be set on notification emails with optional variable input. |
The email subject can be specified using replaceable parameters.
Replaceable parameters are specified by starting them with a dollar character and optionally surrounding them in curly braces, for example {$example}. Available parameters are:
|
Parameter
|
Description
|
|---|---|
{$servername} |
Name of the SiteManager Platform server as specified in the 'System' page of the 'Settings'. |
{$date} |
The date in YYYYMMDD format |
{$isodate} |
ISO 8601 timestamp of the date - YYYY-MM-DD |
{$notificationtype} |
The type of notification. Possible types are: Backup Successful Backup Failed Backup Started Intra-daily Backup Successful Update Found Testing Slack Testing Email Remote Synchronization Started Remote Synchronization Successful Remote Synchronization Failed Restore Started Restore Successful Restore Failed Disk Space Low Repository Uncontactable |
{$agent} |
Name of the agent that triggered the notification. |
{$definitionname} |
Name of the backup definition that triggered the notification. |
{$schedulename} |
Name of the schedule that triggered the notification. |
{$reponame} |
Name of the repository being used. |
{$backuplevel} |
The backup level. Can be one of the following: Full Differential Incremental |
{$backuptype} |
The type of operation being performed. Can be one of the following operations: Image Image Restore File and Folder Backup File and Folder Restore Exchange Backup Exchange Restore SQL Backup SQL Restore Clone |
If a variable doesn't expand to anything and it's in a curly brace section, the whole curly brace section will be omitted. This can be used to hide extra spacing and text. For example, if the variable string below is used:
Notification - $notificationtype{ on computer $agent} |
It will expand to "Notification - Backup Started on computer MYCOMPUTER" for a backup start notification and "Notification - Disk Space Low" for a disk space low notification.
Backup Summary
The summary section allows the configuration of daily backup summary emails as below:
The options available are:
| Option | Description | |
| Enable | This toggle can be used to turn summary emails on or off. | |
| Recipients' Email Addresses | Email addresses to send notification emails - may be a semicolon-separated list. | |
| Send Time | The time when the daily email will be sent. | |
| Email Subject | Subject of the email with optional variable input. | |
| Days To Send | The days when an email will be sent. | |
| Select Columns | Which columns will appear in the summary email. Changes to this section are reflected in the email preview underneath. | |
| Select Options | Additional options to appear in the summary email. Changes to this section are reflected in the email preview underneath. | |
| Update Available | The email will state whether a Site Manager server update is available or not. | |
| Remote Sync | Inserts an additional section and table summarising Remote Sync activity. | |
| Unsuccessful Backup Details Only | When selected, the backup details table will only show information for failed backups. Successful backups are briefly summarised instead. | |
| Computer Warnings | Additional section detailing all computer warning information available. | |
A preview of the daily email with the selected columns is shown below the settings.
The email subject can be specified using replaceable parameters. Replaceable parameters are specified by starting them with a dollar character (and optionally surrounding them in curly braces) - {$example}. Available parameters are:
|
Parameter
|
Description
|
|---|---|
{$servername} |
Name of the SiteManager Platform server as specified in 'Settings' then 'System' |
{$date} |
The date in YYYYMMDD format |
{$isodate} |
ISO 8601 timestamp of the date - YYYY-MM-DD |
{$notificationtype} |
This will be Backup Summary |