Test SMTP connection
post
/ccadmin/v1/email/test
Tests the SMTP connection.
It attempts to connect to the configured SMTP service. The only response this endpoint returns is a JSON object containing a success field, which has a value of true or false depending on the outcome of the test.
It returns true for a successful connection or false for an unsuccessful connection.
Note:This endpoint will always return a 200 OK Response. The only difference is the value, true or false.
Request
Supported Media Types
- application/json
Root Schema : testSmtpConnection_request
Type:
Show Source
object
-
emailSMTPAuthMethod:
string
The SMTP Authorisation method - either SSL or TLS.
-
emailSMTPHost:
string
The SMTP host.
-
emailSMTPPassword:
string
User password for the SMTP server.
-
emailSMTPPort:
string
Port to use to communicate with the SMTP host. Needs to be 465 or 587 as appropriate for the value set in emailSMTPAuthMethod.
-
emailSMTPUsername:
string
User login for the SMTP server.
Example:
{
"emailSMTPPort":"587",
"emailSMTPHost":"smtp.example.com",
"emailSMTPAuthMethod":"TLS",
"emailSMTPPassword":"example",
"emailSMTPUsername":"example@example.com"
}
Response
Supported Media Types
- application/json
200 Response
Returned when the attempt to connect is complete. It can be either true or false.
Root Schema : testSmtpConnection_response
Type:
Show Source
object
-
success(optional):
boolean
Will be set to true if the connection test succeeded, false otherwise.
Example Response (application/json)
{
"success":true
}
Default Response
The error
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code