One mailbox's threads, most recently active first, narrowed by the filter. limit defaults to 50.

get/v1/mailboxes/{mailboxId}/threads

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL /authorize, token URL /oauth/token, scopes: email.read)
    • HTTP bearer

Path parameters

mailboxIdstring required

Query parameters

limitinteger
cursorstring
archivedboolean

Only threads with this archive flag.

trashedboolean

true is the Trash view. Absent or false: everything that is not in the Trash.

outboundboolean

Only threads this mailbox has (or has not) sent on — Thread.hasOutbound.

unreadboolean

Only unread (or only read) threads — Thread.unread, the per-mailbox flag.

qSearchTerm[]

Free text. ONE message must hold EVERY term, each in its subject, its sender (address or display name), its To and Cc, or its text body — the whole body, not the snippet. Repeat the parameter for each term: ?q=annual%20plan&q=invoice.

fromstring

One search term — a word or a phrase. Its words (runs of letters and digits, case aside, and accents aside on Latin letters) must appear in order in one field of one message, every word whole but the last, which may be the start of a word: annual pl finds "the Annual Plan". A term with no letter or digit in it is passed over beside terms that have one; alone, or as the value of from, to or subject, it matches nothing.

A message's sender — its address or the display name beside it — on the same message as the terms. Any message of the thread, received or sent, not only the newest.

tostring

One search term — a word or a phrase. Its words (runs of letters and digits, case aside, and accents aside on Latin letters) must appear in order in one field of one message, every word whole but the last, which may be the start of a word: annual pl finds "the Annual Plan". A term with no letter or digit in it is passed over beside terms that have one; alone, or as the value of from, to or subject, it matches nothing.

A message's To or Cc — never a Bcc, which no copy keeps — on the same message.

subjectstring

One search term — a word or a phrase. Its words (runs of letters and digits, case aside, and accents aside on Latin letters) must appear in order in one field of one message, every word whole but the last, which may be the start of a word: annual pl finds "the Annual Plan". A term with no letter or digit in it is passed over beside terms that have one; alone, or as the value of from, to or subject, it matches nothing.

A message's subject, on the same message as the terms.

hasAttachmentboolean

Only threads that hold (or do not hold) a file — an attachment the reader lists, on either side of the conversation. An image the message's HTML shows in place is not one.

beforestring date-time

Only threads quiet since before this instant: their last message is earlier.

afterstring date-time

Only threads active at or after this instant: their last message is no earlier.

threadstring

One thread's rows only, by its id — how a reader holding a link to a conversation finds its row when no page it loaded has it. On the union read this is every granted mailbox's copy, newest first; the other predicates still apply, the Trash's above all.

Response

The request has succeeded.

nextCursorstring nullable required

Opaque. Non-null exactly when this page was full; null otherwise.

Changes

No recorded changes to this operation across all 1 revision of this API.