This is an archive version of the document. To get the most up-to-date information, see the current version.(PUT) /VEXEmailSettings
Edits VEX email settings.
Request
To edit VEX email settings, send the PUT HTTPS request to the URL of the /VEXEmailSettings resource.
HTTPS Request
PUT https://<Backup-Office365>:4443/v3/VEXEmailSettings |
Request Headers
The request header must contain the authorization token for the current logon session.
Request Body
To edit VEX email 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 must contain the following properties:
Property | Type | Description |
|---|---|---|
EnableNotification | bool | If set to True, indicates that mail server settings will be used for sending restored mailbox items via email. For example, "enableNotification": "true". |
Server | string | Specifies the full DNS name or IP address of the SMTP server for sending restored mailbox items in email messages. For example, "smtpServer": "smtp.office365.com". |
Port | int | Specifies the port for connecting to SMTP server. For example, "port": "25". |
UseAuthentication | 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 | Specifies the user name you want to use for authenticating with SMTP server. For example, "user": " vscott@tech.onmicrosoft.com". |
UserPassword | string | Specifies the password you want to use for authenticating with SMTP server. For example, "password": "P@ssW0rd". |
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 the email address from which the restored mailbox data will be sent. This email address must have the rights to connect to SMTP server, If SMTP server requires authentication. For example, "from": "support@tech.com". |
For example:
{ "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 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 VEX email settings.
Request: PUT https://support.east.local:4443/v3/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 |