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!",
});

msg = client.email.mailboxes.messages.create(
    "mbx_01krdgeqcxet5s7t44vh8rt9mg",
    to=[{"address": "user@example.com"}],
    subject="Hello",
    text="Hi there",
)
print(msg.id, msg.thread_id)

msg, err := client.Email.Mailboxes.Messages.Create(context.Background(), "mbx_123", bird.EmailMailboxesMessagesCreateParams{
	To:      []string{"customer@example.com"},
	Subject: "Following up",
	HTML:    "<p>Hi, just checking in.</p>",
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(msg.Id)

bird email mailboxes compose <mailbox-id> \
  --subject 'Your quote' \
  --text 'Hi, here is the quote you asked for.' \
  --to delivered@messagebird.dev

curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/messages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "delivered@messagebird.dev"
    ],
    "subject": "Your quote",
    "text": "Hi, here is the quote you asked for."
  }'

Réponse202

{
  "id": "rem_01krdgeqcxet5s7t44vh8rt9mg",
  "direction": "inbound",
  "channel": "email",
  "thread_id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
  "subject": "Re: Your order",
  "labels": [
    "inbox",
    "unread"
  ],
  "recipients": [
    {
      "status": "delivered"
    }
  ],
  "authentication": "pass",
  "attachment_manifest": [
    {
      "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
      "filename": "invoice.pdf",
      "content_type": "application/pdf"
    }
  ],
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "source": {
    "resource": "/v1/email/inbound-messages/rem_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

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.

Paramètres

mailbox_idstring

Mailbox identifier. Starts with mbx_.

Corps de la requête

to

array of string or object

obligatoire

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.

Afficher les paramètres enfants

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.

Afficher les paramètres enfants

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.

Afficher les paramètres enfants

subject

string

obligatoire

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).

Afficher les paramètres enfants

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 the mailbox's retention tier.

Afficher les paramètres enfants

tags

array of object

Structured {name, value} labels for filtering and analytics on the sent-message log. Cap: 20 tags per send.

Afficher les paramètres enfants

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

Contenu de la réponse

id

string

obligatoire

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

obligatoire

Which way the message went. inbound means you received it, outbound means you sent it.

Possible values: inbound, outbound

channel

string

obligatoire

Channel this message lives on. Always email.

thread_id

string

obligatoire

Conversation this message belongs to.

from

string

obligatoire

Sender address.

to

array of string

obligatoire

Recipient addresses on the To line.

cc

array of string

obligatoire

Recipient addresses on the Cc line. Empty when the message had none.

delivered_to

nullable string

obligatoire

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

obligatoire

Message subject. Null when the message had no subject.

preview

nullable string

obligatoire

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

obligatoire

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 is filed in Spam.
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

obligatoire

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

obligatoire

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

obligatoire

DMARC result for the domain in the received message's From header.

pass: SPF or DKIM passed and aligned with that domain.
fail: DMARC was evaluated and did not pass.
unknown: no trustworthy verdict is available.

This follows dmarc_pass and does not verify a particular person. The receiving provider currently supplies no DMARC result, so received messages report unknown.

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

obligatoire

Whether the receiving provider reports that SPF authorized the envelope sender for the sending server. A soft failure is false. Missing, neutral and inconclusive results are null. Sent messages have null results. Kept for the mailbox retention tier.

dkim_pass

nullable boolean

obligatoire

Whether the receiving provider verified a DKIM signature. A passing signature makes this true even when another signature fails. Missing signatures and inconclusive verification results are null. Sent messages have null results. Kept for the mailbox retention tier.

dmarc_pass

nullable boolean

obligatoire

Whether SPF or DKIM passed and aligned with the domain in the message's From header. The receiving provider currently supplies no DMARC result, so this is null. Sent messages have null results. Kept for the mailbox retention tier.

purge_at

string

obligatoire

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

obligatoire

Number of attachments on the message.

attachment_manifest

array of object

obligatoire

Attachment metadata (filename, content type, size). Both the metadata and the attachment bytes stay available for the mailbox's retention tier.

Afficher les attributs enfants

reference_ids

array of string

obligatoire

RFC 5322 References header entries used to thread the conversation.

contact_id

nullable string

obligatoire

Contact linked to this message, or null when none is linked.

source

object

obligatoire

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.

Afficher les attributs enfants

occurred_at

string

obligatoire

When the message was received or accepted for sending.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

const msg = await bird.email.mailboxes.messages.create("mbx_01abc", {
  to: ["customer@example.com"],
  subject: "Hello",
  text: "Hi there!",
});

msg = client.email.mailboxes.messages.create(
    "mbx_01krdgeqcxet5s7t44vh8rt9mg",
    to=[{"address": "user@example.com"}],
    subject="Hello",
    text="Hi there",
)
print(msg.id, msg.thread_id)

msg, err := client.Email.Mailboxes.Messages.Create(context.Background(), "mbx_123", bird.EmailMailboxesMessagesCreateParams{
	To:      []string{"customer@example.com"},
	Subject: "Following up",
	HTML:    "<p>Hi, just checking in.</p>",
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(msg.Id)

bird email mailboxes compose <mailbox-id> \
  --subject 'Your quote' \
  --text 'Hi, here is the quote you asked for.' \
  --to delivered@messagebird.dev

curl -X POST "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}/messages" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": [
      "delivered@messagebird.dev"
    ],
    "subject": "Your quote",
    "text": "Hi, here is the quote you asked for."
  }'

Réponse202

{
  "id": "rem_01krdgeqcxet5s7t44vh8rt9mg",
  "direction": "inbound",
  "channel": "email",
  "thread_id": "thr_01krdgeqcxet5s7t44vh8rt9mg",
  "subject": "Re: Your order",
  "labels": [
    "inbox",
    "unread"
  ],
  "recipients": [
    {
      "status": "delivered"
    }
  ],
  "authentication": "pass",
  "attachment_manifest": [
    {
      "id": "rea_01krdgeqcxet5s7t44vh8rt9mg",
      "filename": "invoice.pdf",
      "content_type": "application/pdf"
    }
  ],
  "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
  "source": {
    "resource": "/v1/email/inbound-messages/rem_01krdgeqcxet5s7t44vh8rt9mg"
  }
}

Create a message from a mailbox

Paramètres

Corps de la requête

Contenu de la réponse

Ressources associées