Account

Verify IMAP and SMTP settings

Checks if can connect and authenticate using provided account info

post/v1/verifyAccount

Request

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

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

Request body

mailboxesboolean

Include mailbox listing in response

proxystring

Proxy server URL for outbound connections

smtpEhloNamestring nullable

Hostname to use in SMTP EHLO/HELO commands (defaults to system hostname)

Example request

{
  "imap": {
    "auth": {
      "user": "myuser@gmail.com",
      "pass": "verysecret"
    },
    "secure": true,
    "tls": {
      "rejectUnauthorized": true,
      "minVersion": "TLSv1.2"
    },
    "resyncDelay": 900,
    "host": "imap.gmail.com",
    "port": 993,
    "sentMailPath": "Sent Mail",
    "draftsMailPath": "Drafts",
    "junkMailPath": "Junk",
    "trashMailPath": "Trash",
    "archiveMailPath": "Archive"
  },
  "smtp": {
    "auth": {
      "user": "myuser@gmail.com",
      "pass": "verysecret"
    },
    "host": "smtp.gmail.com",
    "port": 587,
    "tls": {
      "rejectUnauthorized": true,
      "minVersion": "TLSv1.2"
    }
  },
  "proxy": "socks5://proxy.example.com:1080",
  "smtpEhloName": "relay.example.com"
}

Response

Returns the outcome of the IMAP and SMTP connection tests, including per-protocol errors when a test failed.

Example response

{
  "imap": {
    "success": true,
    "error": "Something went wrong",
    "code": "ERR_SSL_WRONG_VERSION_NUMBER",
    "statusCode": 500,
    "responseText": "NO [AUTHENTICATIONFAILED] Invalid credentials"
  },
  "smtp": {
    "success": true,
    "error": "Something went wrong",
    "code": "ERR_SSL_WRONG_VERSION_NUMBER",
    "statusCode": 500,
    "responseText": "535 Authentication failed"
  },
  "mailboxes": [
    {
      "path": "Kalender/S&APw-nnip&AOQ-evad",
      "delimiter": "/",
      "parentPath": "Kalender",
      "name": "Sünnipäevad",
      "listed": true,
      "subscribed": true,
      "specialUse": "\\Sent",
      "specialUseSource": "extension"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.