Documentation
Sign inGet started

bird email threads messages list

Usage

Contoh kode
bird email threads messages list <thread-id> [flags]

Description

List the messages in a conversation newest first, both directions. Page older messages with starting_after, and pass include=extracted_text to inline each message's durable plain text.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

Contoh kode
bird email threads messages list
bird email threads messages list | jq -r '.data[].id'
bird email threads messages list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--directionFilter to received (inbound) or sent (outbound) messages.
--includeSet to extracted_text to inline each message's extracted plain text.
--labelFilter to messages carrying this label. trash lists trashed messages; any other label — archive, spam, blocked, unread, or a custom label — lists its non-trashed carriers. When omitted, received messages in the inbox and all sent messages are returned.
--response-schemaPrint the fields this command returns, then exit

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 messages attachmentDownload an attachment from a thread message
bird email threads messages attachmentsList a thread message's attachments
bird email threads messages bodyGet a thread message's original body
bird email threads messages getGet a message in a thread
bird email threads messages rawDownload a thread message's raw RFC 5322 content
bird email threads messages replyReply to a thread message