Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstring<uuid>obligatorio
Parámetros de consulta
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

Valores permitidos:data_uricid
Respuestas
200

Received email

idstring<uuid>obligatorio
tostring[]obligatorio
fromstringobligatorio

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

created_atstringobligatorio
subjectstringobligatorio
bccstring[]obligatorio
ccstring[]obligatorio
reply_tostring[]obligatorio
received_forstring[]obligatorio

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

message_idstringobligatorio
attachmentsobject[]obligatorio
Mostrar propiedades
Array de object
idstring<uuid>obligatorio
filenamestring | nullobligatorio
content_typestringobligatorio
content_idstring | nullobligatorio
content_dispositionstring | nullobligatorio
sizeintegerobligatorio
inbox_idstring<uuid> | nullobligatorio

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

BillionSend extension: that inbox's thread

inboxesobject[]

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

Mostrar propiedades
Array de object
inbox_idstring<uuid>obligatorio
thread_idstring<uuid>obligatorio
verdictstringobligatorio
Valores permitidos:pendingcleansuspiciousquarantinedreleased
spam_verdictstring | nullobligatorio

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

Valores permitidos:passgrayfailnull
virus_verdictstring | nullobligatorio

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

Valores permitidos:passfailprocessing_failednull
readboolean

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

screeningobjectobligatorio

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

Mostrar propiedades
verdictstringobligatorio
Valores permitidos:pendingcleansuspiciousquarantinedreleased
sender_truststringobligatorio
Valores permitidos:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullobligatorio
Valores permitidos:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]obligatorio
injection_scoreinteger | nullobligatorio
phishing_scoreinteger | nullobligatorio
hidden_text_removedbooleanobligatorio
spam_scoreinteger | nullobligatorio

BillionSend extension: the local spam score, 0-100

virus_signaturestring | nullobligatorio

BillionSend extension: clamd's signature name when it failed

extracted_textstring | nullobligatorio

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

extractedobjectobligatorio

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.

Mostrar propiedades
kindsstring[]obligatorio
codestring | nullobligatorio
linkstring | nullobligatorio
link_domain_matches_senderboolean | nullobligatorio
ambiguousbooleanobligatorio
objectstringobligatorio
Valores permitidos:email
htmlstring | nullobligatorio
html_formatstringobligatorio
Valores permitidos:data_uricid
textstring | nullobligatorio
headersobject | nullobligatorio

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

authenticationobjectobligatorio

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

Mostrar propiedades
spfstringobligatorio
dkimstringobligatorio
dmarcstringobligatorio
rawobject | nullobligatorio

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.

Mostrar propiedades
download_urlstringobligatorio
expires_atstringobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key, or the email is quarantined

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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"
  }
}

¿Te ha resultado útil esta página?