Documentation
Sign inGet started

bird email mailboxes

Usage

Code example
bird email mailboxes

Description

A mailbox is a shared inbox your AI agents and support workflows read from. It has an address, a receive policy controlling which messages it accepts, a retention tier, and labels for categorising threads. Its conversations are read and replied to under email threads.
Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request. Destructive commands require --yes.

Commands

NameDescription
composeSend a new message from a mailbox
createCreate a mailbox
deleteDelete a mailbox
getGet a mailbox
labelsList a mailbox's labels
listList mailboxes
receive-rulesManage a mailbox's receive rules
restoreRestore a deleted mailbox
resumeResume a suspended mailbox
statsMailbox email statistics
updateUpdate a mailbox