Get a received email
GET
/v1/email/inbound-messages/{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. Fetch the body with /body and attachment bytes with /attachments/{attachment_id}.
响应载荷
id
string
必填
Received message ID.
from
object
必填
Sender address parsed from the message.
显示子属性
from.email
string
必填
Email address.
from.name
string
Display name shown alongside the address in mail clients.
to
array of object
必填
Recipients on the message's To header.
显示子属性
to.email
string
必填
Email address.
to.name
string
Display name shown alongside the address in mail clients.
cc
array of object
必填
Recipients on the message's Cc header.
显示子属性
cc.email
string
必填
Email address.
cc.name
string
Display name shown alongside the address in mail clients.
subject
nullable string
必填
Subject line as received, or null when the message had no subject.
message_id
nullable string
必填
RFC 5322 Message-ID header from the sender, or null when the sender did not include one.
in_reply_to
nullable string
必填
In-Reply-To header — the Message-ID this message replies to, or null when it is not a reply.
references
array of string
References header — the chain of Message-IDs in this conversation, oldest first. Absent when the message had no References header.
thread_id
nullable string
必填
Conversation this message belongs to. Always null until threading is available.
spf_pass
nullable boolean
必填
Whether SPF passed for the sender, parsed from the message's authentication results. Null when the result did not carry an SPF verdict.
dkim_pass
nullable boolean
必填
Whether DKIM passed for the sender, parsed from the message's authentication results. Null when the result did not carry a DKIM verdict.
dmarc_pass
nullable boolean
必填
Whether DMARC passed for the sender, parsed from the message's authentication results. Null when the result did not carry a DMARC verdict.
spam_score
nullable number
必填
Spam score for the message. Always null at present; reserved for a future content-scoring capability.
attachments
array of object
必填
Metadata for each attachment found on the message. Empty when the message had no attachments.
显示子属性
attachments.id
string
必填
Attachment ID, stable within the received message.
attachments.filename
nullable string
必填
Filename from the attachment's Content-Disposition, or null when the sender did not name the part.
attachments.content_type
nullable string
必填
MIME type parsed from the attachment part, or null when absent.
attachments.size
integer
必填
Size of the attachment in bytes.
received_at
string
必填
When Bird received the message.