Email Reports
The backup software can send reports by email. The strategy keys below allow you to select them and configure their behavior.
Report Types
Strategy keys used to choose which email reports to enable.
| Key | Control |
|---|---|
| Configuration.EmailTransferReports | Backup report, at the end of each schedule |
| Configuration.EmailSupervisionReports | Supervision report, every day at 8 a.m. |
The possible values for these keys are:
- true to enable the report
- false to disable it (default)
For more details on the different reports, refer to the configuration section in this online documentation.
Report Recipients
Allows you to define the list of destination email addresses for reports.
| Key | Parameter | Control |
|---|---|---|
| Configuration.EmailTransferReportsTo | <email address\> | Recipient of email reports |
The value is an email address.
To include multiple recipients, insert the strategy key as many times as you have destination addresses.
Report Language
Allows you to choose the language in which email reports are sent.
| Key | Parameter | Control |
|---|---|---|
| Configuration.EmailLanguage | \<language code\> | Report language |
The possible values for this key are:
- en-us English
- fr-fr French
By default, reports are sent in the language of the system on which the backup client is installed.
Backup Report Options
You can choose to send backup reports only in case of errors or always send them. An Excel file detailing the complete backup activity can also be attached to the report.
| Key | Parameter | Control |
|---|---|---|
| Configuration.EmailOnlyOnError | \<bool\> | Send only in case of error |
| Configuration.JoinBackupDetailsReport | \<bool\> | Attach the Excel file to the report |
| Configuration.HideContact | \<bool\> | Show or hide support contact details in the interface and email reports |
| Configuration.HideQuota | \<bool\> | Show or hide quota information in email reports |
The possible values for these keys are:
- true to send the report only in case of error or attach the file
- false to always send the report and not attach any file (default)
Example
Two administrators supervise 150 backup accounts, and their common language is English, while the root account is installed on a French system. They want to receive a daily administration report and receive detailed account reports only in case of errors.
They therefore need to:
- Enable the administration report
- Enable the backup report
- Add both administrators as email recipients
- Ensure backup reports are sent only in case of error and include a full report
- Force the language to English
Resulting strategy:
Configuration.EmailSupervisionReports : true
Configuration.EmailTransferReports : true
Configuration.EmailSupervisionReportsTo : admin1@entreprise.com
Configuration.EmailTransferReportsTo : admin2@entreprise.com
Configuration.EmailLanguage : en-us
Configuration.EmailOnlyOnError : true
Configuration.JoinBackupDetailsReport : true