Email

Start connecting a Gmail inbox

Returns the Google consent URL bound to your account and to the import bound. Open it in a browser; after consent the inbox becomes a connected mailbox at its own address, the mail received after the bound is imported (default: the last 24 hours), and new mail follows as it arrives. Never the whole inbox: widen later with POST /api/emails/{address}/import. Requires email:write. Google OAuth must be configured on the server.

post/api/emails/connect/gmail

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/emails/connect/gmail
  • Auth: HTTP bearer

Request body

access'read' | 'write'

read (the default) reads the inbox; write also lets the platform change labels and the read state and send as the person, for the effects of a standing delegation. Reconnect with write to widen a read-only grant.

sincestring date-time

Import the mail received after this instant

window'24h' | '7d' | '30d' | '1y'

A preset instead of since; default 24h

workspace_idstring

Workspace the mailbox belongs to; your personal workspace by default

login_hintstring

The Google account to preselect

return_tostring

App path to send the browser to after consent

Response

The consent URL

auth_urlstring required
statestring required
import_sincestring date-time required
expires_ininteger required
access'read' | 'write'

Changes

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