SMTP Configuration

The API must be setup with SMTP settings in order for end-users to get email notifications.

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/config

HTTP request URL for SHIFT

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

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
replyToDisplayName	String	A user friendly display name for reply address.
starttls	boolean	To enable TLS.
port	String	Enter valid port number.
*host	String	Enter valid host(Eg.smtp.gamil.com).
replyTo	String	Mail to which reply needs to be sent.
*from	String	Enter from mailId.
fromDisplayName	String	A user friendly display name for from address.
envelopeFrom	String	An email address used for bounces.
ssl	boolean	True = Enable SSL.
user	String	From mail address.
password	String	Password corresponding to from mail address.

Sample Request

{
    "replyToDisplayName": "Receiver",
    "starttls": "true",
    "port": "587",
    "host": "smtp.gmail.com",
    "replyTo": "***@****.com",
    "from": "****@****.com",
    "fromDisplayName": "From KC Test team",
    "envelopeFrom": "",
    "ssl": "false",
    "user": "********@****.com",
    "password": "*******"
}

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. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Successfully updated SMTP Details",
    "status": "OK",
    "subSystem": 8
}

Response Status Information

Status Code	Status	Message
200	OK	Successfully updated SMTP Details.
400	BAD_REQUEST	Host and From is mandatory to update Email Configuration.
401	Unauthorized	HTTP 401 Unauthorized.