Documentation
Sign inGet started

bird email inbound-addresses create

Usage

Exemplo de código
bird email inbound-addresses create [flags]

Description

Create an inbound address
Mint a new Bird inbound address to forward a mailbox to. Returns the address to forward to.
Build the request from flags, a JSON InboundAddressCreate 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.

Procedure

Step 1 of 2 of "Receive email at a Bird forward address". Next: bird email inbound-messages list.

Examples

Exemplo de código
# print the body shape (no credentials needed)
bird email inbound-addresses create --example

# the body it prints:
Exemplo de código
{
  "label": "Support mailbox"
}

Options

Address

NameDescription
--labelYour own label for this address, typically the source mailbox it maps to.

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 inbound-addresses deleteDelete an inbound address
bird email inbound-addresses getGet an inbound address
bird email inbound-addresses listList inbound addresses
bird email inbound-addresses updateUpdate an inbound address