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}.
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
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
wymagane
Conversation this message belongs to. Always null until threading is available.
spf_pass
nullable boolean
wymagane
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
wymagane
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
wymagane
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
wymagane
Spam score for the message. Always null at present; reserved for a future content-scoring capability.
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 Bird received the message.