This is an archive version of the document. To get the most up-to-date information, see the current version.

Sending Test Message

You can send a test message to the specified recipient.

Request

POST https://<hostname>:4443/v5/VEXEmailSettings/action

Request Headers

The request header must contain an authorization token of the current session.

Request Body

To send a test message, the request body must contain the sendTest action property:

Property	Type	Description
email	string	Specifies the email you want to send the test message to.

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.

Examples

Example 1

The example shows how to send a test message to a specified email address.

Request:

POST https://abc.tech.local:4443/v5/VEXEmailSettings/action

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"sendTest": { "email": email@gmail.com }

}

Response:

200 OK