Editing Notification Settings

In this article

    You can edit Veeam Explorer for Microsoft Exchange notification settings.

    Request

    PUT https://<hostname>:4443/v5/VEXEmailSettings

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Body

    To edit Veeam Explorer for Microsoft Exchange email settings, you need to enter in the request body the required properties with new values. The properties you omit will remain unchanged.

    The following table lists available request properties:

    Property

    Type

    Description

    enableNotification

    boolean

    If set to true, indicates that mail server settings will be used for sending restored mailbox items through email.

    server

    string

    Specifies the full DNS name or IP address of the SMTP server for sending restored mailbox items in email messages.

    port

    integer

    Specifies the port for connecting to the SMTP server.

    useAuthentication

    boolean

    If set to true, indicates that the SMTP server requires authentication. Otherwise, the connection will be established to the SMTP server which does not enforce authentication.

    username

    string

    Specifies the user name that you want to use for authenticating with the SMTP server.

    userpassword

    string

    Specifies the password of the user account that you want to use for authenticating with the SMTP server.

    useSSL

    boolean

    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.

    from

    string

    Specifies the email address from which the restored mailbox data will be sent. This email address must have the rights to connect to the SMTP server if the server requires authentication.

    For example:

    Request Body:

    {

    "enableNotification": true,

    "server": "smtp.office365.com",

    "port": 25,

    "useAuthentication": true,

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

    "userpassword": "P@ssW0rd",

    "useSSL": true,

    "from": "support@tech.com"

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a 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 response body message: application/json; charset=utf-8

    Response Body

    None.

    Examples

    Example 1

    The example shows how to update Veeam Explorer for Microsoft Exchange email settings.

    Request:

    PUT https://abc.tech.local:4443/v5/VEXEmailSettings

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

    "enableNotification": true,

    "server": "smtp.office365.com",

    "port": 25,

    "useAuthentication": true,

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

    "userpassword": "P@ssW0rd",

    "useSSL": true,

    "from": "support@tech.com"

    }

     

    Response:

    200 OK