Get a received email
GET
/v1/email/inbound-messages/{inbound_message_id}
bird email inbound-messages get <inbound-message-id>curl -X GET "https://us1.platform.bird.com/v1/email/inbound-messages/{inbound_message_id}" \
-H "Authorization: Bearer $TOKEN"Returns the parsed metadata for a received email:
- Addresses.
- Subject.
- Threading headers.
- Authentication results.
- The attachment manifest.
Content is fetched separately:
- Get the parsed body from Get a received email's body.
- Get the original MIME from Get a received email's raw content.
- Get attachment bytes from Get a received email's attachment.
Received emails are retained for 30 days. An unknown or expired message returns 404.
Treść odpowiedzi
id
string
wymagane
Received message ID.
from
object
wymagane
Sender address parsed from the message.
Pokaż atrybuty podrzędne
from.email
string
wymagane
Email address.
from.name
string
Display name shown alongside the address in mail clients.
to
array of object
wymagane
Recipients on the message's To header.
Pokaż atrybuty podrzędne
to.email
string
wymagane
Email address.
to.name
string
Display name shown alongside the address in mail clients.
cc
array of object
wymagane
Recipients on the message's Cc header.
Pokaż atrybuty podrzędne
cc.email
string
wymagane
Email address.
cc.name
string
Display name shown alongside the address in mail clients.
subject
nullable string
wymagane
Subject line as received, or null when the message had no subject.
message_id
nullable string
wymagane
RFC 5322 Message-ID header from the sender, or null when the sender did not include one.
in_reply_to
nullable string
wymagane
The In-Reply-To header, which holds the Message-ID this message is replying to. Null when the message is not a reply.
references
array of string
The References header, which holds every Message-ID in this conversation, oldest first. Left out when the message arrived without one.
thread_id
nullable string
wymagane
Conversation this message belongs to, or null when it is not grouped into one.
authentication
nullable string
wymagane
Whether the sender of the received message was authenticated:
- pass: The sender's identity was verified.
- fail: The sender's identity was checked and did not verify.
- unknown: No verdict is available, so the sender should not be treated as verified.
Possible values: pass, fail, unknown, null
spf_pass
nullable boolean
wymagane
Whether SPF passed for the sender, parsed from the message's authentication results. Null when the authentication results did not include an SPF verdict.
dkim_pass
nullable boolean
wymagane
Whether DKIM passed for the sender, parsed from the message's authentication results. Null when the authentication results did not include a DKIM verdict.
dmarc_pass
nullable boolean
wymagane
Whether DMARC passed for the sender, parsed from the message's authentication results. Null when the authentication results did not include a DMARC verdict.
spam_score
nullable number
wymagane
Spam score on the received message, or null when there is no score.
attachments
array of object
wymagane
Metadata for each attachment found on the message. Empty when the message had no attachments.
Pokaż atrybuty podrzędne
attachments.id
string
wymagane
Attachment ID, stable within the received message.
attachments.filename
nullable string
wymagane
Filename from the attachment's Content-Disposition, or null when the sender did not name the part.
attachments.content_type
nullable string
wymagane
MIME type parsed from the attachment part, or null when absent.
attachments.size
integer
wymagane
Size of the attachment in bytes.
received_at
string
wymagane
When the message was received.