Sign inGet Started

bird email threads list

Usage

Exemple de code
bird email threads list [flags]

Description

List mailbox conversations as a cursor page, most recently active first. folder selects the view: inbox (default), archive, spam, blocked, sent, or trash. labels matches custom labels. Filter by mailbox, contact, participant address, or subject substring.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Exemple de code
bird email threads list
bird email threads list | jq -r '.data[].id'
bird email threads list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--afterFilter to conversations whose most recent message is at or after this time. Use the response cursors for pagination.
--beforeFilter to conversations whose most recent message is at or before this time. Use the response cursors for pagination.
--contact-idFilter to conversations linked to a specific contact.
--folderFilter to a folder. Defaults to inbox when neither folder nor custom labels are supplied. Possible values: inbox, archive, spam, blocked, sent, trash.
--labels <value>…Match every listed custom label. Repeat labels to supply more than one. System label names are refused.
--mailbox-idFilter to conversations in a mailbox by ID or email address in this workspace. An unknown or ambiguous email address returns 404; a valid mailbox ID with no matching threads returns an empty page.
--participantConversations involving this address, matching the sender or any recipient. The match is case-insensitive and matches on any part of the address, so a fragment works as well as the whole address.
--read-stateFilter to read or unread conversations. Omit for either state. Possible values: read, unread.
--response-schemaPrint the fields this command returns, then exit
--subjectConversations whose subject contains this text (case-insensitive).

Pagination

NameDescription
--ending-beforeCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
--limit <n>Maximum number of items to return per page. Allowed range: 1 to 100.
--starting-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird email threads deleteDelete a thread
bird email threads getGet a thread
bird email threads restoreRestore a thread from trash
bird email threads searchSearch threads
bird email threads updateUpdate a thread

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.