Generate authentication link

POST 
/v1/authentication/form

Generates a redirect link to the hosted authentication form

An IMAP setup completes without asking the user for mail server settings whenever EmailEngine can discover and verify them from the address and password alone. Set skipServerSettings to false to always show that step.

If expectedEmail is set and the user completes the form as a different identity, the setup is rejected before any credentials are stored. The user stays on EmailEngine, which names both addresses and offers to restart the setup, so the browser is never redirected to redirectUrl.

Request

Responses

200

Returns a single-use URL for the hosted authentication form.

400

Invalid input - the path parameters, query arguments, or request payload did not pass validation. Also returned when the email server refused the request, in which case the response carries a code and the server response instead of a field list

401

Authentication failed - the access token is missing, invalid, or was not accepted

403

Access denied - the access token does not grant permission for this operation (token scope, account, or IP address restriction)

404

Not found - the requested entity (account, message, mailbox, etc.) does not exist

429

Rate limit exceeded - too many requests were made with this access token

500

Internal server error - an unexpected error occurred while processing the request