Documentation
Sign inGet started

bird email threads list

Usage

कोड उदाहरण
bird email threads list [flags]

Description

List mailbox conversations as a cursor page, most recently active first. label selects the view: inbox (default), archive, spam, blocked, or a custom label. 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

कोड उदाहरण
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. This is a time filter, not a cursor.
--beforeFilter to conversations whose most recent message is at or before this time. This is a time filter, not a cursor.
--contact-idFilter to conversations linked to a specific contact.
--has-unreadWhen true, only conversations with unread messages are returned. This filters on the conversation's unread state, so you can combine it with label, for example to get unread conversations in the archive. The unread label itself lives on messages, not conversations.
--label <v1,v2,…>Filter to conversations that have this label. Repeat the parameter to ask for more than one: only conversations that have every label you list are returned. A placement label picks a folder: inbox, archive, spam, or blocked. A custom label matches a conversation in any folder. Leave this out and you get the inbox.
--mailbox-idFilter to conversations in a specific mailbox.
--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.
--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 field of a previous list response. Returns items immediately before the cursor position in the current sort order.
--limit <n>Maximum number of items to return per page.
--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 updateUpdate a thread