bird email
Usage
Exemplo de código
bird emailDescription
A send names a from address on a verified sending domain and is accepted for delivery
rather than delivered on the call, so a message's outcome is read back afterwards.
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 |
Templates
| Name | Description |
|---|---|
| templates | Author and manage reusable email templates |
Deliverability
| Name | Description |
|---|---|
| domains | Manage email sending domains |
| dedicated-ips | Buy, warm, and pool dedicated sending IPs |
| ip-pools | Group dedicated IPs into pools a send can target |
| suppressions | Manage the email suppression list |
| unsubscribe-page | Style the hosted unsubscribe page |
| tools | Email deliverability tools |
Inbound
| Name | Description |
|---|---|
| inbound-addresses | Manage inbound (forward) email addresses |
| inbound-messages | Read received (inbound) emails |
Agent Mailboxes
| Name | Description |
|---|---|
| mailboxes | Manage agent email mailboxes |
| threads | Read and reply to mailbox conversation threads |
Broadcasts
| Name | Description |
|---|---|
| broadcasts | Send one piece of content to a stored audience |
Analytics
| Name | Description |
|---|---|
| stats | Read aggregate email statistics |
| health | Get sending health and deliverability limits |
| competitive | Manage competitive email intelligence |
| inbox-insights | Read inbox placement and reputation for owned domains |
Recursos relacionados
Continue com a documentação, guias e exemplos sobre este tópico. Os recursos estão em inglês.
Assista ao guiaGetting started with emailExplore a funcionalidadeEmailSiga o percurso de aprendizagemBuild your first integrationGuia de implementaçãoSend your first email
Experimente na prática e obtenha um resumo de implementação