List messages in a thread

GET

/v1/email/threads/{thread_id}/messages

for await (const msg of bird.email.threads.messages.list("thr_01abc")) {
  console.log(msg.id, msg.direction);
}

for message in client.email.threads.messages.list("thr_01krdgeqcxet5s7t44vh8rt9mg"):
    print(message.id, message.subject)

for msg, err := range client.Email.Threads.Messages.List(context.Background(), "thr_123", bird.EmailThreadsMessagesListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(msg.Id, msg.Direction)
}

foreach ($bird->email->threads->messages->list('thr_01krdgeqcxet5s7t44vh8rt9mg') as $message) {
    echo $message->getId(), ' ', $message->getDirection(), "\n";
}

bird email threads messages list <thread-id>

curl -X GET "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "label=unread" \
  --url-query "limit=25"

Returns the messages in a conversation, newest first, both received and sent. To page through older messages, use starting_after. The sort order is fixed, so to render the messages in conversation order, reverse the page yourself.

By default, every message that is not in the trash is returned, whichever folder the conversation is in. Pass label to narrow the view instead: use trash for trashed messages, or any custom label.

Pass include=extracted_text to inline each message's extracted plain text. A thread whose retention tier has ended returns 410 Gone.

Query पैरामीटर

direction

string

Filter to received (inbound) or sent (outbound) messages.

Possible values: outbound, inbound

label

string

Filter to messages that have this label. trash lists trashed messages. Any other label, whether that is archive, spam, blocked, unread or one of your own, lists the messages that have it and are not in the trash. When omitted, received messages in the inbox and all sent messages are returned.

include

string

Set to extracted_text to inline each message's extracted plain text.

Possible values: extracted_text

limit

integer

Maximum number of items to return per page.

starting_after

string

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_before

string

Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.

Response Payload

data

array of object

आवश्यक

चाइल्ड एट्रिब्यूट दिखाएँ

data.id

string

आवश्यक

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.

data.direction

string

आवश्यक

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

Possible values: inbound, outbound

data.channel

string

आवश्यक

Channel this message lives on. Always email.

data.thread_id

string

आवश्यक

Conversation this message belongs to.

data.from

string

आवश्यक

Sender address.

data.to

array of string

आवश्यक

Recipient addresses on the To line.

data.cc

array of string

आवश्यक

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

data.delivered_to

nullable string

आवश्यक

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.

data.subject

nullable string

आवश्यक

Message subject. Null when the message had no subject.

data.preview

nullable string

आवश्यक

Short plain-text preview of the message body.

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

data.labels

array of string

आवश्यक

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.

data.status

nullable string

आवश्यक

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

data.recipients

nullable array

आवश्यक

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.

data.authentication

nullable string

आवश्यक

Whether the sender of a received message was authenticated. pass means the sender's identity was verified. fail means it was checked and did not verify. unknown means no verdict could be determined, and the sender should not be treated 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

data.spf_pass

nullable boolean

आवश्यक

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.

data.dkim_pass

nullable boolean

आवश्यक

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.

data.dmarc_pass

nullable boolean

आवश्यक

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.

data.purge_at

string

आवश्यक

When the message will be permanently deleted: the end of the mailbox's retention tier, pulled nearer (at most 30 days out) while the message is in the trash. Restore a trashed message before then with PATCH {"labels": {"remove": ["trash"]}}.

data.attachment_count

integer

आवश्यक

Number of attachments on the message.

data.attachment_manifest

array of object

आवश्यक

Attachment metadata (filename, content type, size). Stays readable for the mailbox's retention tier even after the attachment bytes themselves have expired.

चाइल्ड एट्रिब्यूट दिखाएँ

data.attachment_manifest.id

string

आवश्यक

Attachment ID, used to download the attachment bytes.

data.attachment_manifest.filename

nullable string

आवश्यक

Original filename, or null when the attachment had none.

data.attachment_manifest.content_type

nullable string

आवश्यक

MIME content type, or null when it could not be determined.

data.attachment_manifest.size

integer

आवश्यक

Attachment size in bytes.

data.reference_ids

array of string

आवश्यक

RFC 5322 References header entries used to thread the conversation.

data.contact_id

nullable string

आवश्यक

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

data.source

object

आवश्यक

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.

चाइल्ड एट्रिब्यूट दिखाएँ

data.source.resource

string

आवश्यक

API path of the log entry for this message.

data.source.available_until

string

आवश्यक

When the log entry (and the message's original rendered source) expires.

data.occurred_at

string

आवश्यक

When the message was received or accepted for sending.

next_cursor

nullable string

आवश्यक

Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.

prev_cursor

nullable string

आवश्यक

Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.

refresh_cursor

nullable string

आवश्यक

Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

for await (const msg of bird.email.threads.messages.list("thr_01abc")) {
  console.log(msg.id, msg.direction);
}

for message in client.email.threads.messages.list("thr_01krdgeqcxet5s7t44vh8rt9mg"):
    print(message.id, message.subject)

for msg, err := range client.Email.Threads.Messages.List(context.Background(), "thr_123", bird.EmailThreadsMessagesListParams{}) {
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(msg.Id, msg.Direction)
}

foreach ($bird->email->threads->messages->list('thr_01krdgeqcxet5s7t44vh8rt9mg') as $message) {
    echo $message->getId(), ' ', $message->getDirection(), "\n";
}

bird email threads messages list <thread-id>

curl -X GET "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "label=unread" \
  --url-query "limit=25"