bird email mailboxes receive-rules create

Usage

Code example

bird email mailboxes receive-rules create <mailbox-id> [flags]

Description

Add a receive rule

Adds an allow or block rule for a sender address or domain. A block rule always wins over an allow rule, and a mailbox holds up to 200 rules.

Build the request from flags, a JSON ReceiveRuleCreate 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 receive-rules create --example

# the body it prints:

Code example

{
  "action": "allow",
  "entry": "partner.example.com",
  "note": "Approved partner senders"
}

Options

Rule

Name	Description
--action	Rule action: allow or block. A block rule always wins
--entry	Sender address (alice@example.com) or domain (example.com) to match; a domain also matches its subdomains
--note	Your own note on why the rule exists

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 receive-rules delete	Delete a receive rule
bird email mailboxes receive-rules list	List receive rules

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Watch the guideSetting up your coding agent Understand the conceptWhat is an MCP server, and how does an agent use one to send messages?Explore the capabilityCoding agents Follow the learning pathBuild with AI agents

Get an implementation brief