Discover Email settings with credentials
Try to discover IMAP and SMTP settings for an email account, optionally authenticating against an autodiscovery server that refuses to answer anonymously<br/><br/>Hosted Exchange answers autodiscovery only for an authenticated request, which is why this endpoint exists alongside GET /v1/autoconfig. The password is sent to the autodiscovery host named by the address domain's own DNS records, and only after that host has asked for it with a Basic challenge over HTTPS.
Request
- Base URL: https://your-emailengine-host
- URL: https://your-emailengine-host/v1/autoconfig
- Auth: HTTP bearer
Headers
Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect
Request body
Example request
{
"email": "sender@example.com",
"auth": {
"user": "myuser@gmail.com",
"pass": "verysecret"
}
}Response
Returns the discovered IMAP and SMTP settings for the address, or empty values when nothing could be resolved.
Example response
{
"imap": {
"auth": {
"user": "myuser@gmail.com"
},
"host": "imap.gmail.com",
"port": 993,
"secure": true
},
"smtp": {
"auth": {
"user": "myuser@gmail.com"
},
"host": "smtp.gmail.com",
"port": 465,
"secure": true
},
"appPassword": {
"required": true,
"provider": "Gmail",
"instructions": "Use an app password instead of the regular account password"
},
"_source": "srv"
}Changes
No recorded changes to this operation across all 1 revision of this API.