Documentation
Sign inGet started

Create a message from a mailbox

POST
/v1/email/mailboxes/{mailbox_id}/messages
const msg = await bird.email.mailboxes.messages.create("mbx_01abc", {
  to: ["customer@example.com"],
  subject: "Hello",
  text: "Hi there!",
});
Sends a new message from the mailbox's own address and starts a new conversation with it. The request mirrors the plain send request minus from, because the mailbox is who the message comes from. We set the RFC 5322 Message-ID, so later replies from the recipients thread back into the conversation automatically. The send is added to the mailbox's remembered messages and returned as the conversation's first message. A mailbox always sends immediately; scheduled sends are unavailable. A suspended mailbox cannot send and returns 403.
Payload della richiesta
to
array of string or object
obbligatorio
Primary recipients. Each entry is a plain email string, an RFC 5322 mailbox string (Jane <jane@acme.com>), or an object with an optional display name.
Mostra parametri secondari
to.email
string
obbligatorio
Email address.
to.name
string
Display name shown alongside the address in mail clients.
cc
array of string or object
CC recipients. Each entry is a plain email string, an RFC 5322 mailbox string (Jane <jane@acme.com>), or an object with an optional display name.
Mostra parametri secondari
cc.email
string
obbligatorio
Email address.
cc.name
string
Display name shown alongside the address in mail clients.
bcc
array of string or object
BCC recipients. Each entry is a plain email string, an RFC 5322 mailbox string (Jane <jane@acme.com>), or an object with an optional display name.
Mostra parametri secondari
bcc.email
string
obbligatorio
Email address.
bcc.name
string
Display name shown alongside the address in mail clients.
subject
string
obbligatorio
Message subject line.
html
string
HTML body. At least one of html or text must be provided.
text
string
Plain-text body. At least one of html or text must be provided.
reply_to
array of string or object
Reply-To addresses. When omitted, the mailbox's default_reply_to applies (replies then come back to the mailbox itself).
Mostra parametri secondari
reply_to.email
string
obbligatorio
Email address.
reply_to.name
string
Display name shown alongside the address in mail clients.
attachments
array of object
File attachments. The send is rejected when the estimated generated message size exceeds 20 MB (bodies plus all attachments after base64 encoding). Keep total raw attachment content at or below 15 MB for reliable headroom. Attachment metadata stays on the message's attachment_manifest, and the bytes are downloadable for 30 days.
Mostra parametri secondari
attachments.filename
string
obbligatorio
The name the recipient sees on the attachment.
attachments.content
string
obbligatorio
Base64-encoded file bytes. The encoded value and MIME wrapping count toward the 20 MB message limit.
attachments.content_type
string
The file's MIME type. If omitted, the API infers it from the extension in filename. The API rejects executable and script types based on this value.
attachments.content_id
string
An RFC 2392 Content-ID for an inline file. Reference it from the HTML body with <img src="cid:{content_id}"/>. Omit it to send a downloadable attachment.
tags
array of object
Structured {name, value} labels for filtering and analytics on the sent-message log. Cap: 20 tags per send.
Mostra parametri secondari
tags.name
string
obbligatorio
Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
tags.value
string
obbligatorio
Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
metadata
object
Arbitrary JSON object stored on the send and echoed in webhook payloads. Cap: 2 KB serialized.
category
string
Content classification, which controls suppression policy:
  • marketing: Blocks on all suppression reasons.
  • transactional: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail.
