Connect

Get a hosted link to connect any mailbox

Changed on

One link for any address. The page asks for the email first, sends Gmail, Google Workspace, Outlook.com and Microsoft 365 (found by domain or MX) to their OAuth connect, and every other mailbox to IMAP with the provider's app-password steps. Valid for one hour.

get/v1/connect/email

Request

Query parameters

profileIdstring required
redirect_urlstring uri

Where the page sends the user afterwards, with status, accountId, platform and email (or status=error and error).

emailstring email

Prefills the address and skips the first screen.

namestring

Display name for sent mail; the page asks for it when absent.

reconnectAccountIdstring

Opens the reconnect variant for an IMAP account: only the new password is asked for, and the accountId stays the same.

Response

The hosted page URL

authUrlstring uri
expiresAtstring date-time

Changes