Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Paramètres de requête
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

Valeurs autorisées :data_uricid
Réponses
200

Received email

idstring<uuid>requis
tostring[]requis
fromstringrequis

Bare address from the From header; the display name is in headers.from

created_atstringrequis
subjectstringrequis
bccstring[]requis
ccstring[]requis
reply_tostring[]requis
received_forstring[]requis

The team's envelope recipients: the addresses the message was delivered to here

message_idstringrequis
attachmentsobject[]requis
Afficher les propriétés
Tableau de object
idstring<uuid>requis
filenamestring | nullrequis
content_typestringrequis
content_idstring | nullrequis
content_dispositionstring | nullrequis
sizeintegerrequis
inbox_idstring<uuid> | nullrequis

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> | nullrequis

BillionSend extension: that inbox's thread

inboxesobject[]

BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there

Afficher les propriétés
Tableau de object
inbox_idstring<uuid>requis
thread_idstring<uuid>requis
verdictstringrequis
Valeurs autorisées :pendingcleansuspiciousquarantinedreleased
spam_verdictstring | nullrequis

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

Valeurs autorisées :passgrayfailnull
virus_verdictstring | nullrequis

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

Valeurs autorisées :passfailprocessing_failednull
readboolean

BillionSend extension, with an inbox in context: whether that inbox marked it read

screeningobjectrequis

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

Afficher les propriétés
verdictstringrequis
Valeurs autorisées :pendingcleansuspiciousquarantinedreleased
sender_truststringrequis
Valeurs autorisées :ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullrequis
Valeurs autorisées :failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]requis
injection_scoreinteger | nullrequis
phishing_scoreinteger | nullrequis
hidden_text_removedbooleanrequis
spam_scoreinteger | nullrequis

BillionSend extension: the local spam score, 0-100

virus_signaturestring | nullrequis

BillionSend extension: clamd's signature name when it failed

extracted_textstring | nullrequis

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

extractedobjectrequis

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.

Afficher les propriétés
kindsstring[]requis
codestring | nullrequis
linkstring | nullrequis
link_domain_matches_senderboolean | nullrequis
ambiguousbooleanrequis
objectstringrequis
Valeurs autorisées :email
htmlstring | nullrequis
html_formatstringrequis
Valeurs autorisées :data_uricid
textstring | nullrequis
headersobject | nullrequis

Top-level headers, lowercase names; a repeated header's values joined by newlines

authenticationobjectrequis

pass, fail, gray, processing_failed or unknown, checked when the message arrived

Afficher les propriétés
spfstringrequis
dkimstringrequis
dmarcstringrequis
rawobject | nullrequis

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.

Afficher les propriétés
download_urlstringrequis
expires_atstringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

Restricted API key, or the email is quarantined

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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"
  }
}

Cette page vous a-t-elle été utile ?