API referenceEmail accounts
GET
/email/api/v1/accounts/autoconfig

Swarmhit's own. The IMAP and SMTP servers of an address's domain, and whether its provider needs an app password; null where unknown. A domain (or its autoconfig. host) that resolves inside a private network is refused (400).

Authorization

X-API-KEY<token>

Your API key from the console (gw_live_…).

In: header

Query Parameters

email*string

The address whose servers to look up.

Lengthlength <= 320

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/email/api/v1/accounts/autoconfig?email=jane%40acme.com"
{  "object": "MailServerConfig",  "imap": {    "host": "string",    "port": 0,    "secure": true  },  "smtp": {    "host": "string",    "port": 0,    "secure": true  },  "app_password": {    "required": true,    "provider": "string",    "instructions": "string",    "warning": "string"  }}