This is an archive version of the document. To get the most up-to-date information, see the current version.Sending Test Messages
This section explains how to send a test notification via email.
Request
PUT https://<hostname>/api/v1/settings/emailNotifications |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
Property | Type | Description |
|---|---|---|
smtpSettings | string | Sets the SmtpSettingsFromClient object. |
from | string | Sets the sender address. |
to | string | Sets the recipient address. |
Property | Type | Description |
|---|---|---|
accountId | string | Sets the identification number of the standard account that is used for authentication on the SMTP server. Can be obtained as described in Getting Standard Accounts. |
host | string | Sets the SMTP server address. |
port | string | Sets the communication port number to access the specified SMTP server. |
useSecureConnection | string | Sets if the secured SSL connection must be established. |
timeOutMiliSeconds | string | Sets if the connection that is being established can be timed out. |
Request Example
Request: PUT https://abc.ukwest.cloudapp.azure.com/api/v1/settings/emailNotifications
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "smtpSettings": { "accountId": 1, "host": "172.17.40.201", "port": 25, "useSecureConnection": true, "timeOutMiliSeconds": 15000 }, "from": "administrator@tech.local", "to": ".tech@organization.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.