Possible values: marketing, transactional
Payload di risposta
id
string
obbligatorio
Message ID. Received messages have a rem_ ID, sent messages an em_ ID: the same IDs used by the received-message and sent-message logs.
direction
string
obbligatorio
Which way the message went. inbound means you received it, outbound means you sent it.
Possible values: inbound, outbound
channel
string
obbligatorio
Channel this message lives on. Always email.
thread_id
string
obbligatorio
Conversation this message belongs to.
from
string
obbligatorio
Sender address.
to
array of string
obbligatorio
Recipient addresses on the To line.
cc
array of string
obbligatorio
Recipient addresses on the Cc line. Empty when the message had none.
delivered_to
nullable string
obbligatorio
Address the message was actually delivered to, when it differs from the mailbox address (for example mail routed in from another address). Null for sent messages and for mail addressed directly to the mailbox.
subject
nullable string
obbligatorio
Message subject. Null when the message had no subject.
preview
nullable string
obbligatorio
Short plain-text preview of the message body.
extracted_text
nullable string
Plain-text content of the message with quoted history stripped. Readable for the mailbox's full retention tier, in both directions. Always present when fetching a single message. On list endpoints it is included only when the request sets include=extracted_text. Null when no text could be extracted.
labels
array of string
obbligatorio
Labels on this message. A received message always has exactly one placement label:
  • inbox: Accepted mail.
  • archive: The message's conversation was filed away.
  • spam: The message failed sender authentication.
  • blocked: The message was rejected by the mailbox's receive policy or rules.
A received message also has unread until it is read. trash marks a message in the trash, in either direction. Custom labels share the same list, and a message has at most 20 labels in total.
status
nullable string
obbligatorio
Aggregate delivery status of a sent message:
  • accepted: Accepted for sending.
  • sent: Handed off to the provider.
  • delivered: All attempted recipients delivered.
  • failed: Terminal failure.
Null for received messages.
recipients
nullable array
obbligatorio
Terminal per-recipient delivery outcomes of a sent message, filled in as each one becomes known and kept for the mailbox's full retention tier. Null for received messages and before any recipient reaches a terminal state. Per-recipient event detail lives on the sent-message log (source) for 30 days.
authentication
nullable string
obbligatorio
Whether the sender of a received message was authenticated.
  • pass: the sender's identity was verified.
  • fail: it was checked and did not verify.
  • unknown: no verdict could be determined, so do not treat the sender as verified.
Null for sent messages. This field is readable for the mailbox's full retention tier, so the verdict is still available after the 30-day received-message log has expired.
Possible values: pass, fail, unknown, null
spf_pass
nullable boolean
obbligatorio
Whether SPF passed for the sender of a received message. Null for sent messages and when no verdict is available. This field is kept for the mailbox's retention tier.
dkim_pass
nullable boolean
obbligatorio
Whether DKIM passed for the sender of a received message. Null for sent messages and when no verdict is available. This field is kept for the mailbox's retention tier.
dmarc_pass
nullable boolean
obbligatorio
Whether DMARC passed for the sender of a received message. Null for sent messages and when no verdict is available. This field is kept for the mailbox's retention tier.
purge_at
string
obbligatorio
Scheduled permanent-deletion time. This is the end of the mailbox's retention tier, moved to no more than 30 days in the future while the message is in the trash. Restore a trashed message before then with PATCH {"labels": {"remove": ["trash"]}}.
attachment_count
integer
obbligatorio
Number of attachments on the message.
attachment_manifest
array of object
obbligatorio
Attachment metadata (filename, content type, size). Stays readable for the mailbox's retention tier even after the attachment bytes themselves have expired.
Mostra attributi secondari
attachment_manifest.id
string
obbligatorio
Attachment ID, used to download the attachment bytes.
attachment_manifest.filename
nullable string
obbligatorio
Original filename, or null when the attachment had none.
attachment_manifest.content_type
nullable string
obbligatorio
MIME content type, or null when it could not be determined.
attachment_manifest.size
integer
obbligatorio
Attachment size in bytes.
reference_ids
array of string
obbligatorio
RFC 5322 References header entries used to thread the conversation.
contact_id
nullable string
obbligatorio
Contact linked to this message, or null when none is linked.
source
object
obbligatorio
Link to the message's entry in the received-message or sent-message log, which has delivery analytics such as per-recipient events. Log entries expire 30 days after the message occurred.
Mostra attributi secondari
source.resource
string
obbligatorio
API path of the log entry for this message.
source.available_until
string
obbligatorio
When the log entry (and the message's original rendered source) expires.
occurred_at
string
obbligatorio
When the message was received or accepted for sending.