Connectors API

Email ingest connector configuration and mailbox authorization

📄️List the household's email ingest connectors

Requires connectors.manage. Returns household-scoped configuration, polling health, authorization state, and revisions; sealed mailbox credentials never cross the API boundary.

📄️Configure a new email ingest connector

The connector is created disabled and unauthorized. Authorize its mailbox before it will poll.

📄️Provider consent callback

Exchanges the authorization code for a refresh token, seals it, and stores it against the connector. The token never appears in the response.

📄️Remove an email ingest connector and its stored credential

Requires connectors.manage, an exact same-origin proof for cookie requests, and the observed revision. Deletion is atomic and removes the connector together with its sealed mailbox credential; stale revisions conflict.

📄️Read one email ingest connector

Requires connectors.manage and household scope. Unknown or foreign connector IDs return 404, and the sealed refresh token is never returned.

📄️Change an email ingest connector's settings

Requires connectors.manage, an exact same-origin proof for cookie requests, and the observed expectedRevision. The complete settings update is atomic; stale revisions conflict and the sealed mailbox credential remains server-side.

📄️Start the provider consent flow for a connector's mailbox

Returns the provider consent URL. Requires a configured connector OAuth client and a public HTTPS origin.