Documentation
Sign inGet started

bird email inbound-messages list

Usage

Przykład kodu
bird email inbound-messages list [flags]

Description

List received (inbound) emails as a cursor page, newest first. Filter by sender, inbound address, or received time.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Procedure

Step 2 of 2 of "Receive email at a Bird forward address". Previous: bird email inbound-addresses create.

Examples

Przykład kodu
bird email inbound-messages list
bird email inbound-messages list | jq -r '.data[].id'
bird email inbound-messages list --limit 50 --starting-after <cursor>

Options

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.

Filters

NameDescription
--fromFilter to messages whose sender address matches this value.
--inbound-address-idFilter to messages received on a specific Bird-minted inbound address.
--received-afterFilter to messages received at or after this time.
--received-beforeFilter to messages received at or before this time.
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email inbound-messages attachmentDownload a received email's attachment
bird email inbound-messages attachmentsList a received email's attachments
bird email inbound-messages bodyGet a received email's body
bird email inbound-messages getGet a received email
bird email inbound-messages rawDownload a received email's raw content