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

(PUT) /VBOEmailSettings

In this article

    Edits email notification settings.

    Request

    To edit email notification settings, send the PUT HTTPS request to the URL of the /VBOEmailSettings resource.

    (PUT) /VBOEmailSettings Note:

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

    HTTPS Request

    PUT https://<Backup-Office365>:4443/v3/VBOEmailSettings

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Request Body

    To edit email notification settings, you need to enter in the request body the corresponding properties with new values. The properties you omit will remain unchanged.

    The request body can contain 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 the SMTP server.

    For example, "port": "590".

    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".

    Username

    string

    Specifes the user name for authenticating with SMTP server.

    For example, "username": " johnsmith@tech.onmicrosoft.com"

    User
    Password

    string

    Specifies the user password for authenticating with SMTP server.

    For example, "userPassword": "Pa$$w0rd".

    UseSSL

    bool

    If set to True, indicates that Veeam Backup for Microsoft Office 365 will use 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 mailbox email address with the rights to connect to SMTP server.

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

    To

    string

    Specifies notification recipient mailbox email address. Semicolon is used for listing multiple recipients.

    For example, "to": "qa@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 mailboxes were processed by the backup job
    • %MailboxCount% - total number of processed mailbox items
    • %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)".

    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": "true"

    For example:

    {

    "enableNotification": "true",

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

     "port": 590,

     "useAuthentication": "true",

     "username": "johnsmith@tech.onmicrosoft.com",

     "useSSL": "true",

     "from": "support@tech.com",

     "to": "qa@tech.com",

     "subject": "[%JobResult%] %OrgName% - %JobName% (%MailboxCount% mailboxes),

     "notifyOnSuccess": "false",

     "notifyOnWarning": "false",

     "notifyOnFailure": "false",

     "supressUntilLastRetry": "true"

     "attachDetailedReport": "true"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the request body message: application/json; charset=utf-8

    Response Body

    None.

    Example

    The example below shows how to update email notification settings.

    Request:

    PUT https://support.east.local:4443/v3/VBOEmailSettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

     "enableNotification": "true",

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

     "port": 590,

     "useAuthentication": "true",

     "username": "johnsmith@tech.onmicrosoft.com",

     "userPassrowd": "Pa$$w0rd",

     "useSSL": "true",

     "from": "support@tech.com",

     "to": "qa@tech.com",

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

     "notifyOnSuccess": "false",

     "notifyOnWarning": "false",

     "notifyOnFailure": "false",

     "supressUntilLastRetry": "true"

     "attachDetailedReport": "true"

    }

     

    Response:

    200 OK

    I want to report a typo

    There is a misspelling right here:

     

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