POST

Use this API to test the email configuration. The output indicates if the system is able to make IMAP and SMTP connection and the provided folders are accessible.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/emailConfigTest

HTTPS method:

POST

Input/Output method:

xml

Example XML request payload: 


<EmailServerDetails>
  <server>
    <!-- SMTP Server Details -->
    <smtp>
      <host>smtp.office365.com</host> 
      <port>587</port>
    </smtp>
    <!-- IMAP server details -->
    <imap>
      <host>outlook.office365.com</host>   
      <port>993</port>
      <!-- IMAP folder List -->
      <folders>
        <folder>Inbox</folder>
        <folder>Myfolder</folder>
      </folders>
    </imap>
  </server>
  <!-- Server Credentials -->
  <userName>name@example.com</userName>
  <password>1234</password>
</EmailServerDetails>

Example Response Body: 


<EmailServerTestResult>
  <!-- Overall Status SUCCESS/FAILURE-->
  <globalStatus>FAILURE</globalStatus>
  <smtp>
    <!-- status SUCCESS/FAILURE -->
    <status>SUCCESS</status>
    <!-- Failure reason -->
    <reason></reason>
  </smtp>
  <imap>
    <!-- IMAP folder Accessibility results -->
    <folders>
      <folder>
        <folderName>Inbox</folderName>
        <status>SUCCESS</status>
        <reason></reason>
      </folder>
      <folder>
        <folderName>Myfolder</folderName>
        <status>FAILURE</status>
        <reason>FOLDER MISSING</reason>
      </folder>
    </folders> 
   </imap>
</EmailServerTestResult>

HTTPS Response Headers:

200 OK

400 Bad Request

401 Unauthorized

500 Internal Server Error