v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Email Accounts

Test IMAP connectivity

<small>Requires the channels:operate scope (or a broader one that includes it).</small>

Tests connectivity to an IMAP server with the provided credentials without creating an email account.

post/v3/email-accounts/test/imap

hoststring required

Hostname or IP address of the mail server

portinteger required

Port number of the mail server

enableSslboolean

Whether to use SSL/TLS for the connection

userNamestring required

Username for authentication

passwordstring required

Password for authentication

{
  "host": "smtp.company.com",
  "port": 465,
  "enableSsl": true,
  "userName": "user@company.com",
  "password": "secret123"
}

Test result

successboolean required

Whether the connection test was successful

errorstring nullable

Error message if the test failed, null if successful

{
  "success": true,
  "error": null
}