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}AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
idstring<uuid>obrigatóriohtml_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>obrigatóriotostring[]obrigatóriofromstringobrigatórioBare address from the From header; the display name is in headers.from
created_atstringobrigatóriosubjectstringobrigatóriobccstring[]obrigatórioccstring[]obrigatórioreply_tostring[]obrigatórioreceived_forstring[]obrigatórioThe team's envelope recipients: the addresses the message was delivered to here
message_idstringobrigatórioattachmentsobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectidstring<uuid>obrigatóriofilenamestring | nullobrigatóriocontent_typestringobrigatóriocontent_idstring | nullobrigatóriocontent_dispositionstring | nullobrigatóriosizeintegerobrigatórioinbox_idstring<uuid> | nullobrigatórioBillionSend 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> | nullobrigatórioBillionSend extension: that inbox's thread
inboxesobject[]BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there
Mostrar propriedadesOcultar propriedades
objectinbox_idstring<uuid>obrigatóriothread_idstring<uuid>obrigatórioverdictstringobrigatóriopendingcleansuspiciousquarantinedreleasedspam_verdictstring | nullobrigatórioBillionSend extension: the local spam score's verdict; null for mail from before it existed
passgrayfailnullvirus_verdictstring | nullobrigatórioBillionSend 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
screeningobjectobrigatórioBillionSend 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
Mostrar propriedadesOcultar propriedades
verdictstringobrigatóriopendingcleansuspiciousquarantinedreleasedsender_truststringobrigatórioownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullobrigatóriofailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]obrigatórioinjection_scoreinteger | nullobrigatóriophishing_scoreinteger | nullobrigatóriohidden_text_removedbooleanobrigatóriospam_scoreinteger | nullobrigatórioBillionSend extension: the local spam score, 0-100
virus_signaturestring | nullobrigatórioBillionSend extension: clamd's signature name when it failed
extracted_textstring | nullobrigatórioBillionSend 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
extractedobjectobrigatórioBillionSend 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.
Mostrar propriedadesOcultar propriedades
kindsstring[]obrigatóriocodestring | nullobrigatóriolinkstring | nullobrigatóriolink_domain_matches_senderboolean | nullobrigatórioambiguousbooleanobrigatórioobjectstringobrigatórioemailhtmlstring | nullobrigatóriohtml_formatstringobrigatóriodata_uricidtextstring | nullobrigatórioheadersobject | nullobrigatórioTop-level headers, lowercase names; a repeated header's values joined by newlines
authenticationobjectobrigatóriopass, fail, gray, processing_failed or unknown, checked when the message arrived
Mostrar propriedadesOcultar propriedades
spfstringobrigatóriodkimstringobrigatóriodmarcstringobrigatóriorawobject | nullobrigatórioThe 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.
Mostrar propriedadesOcultar propriedades
download_urlstringobrigatórioexpires_atstringobrigatórioMissing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioRestricted API key, or the email is quarantined
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioNot found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório