This is an archive version of the document. To get the most up-to-date information, see the current version.

/VBOEmailSettings

In this article

    Represents email notification settings.

    Veeam Backup for Microsoft Office 365 sends the email notifications on the job run results.

    /VBOEmailSettings Note:

    Email notification settings are global, they will be applied to all backup jobs in Veeam Backup for Microsoft Office 365.

    Resource URL

    https://<Backup-Office365>:4443/v3/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
    Notification

    bool

    If set to True, indicates that Veeam Backup for Microsoft Office 365 will send email 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 email notifications.

    For example, "smtpServer": "smtp.office365.com".

    Port

    int

    Specifies the port for connecting to SMTP server.

    For example, "port": "587".

    Use
    Authentication

    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 email notification transmission. Otherwise, email notifications will be transmitted through the connection that does not require SSL authentication.

    For example, "useSSL": "true".

    From

    string

    Specifies notification sender email address with the rights to connect to SMTP server.

    For example, "from": "vbo@tech.com".

    To

    string

    Specifies notification recipient email 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 email. The subject of the email notification will display information according to the variables:

    • %JobName% - backup job name
    • %JobResult% - backup job result
    • %OrgName% - the organization, whose data was processed by the backup job
    • %MailboxCount% - total number of processed mailboxes
    • %Issues% - number of objects processed with Failed or Warning status
    • %Time% - date and time of the backup job completion

    For example, "subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes), %Issues% issues".

    NotifyOn
    Success

    bool

    If set to True, Veeam Backup for Microsoft Office 365 will send the notification, if the job is completed.

    For example, "notifyOnSuccess": "false".

    NotifyOn
    Warning

    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
    Failure

    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
    LastRetry

    bool

    If set to True, Veeam Backup for Microsoft Office 365 will send the notification according to the job schedule options. The following email notification scenarios are possible:

    • If the job fails, Veeam Backup for Microsoft Office 365 will send the notification on the last job retry
    • If the job completes with Success or Warning, Veeam Backup for Microsoft Office 365 will send the notification on the last completion status
    • If the job is scheduled to Terminate job if it runs longer than <interval>, Veeam Backup for Microsoft Office 365 will send the notification on the last attempt within that interval

    For example, "supressUntilLastRetry": "true".

    AttachDetailedReport

    bool

    If set to True, Veeam Backup for Microsoft Office 365 will attach a report on the job results to the email notification.

    For example, "attachdetailedReport": "bool"

    _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/v3/vboemailsettings"

       }

     }

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.