This is an archive version of the document. To get the most up-to-date information, see the current version.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/v4/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 mail server settings will be used for sending restored mailbox items via email. |
Server | string | Specifies the full DNS name or IP address of the SMTP server for sending restored mailbox items in email messages. |
Port | int | Specifies the port for connecting to SMTP server. |
UseAuthentication | boolean | If set to True, indicates that SMTP server requires authentication. Otherwise, the connection will be established to SMTP server, which does not enforce authentication. |
UserName | string | Specifies the user name you want to use for authenticating with SMTP server. |
UserPassword | string | Specifies the password 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 the restored mailbox data will be sent. This email address must have the rights to connect to SMTP server, If SMTP server requires authentication. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The example below returns an entity representation of Veeam Explorer for Microsoft Exchange email settings used for sending restored organization's mailbox items via email.
Request: GET https://abc.tech.local:4443/v4/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/v4/vexemailsettings" } } } |