Sign inGet Started

bird email mailboxes forwarding-address create

Usage

Code example
bird email mailboxes forwarding-address create <mailbox-id> [flags]

Description

Give a mailbox on your own domain an address on our receiving domain, so your current email provider can forward the mailbox's mail to it. Takes no request body; we choose the address. Returns the mailbox with forwarding_address set. If the mailbox already has one, returns it unchanged, so retrying is safe. Setting it up does not change DNS or your provider: add the forwarding rule there, then send a new test message to address. Returns 422 for a mailbox on the shared domain, which already receives directly, or when the domain is not verified in this workspace or another workspace receives mail for it.

Examples

Code example
bird email mailboxes forwarding-address create <id>

Options

NameDescription
--idempotency-keyDeduplication key; a retry with the same key won't act twice
--response-schemaPrint the fields this command returns, then exit

Continue with the documentation, guides and examples for this topic.