Test SMTP Configuration

Use this API, to test the mail configuration which was set at Realm level for the given user.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/mail/test

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/mail/test

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body (* Required)

Field Name	Type	Description
mailType	String	Specify the mail type for template. Value should be "TEST"

Sample Request

{
    "mailType": "TEST"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Mail Sent Successfully to the user",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Mail Sent Successfully to the user
401	Unauthorized	HTTP 401 Unauthorized
404	USER_NOT_FOUND	User does not exist