Settings

Discover Email settings

Try to discover IMAP and SMTP settings for an email account

get/v1/autoconfig

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/autoconfig
  • Auth: HTTP bearer

Query parameters

emailstring required

Email address to discover email settings for

Example:sender@example.com

Headers

x-ee-timeoutinteger

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

Example:30000

Response

Returns the discovered IMAP and SMTP settings for the address, or empty values when nothing could be resolved.

_sourcestring

Source for the detected info

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.