bird email mailboxes create

Usage

Code example

bird email mailboxes create [flags]

Description

Create a mailbox

Claims an inbox.ai address, or an address on one of your own domains enabled for receiving. An inbox.ai address is permanently reserved to your organization even after the mailbox is deleted.

Build the request from flags, a JSON MailboxCreate body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

Code example

# print the body shape (no credentials needed)
bird email mailboxes create --example

# the body it prints:

Code example

{
  "display_name": "Acme Concierge",
  "local_part": "concierge",
  "receive_policy": "open",
  "retention_tier": "30d"
}

Options

Address

Name	Description
--local-part	Local part of the address, before the @; omit to generate one
--domain	Domain for the address; defaults to inbox.ai, the shared mailbox domain
--display-name	Sender display name on outgoing mail
--default-reply-to	Default Reply-To address stamped on outgoing mail

Behavior

Name	Description
--receive-policy	Which inbound mail to accept: open, replies_only, allowlist, or drop
--retention-tier	How long to remember message metadata and text: 30d

Metadata

Name	Description
--metadata	Arbitrary JSON metadata object

Request

Name	Description
--body-file	Read the JSON request body from this file; "-" reads stdin
--example	Print a complete example request body, then exit
--dry-run	Print the resolved request without sending it, then exit
--idempotency-key	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
--response-schema	Print the fields this command returns, then exit

Name	Description
bird email mailboxes compose	Send a new message from a mailbox
bird email mailboxes delete	Delete a mailbox
bird email mailboxes get	Get a mailbox
bird email mailboxes labels	List a mailbox's labels
bird email mailboxes list	List mailboxes
bird email mailboxes restore	Restore a deleted mailbox
bird email mailboxes resume	Resume a suspended mailbox
bird email mailboxes stats	Mailbox email statistics
bird email mailboxes update	Update a mailbox