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

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

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