Documentation
Sign inGet started

bird email mailboxes receive-rules create

Usage

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

Description

Add a receive rule
Add an allow or block rule for a sender address or domain to a mailbox. Block always wins over allow; up to 200 rules per mailbox.
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

Esempio di codice
# print the body shape (no credentials needed)
bird email mailboxes receive-rules create --example

Options

Rule

NameDescription
--actionRule action: allow or block. Block rules always win.
--entrySender address (alice@example.com) or domain (example.com) to match. Domains also match subdomains.
--noteYour own note about why the rule exists.

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird email mailboxes receive-rules deleteDelete a receive rule
bird email mailboxes receive-rules listList receive rules