bird email
Usage
Codebeispiel
bird emailDescription
Send and inspect email messages, receive email at inbound addresses, and manage
the email channel's deliverability resources — sending domains, dedicated IPs,
and IP pools — under one group.
Reads return JSON; list is paginated. Mutations take flags and/or a --body-file JSON body (flags overriding); run --example to print the body shape or --dry-run to preview the request.
Procedure
Send an email
Deliver email to explicit recipients. The sender must be a verified domain, or the shared onboarding domain on a new workspace; the result is accepted (queued, delivered asynchronously), not yet delivered.
Requires: The from must be a sender the workspace can use: a verified sending domain, or the shared onboarding domain on a new workspace.
- bird email send — Returns accepted (HTTP 202), delivered asynchronously; not confirmation of delivery. Next: bird email get
Messages
| Name | Description |
|---|---|
| send | Send an email message. |
| send-batch | Send a batch of email messages in one call. |
| get | Get a message |
| list | List messages |
| cancel | Cancel a scheduled message |
| content | Get stored message content |
| recipients | List recipients of a message |
Deliverability
| Name | Description |
|---|---|
| domains | Manage email sending domains |
| dedicated-ips | Manage dedicated IPs |
| ip-pools | Manage IP pools |
| suppressions | Manage the email suppression list |
| tools | Email deliverability tools |
Inbound
| Name | Description |
|---|---|
| inbound-addresses | Manage inbound (forward) email addresses |
| inbound-messages | Read received (inbound) emails |
Analytics
| Name | Description |
|---|---|
| stats | Read aggregate email statistics |