Represents e-mail notification settings.
Veeam Backup for Microsoft Office 365 sends the e-mail notifications on the job run results.
|
E-mail notification settings are global, they will be applied to all backup jobs in Veeam Backup for Microsoft Office 365. |
Resource URL
https://<Backup-Office365>:<Port>/v1/VBOEmailSettings |
Related Resources
None.
Methods
The following methods are supported for the /VBOEmailSettings resource:
Properties
The /VBOEmailSettings resource has the following properties:
Property | Type | Description |
---|---|---|
Enable | bool | If set to True, indicates that Veeam Backup for Microsoft Office 365 will send e-mail notifications on the job run results. For example, "enableNotification": "true". |
SmtpServer | string | Specifies the full DNS name or IP address of the SMTP server for sending e-mail notifications. For example, "smtpServer": "smtp.office365.com". |
Port | int | Specifies the port for connecting to SMTP server. For example, "port": "587". |
Use | bool | If set to True, indicates that SMTP server requires authentication. Otherwise, the connection will be established to SMTP server, which does not enforce authentication. For example, "useAuthentication": "true". |
UseSSL | bool | If set to True, indicates that Veeam Backup for Microsoft Office 365 uses a secure connection for e-mail notification transmission. Otherwise, e-mail notifications will be transmitted through the connection that does not require SSL authentication. For example, "useSSL": "true". |
From | string | Specifies notification sender e-mail address with the rights to connect to SMTP server. For example, "from": "vbo@tech.com". |
To | string | Specifies notification recipient e-mail address. Semicolon is used for listing multiple recipients. For example, "to": "helpdesk@tech.com". |
Subject | string | Specifies the subject that must be used for creating the notification e-mail. The subject of the e-mail notification will display information according to the variables:
For example, "subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues". |
NotifyOn | bool | If set to True, Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes successfully. For example, "notifyOnSuccess": "false". |
NotifyOn | bool | If set to True, Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with warning. For example, "notifyOnWarning": "true". |
NotifyOn | bool | If set to True, Veeam Backup for Microsoft Office 365 will send the notification, if the job finishes with error. For example, "notifyOnFailure": "true". |
SupressUntil | bool | If set to True, Veeam Backup for Microsoft Office 365 will send the notification according to the job schedule options. The following e-mail notification scenarios are possible:
For example, "supressUntilLastRetry": "true". |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Resource Representation
The /VBOEmailSettings resource has the following representation:
{ "enableNotification": "true", "smtpServer": "smtp.office365.com", "port": 587, "useAuthentication": "false", "useSSL": "true", "from": "vbo@tech.com", "to": "helpdesk@tech.com", "subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues", "notifyOnSuccess": "true", "notifyOnWarning": "true", "notifyOnFailure": "true", "supressUntilLastRetry": "true", "_links": { "self": { "href": "https://support.east.local:4443/v1/vboemailsettings" } } } |
Related Topics