Email

Search one mailbox by meaning and by words

The same search as GET /api/emails/search, restricted to this mailbox. Requires email:read. Without email:auth_secrets, inbound authentication mail is left out before ranking: no word, operator or filter matches it, so a search for a sign-in code finds nothing.

get/api/emails/{address}/search

Request

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

Path parameters

addressstring required

Mailbox email address (URL-encoded)

Query parameters

qstring required

What you are looking for, in any language: a name, a reference, or a description of the mail, plus Gmail operators (from:dave is:unread newer_than:7d -invoice "exact phrase").

mode'hybrid' | 'semantic' | 'keyword'

hybrid fuses the embedding and the words by rank; semantic uses the meaning only; keyword the words only.

limitinteger

Results to return.

sincestring date-time

Only mail received after this ISO timestamp.

untilstring date-time

Only mail received before this ISO timestamp.

folder'inbox' | 'archive' | 'sent' | 'spam' | 'trash' | 'anywhere'

One folder. Trash is excluded unless named or anywhere.

fromstring

Sender address contains.

labelstring

Comma-separated labels: only messages carrying any of them

Response

Ranked results

mode'hybrid' | 'semantic' | 'keyword'
querystring
took_msinteger
hintstring

Changes

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