Editing Notification Settings
This section explains how to edit Veeam Explorer for Microsoft SharePoint notification settings.
Request
PUT https://<hostname>:4443/v5/VESPEmailSettings |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
To edit VESP 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 | boolean | If set to True, indicates that mail server settings will be used for sending restored mailbox items via email. |
SmtpServer | string | Specifies the DNS name or IP-address of the SMTP server. |
Port | int | Specifies the port number to connect to the SMTP server. |
From | string | Specifies the email address from which the restored Microsoft SharePoint data will be sent. This email address must have the rights to connect to the SMTP server If the server requires authentication. |
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. |
UseAuthentication | boolean | If set to True, indicates that 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 you want to use for authenticating with the SMTP server. |
UserPassword | string | Specifies the password you want to use for authenticating with the SMTP server. |
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 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.
Example
The example below shows how to update VESP email settings.
Request: PUT https://abc.tech.local:4443/v5/VESPEmailSettings
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 |