Check Mail Server

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Utility Functions >

Check Mail Server

Checks the connection to a mail (SMTP) server.

 

Request

Method

URL

POST

/smserver-default/sms.checkMailServer

RAW

POST /smserver-default/sms.checkMailServer HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{

           "mailto" : "io@syncplify.me",

           "smtphost" : "mail.syncplify.me",

           "smtpsender" : "io@syncplify.me",

           "mailsubject" : "Syncplify Email Test",

           "mailtext" : "Syncplify Email Test",

           "smtpuser" : "syncplify@syncplify.me",

           "smtppass" : "AdzMjma3aQp+6qEWweekWqw==",

           "smtpport" : 587,

           "smtptls" : "None"

       }

]

Explained

Used to test the SMTP server configuration.

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

{

       "Result" : -1,

       "ResultMsg" : "Must issue a STARTTLS command first\r\n"

   }

],"id":772674711}

Explained

Result:

  1 = success

  any other value different from 1 = error

 

ResultMsg: a friendly message (success or error message) explaining what happened