Read the connection of a connected mailbox

Kind, status, the import bound, the sync phase (the import scan, then history), the import progress (scanned, copied, to analyse, analysed), the last sync and the last error. Requires email:read. The forwarding confirmation (Gmail's code and link) is authentication mail: without email:auth_secrets its code and url are null and it carries redacted: true. A mailbox-confined token finds only its own mailboxes (404 otherwise).

get/api/emails/{address}/connector

Request

Base URL: https://domani.run
URL: https://domani.run/api/emails/{address}/connector
Auth: HTTP bearer

Path parameters

addressstring required

The connected address, for example someone@gmail.com

Response

The connection

addressstring required

mailbox_idstring required

kind'gmail' | 'graph' | 'forwarding' | 'imap' | 'jmap' required

status'pending' | 'active' | 'error' | 'disconnected' required

import_sincestring date-time nullable

The bound of the first import: no mail received before it is copied

phase'list' | 'history' | 'paused' required

list while the import scan pages through the mail after the bound, history once new mail follows the source's history

paused_reasonstring nullable

source_messages_totalinteger nullable

What the source reports for the whole inbox, for scale

last_sync_atstring date-time nullable

last_errorstring nullable

backoff_untilstring date-time nullable

verified_atstring date-time nullable

connected_atstring date-time required

cost_cap_usdnumber

The model spend allowed per import run, in USD

access'read' | 'write' nullable

For a Gmail connection: what the grant allows; write means labels both ways and sending as the person

Changes

No recorded changes to this operation across all 2 revisions of this API.