Test SMTP Connection – POST /SMTPSettings/testconnection

Test SMTP connection.

The ‘Manage System Settings’ permission is required to execute this API.

Usage:

POST /SMTPSettings and create new SMTP settings
POST /SMTPSettings/testconnection and test SMTP connection

URL

/cxrestapi/auth/SMTPSettings/testconnection

Method:

POST

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

testConnectionModel=[body]: Specifies the SMTP settings to test
receiverEmail=[string] - To field when receiving emails
password=[string] – Senders password
host=[string] - SMTP Server host
port=[integer] - port for sending emails
encryptionType=[string] - SMTP encryption type (SSL,TLS or None)
fromAddress=[string] - From field when sending emails
useDefaultCredentials=[string] – Whether SMTP communication is done via SSL (true/false)
username=[string] - Senders user name