bird email inbound-messages list
Usage
Code example
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
Code example
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
| Name | Description |
|---|---|
| --ending-before | Cursor 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. |
| --starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Filters
| Name | Description |
|---|---|
| --from | Filter to messages whose sender address matches this value exactly. Sender addresses are stored lowercase, so pass the address in lowercase to match reliably. |
| --inbound-address-id | Filter to messages received on a specific inbound address. |
| --received-after | Filter to messages received at or after this time. |
| --received-before | Filter to messages received at or before this time. |
| --response-schema | Print the fields this command returns, then exit |
Related
| Name | Description |
|---|---|
| bird email inbound-messages attachment | Download a received email's attachment |
| bird email inbound-messages attachments | List a received email's attachments |
| bird email inbound-messages body | Get a received email's body |
| bird email inbound-messages get | Get a received email |
| bird email inbound-messages raw | Download a received email's raw content |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideGetting started with emailExplore the capabilityEmailFollow the learning pathBuild your first integrationImplementation guideSend your first email
Try the practice and get an implementation brief