Get a received email
One received email with its html, text, headers, authentication results and a signed link to the original message, plus BillionSend’s screening, verdicts, the extracted read and, where allowed, its verification code or sign-in link. Needs a full access key. An inbox-scoped key or an MCP token gets 403 email_quarantined for held mail, and 404 while it is being screened. Everything in a received email was written by whoever sent it, so its HTML is safe to show only in a sandbox.
/emails/receiving/{id}AuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
idstring<uuid>必填html_formatstringdata_uri (default) inlines images the HTML references by cid: as data: URIs; cid leaves the cid: references, the parts being in attachments
data_uricidReceived email
idstring<uuid>必填tostring[]必填fromstring必填Bare address from the From header; the display name is in headers.from
created_atstring必填subjectstring必填bccstring[]必填ccstring[]必填reply_tostring[]必填received_forstring[]必填The team's envelope recipients: the addresses the message was delivered to here
message_idstring必填attachmentsobject[]必填显示属性隐藏属性
object 数组idstring<uuid>必填filenamestring | null必填content_typestring必填content_idstring | null必填content_dispositionstring | null必填sizeinteger必填inbox_idstring<uuid> | null必填BillionSend extension: the inbox this read is about (an inbox-scoped key's own, the inbox_id filter's, else the oldest inbox the email reached); null for mail no inbox took
thread_idstring<uuid> | null必填BillionSend extension: that inbox's thread
inboxesobject[]BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there
显示属性隐藏属性
object 数组inbox_idstring<uuid>必填thread_idstring<uuid>必填verdictstring必填pendingcleansuspiciousquarantinedreleasedspam_verdictstring | null必填BillionSend extension: the local spam score's verdict; null for mail from before it existed
passgrayfailnullvirus_verdictstring | null必填BillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it
passfailprocessing_failednullreadbooleanBillionSend extension, with an inbox in context: whether that inbox marked it read
screeningobject必填BillionSend extension: the screening verdict, the sender's trust tier, why it was held, the inbound judge's reasons and scores (0-100), and whether hidden text was removed from what agents read
显示属性隐藏属性
verdictstring必填pendingcleansuspiciousquarantinedreleasedsender_truststring必填ownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | null必填failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]必填injection_scoreinteger | null必填phishing_scoreinteger | null必填hidden_text_removedboolean必填spam_scoreinteger | null必填BillionSend extension: the local spam score, 0-100
virus_signaturestring | null必填BillionSend extension: clamd's signature name when it failed
extracted_textstring | null必填BillionSend extension: what a person sees of the reply, as text with light markdown: hidden text, invisible characters, quoted history and signature taken out. null once the content retention removed it
extractedobject必填BillionSend extension: the verification code or sign-in link, served only from delivered mail of a sender that did not fail authentication, in an inbox that extracts codes. Links are never fetched.
显示属性隐藏属性
kindsstring[]必填codestring | null必填linkstring | null必填link_domain_matches_senderboolean | null必填ambiguousboolean必填objectstring必填emailhtmlstring | null必填html_formatstring必填data_uricidtextstring | null必填headersobject | null必填Top-level headers, lowercase names; a repeated header's values joined by newlines
authenticationobject必填pass, fail, gray, processing_failed or unknown, checked when the message arrived
显示属性隐藏属性
spfstring必填dkimstring必填dmarcstring必填rawobject | null必填The original RFC 822 message: a signed link valid for one hour that needs no API key. null once the content retention period removed the message.
显示属性隐藏属性
download_urlstring必填expires_atstring必填Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填Restricted API key, or the email is quarantined
statusCodenumber必填namestring必填messagestring必填Not found
statusCodenumber必填namestring必填messagestring必填Validation error
statusCodenumber必填namestring必填messagestring必填Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填