Documentation
Sign inGet started

bird email mailboxes update

Usage

कोड उदाहरण
bird email mailboxes update <mailbox-id> [flags]

Description

Update a mailbox
Only the fields you pass change; the address and domain can't be changed. To clear a nullable field (display-name, default-reply-to), pass an explicit null via --body-file, e.g. --body-file '{"display_name": null}'.
Build the request from flags, a JSON MailboxUpdate 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

कोड उदाहरण
# print the body shape (no credentials needed)
bird email mailboxes update --example

# the body it prints:
कोड उदाहरण
{
  "display_name": "Acme Concierge",
  "retention_tier": "30d"
}

Options

Address

NameDescription
--display-nameSender display name on outgoing mail
--default-reply-toDefault Reply-To address stamped on outgoing mail

Behavior

NameDescription
--receive-policyWhich inbound mail to accept: open, replies_only, allowlist, or drop
--retention-tierHow long to remember message metadata and text: 30d
--confirmRequired when lowering retention-tier would delete older messages

Metadata

NameDescription
--metadataArbitrary JSON metadata object; replaces the existing metadata

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 composeSend a new message from a mailbox
bird email mailboxes createCreate a mailbox
bird email mailboxes deleteDelete a mailbox
bird email mailboxes getGet a mailbox
bird email mailboxes labelsList a mailbox's labels
bird email mailboxes listList mailboxes
bird email mailboxes restoreRestore a deleted mailbox
bird email mailboxes resumeResume a suspended mailbox
bird email mailboxes statsMailbox email statistics