跳到内容
Esc
↑↓导航↵打开⌘J预览

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.

GET/emails/receiving/{id}
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
idstring<uuid>必填
查询参数
html_formatstring

data_uri (default) inlines images the HTML references by cid: as data: URIs; cid leaves the cid: references, the parts being in attachments

允许值:data_uricid
响应
200

Received 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必填
允许值:pendingcleansuspiciousquarantinedreleased
spam_verdictstring | null必填

BillionSend extension: the local spam score's verdict; null for mail from before it existed

允许值:passgrayfailnull
virus_verdictstring | null必填

BillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it

允许值:passfailprocessing_failednull
readboolean

BillionSend 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必填
允许值:pendingcleansuspiciousquarantinedreleased
sender_truststring必填
允许值:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | null必填
允许值:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]必填
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必填
允许值:email
htmlstring | null必填
html_formatstring必填
允许值:data_uricid
textstring | 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必填
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Restricted API key, or the email is quarantined

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "to": [
    "string"
  ],
  "from": "string",
  "created_at": "string",
  "subject": "string",
  "bcc": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "reply_to": [
    "string"
  ],
  "received_for": [
    "string"
  ],
  "message_id": "string",
  "attachments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filename": "string",
      "content_type": "string",
      "content_id": "string",
      "content_disposition": "string",
      "size": 0
    }
  ],
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  "inboxes": [
    {
      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "verdict": "pending"
    }
  ],
  "spam_verdict": "pass",
  "virus_verdict": "pass",
  "read": true,
  "screening": {
    "verdict": "pending",
    "sender_trust": "owner",
    "quarantine_reason": "failed_auth",
    "reasons": [
      "string"
    ],
    "injection_score": 0,
    "phishing_score": 0,
    "hidden_text_removed": true
  },
  "spam_score": 0,
  "virus_signature": "string",
  "extracted_text": "string",
  "extracted": {
    "kinds": [
      "code"
    ],
    "code": "string",
    "link": "string",
    "link_domain_matches_sender": true,
    "ambiguous": true
  },
  "object": "email",
  "html": "string",
  "html_format": "data_uri",
  "text": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "authentication": {
    "spf": "string",
    "dkim": "string",
    "dmarc": "string"
  },
  "raw": {
    "download_url": "string",
    "expires_at": "string"
  }
}

这个页面有帮助吗?