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-Token · headererforderlichA BillionSend API key (bs_…).
idstring<uuid>erforderlichhtml_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>erforderlichtostring[]erforderlichfromstringerforderlichBare address from the From header; the display name is in headers.from
created_atstringerforderlichsubjectstringerforderlichbccstring[]erforderlichccstring[]erforderlichreply_tostring[]erforderlichreceived_forstring[]erforderlichThe team's envelope recipients: the addresses the message was delivered to here
message_idstringerforderlichattachmentsobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
objectidstring<uuid>erforderlichfilenamestring | nullerforderlichcontent_typestringerforderlichcontent_idstring | nullerforderlichcontent_dispositionstring | nullerforderlichsizeintegererforderlichinbox_idstring<uuid> | nullerforderlichBillionSend 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> | nullerforderlichBillionSend extension: that inbox's thread
inboxesobject[]BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there
Eigenschaften anzeigenEigenschaften ausblenden
objectinbox_idstring<uuid>erforderlichthread_idstring<uuid>erforderlichverdictstringerforderlichpendingcleansuspiciousquarantinedreleasedspam_verdictstring | nullerforderlichBillionSend extension: the local spam score's verdict; null for mail from before it existed
passgrayfailnullvirus_verdictstring | nullerforderlichBillionSend 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
screeningobjecterforderlichBillionSend 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
Eigenschaften anzeigenEigenschaften ausblenden
verdictstringerforderlichpendingcleansuspiciousquarantinedreleasedsender_truststringerforderlichownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullerforderlichfailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]erforderlichinjection_scoreinteger | nullerforderlichphishing_scoreinteger | nullerforderlichhidden_text_removedbooleanerforderlichspam_scoreinteger | nullerforderlichBillionSend extension: the local spam score, 0-100
virus_signaturestring | nullerforderlichBillionSend extension: clamd's signature name when it failed
extracted_textstring | nullerforderlichBillionSend 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
extractedobjecterforderlichBillionSend 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.
Eigenschaften anzeigenEigenschaften ausblenden
kindsstring[]erforderlichcodestring | nullerforderlichlinkstring | nullerforderlichlink_domain_matches_senderboolean | nullerforderlichambiguousbooleanerforderlichobjectstringerforderlichemailhtmlstring | nullerforderlichhtml_formatstringerforderlichdata_uricidtextstring | nullerforderlichheadersobject | nullerforderlichTop-level headers, lowercase names; a repeated header's values joined by newlines
authenticationobjecterforderlichpass, fail, gray, processing_failed or unknown, checked when the message arrived
Eigenschaften anzeigenEigenschaften ausblenden
spfstringerforderlichdkimstringerforderlichdmarcstringerforderlichrawobject | nullerforderlichThe 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.
Eigenschaften anzeigenEigenschaften ausblenden
download_urlstringerforderlichexpires_atstringerforderlichMissing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichRestricted API key, or the email is quarantined
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichNot found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichValidation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich