Getting Notification Settings
This section explains how to get a resource representation of Veeam Explorer for Microsoft Exchange notification settings.
Request
GET https://<hostname>:4443/v5/VEXEmailSettings |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
None.
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
Property | Type | Description |
|---|---|---|
enableNotification | boolean | If set to true, indicates that email notifications are enabled for Veeam Explorer for Microsoft Exchange. The specified mail server settings will be also used for sending restored mailbox items by email. |
server | string | Specifies the full DNS name or IP address of the SMTP server used for sending notifications and restored items in email messages. |
port | integer | Specifies the port for connecting to SMTP server. |
useAuthentication | boolean | If set to true, indicates that the SMTP server requires authentication. Otherwise, a connection that does not enforce authentication will be established to the SMTP server. |
username | string | Specifies the user name that you want to use for authenticating with SMTP server. |
userpassword | string | Specifies the password of the user account that you want to use for authenticating with SMTP server. |
useSSL | boolean | 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. |
from | string | Specifies the email address from which notifications and restored mailbox data will be sent. This email address must have permissions to connect to the SMTP server if the SMTP server requires authentication. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example below returns a resource representation of Veeam Explorer for Microsoft Exchange email settings used for sending notifications and restored organization's mailbox items by email.
Request: GET https://abc.tech.local:4443/v5/EmailSettings
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "enableNotification": true, "server": "smtp.office365.com", "port": 25, "useAuthentication": true, "username": "vscott@tech.onmicrosoft.com", "from": "support@tech.com", "_links": { "self": { "href": "https://abc.tech.local:4443/v5/vexemailsettings" } } } |