Skip to main content
POST
/
email-accounts
/
test
/
imap
Test IMAP connectivity
curl --request POST \
  --url https://api.reply.io/v3/email-accounts/test/imap \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "host": "smtp.company.com",
  "port": 465,
  "enableSsl": true,
  "userName": "user@company.com",
  "password": "secret123"
}
'
{
  "success": true,
  "error": null
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Body

application/json

Request body for testing SMTP or IMAP connectivity.

​
host
string
required

Hostname or IP address of the mail server

​
port
integer
required

Port number of the mail server

Required range: 1 <= x <= 65535
​
userName
string
required

Username for authentication

​
password
string
required

Password for authentication

​
enableSsl
boolean
default:true

Whether to use SSL/TLS for the connection

Response

Test result

Result of a mail server connectivity test.

​
success
boolean
required

Whether the connection test was successful

​
error
string | null

Error message if the test failed, null if successful