Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Get a thread email

One message of the thread. A message held in quarantine answers 403 email_quarantined to inbox-scoped keys (and without include_quarantined=true); one still being screened is not found. Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.

GET/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

The inbox ID or its email address, such as support@example.com

thread_idstring<uuid>erforderlich

The thread ID

email_idstring<uuid>erforderlich

The email ID

Query-Parameter
include_quarantinedboolean

BillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)

Antworten
200

Email

Mindestens eines von:
object
idstring<uuid>erforderlich
fromstringerforderlich
tostring[]erforderlich
ccstring[]erforderlich
bccstring[]erforderlich
reply_tostring[]erforderlich
subjectstring | nullerforderlich
message_idstring | nullerforderlich
htmlstring | nullerforderlich
textstring | nullerforderlich
attachmentsobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstringerforderlich
filenamestring | nullerforderlich
sizeinteger | nullerforderlich
readbooleanerforderlich
received_atstringerforderlich
directionstringerforderlich
Erlaubt:inbound
extracted_textstring | nullerforderlich

BillionSend extension: hidden text, quotes and signature removed

screeningobjecterforderlich
Eigenschaften anzeigen
verdictstringerforderlich
Erlaubt:pendingcleansuspiciousquarantinedreleased
sender_truststringerforderlich
Erlaubt:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullerforderlich
Erlaubt:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]erforderlich
injection_scoreinteger | nullerforderlich
phishing_scoreinteger | nullerforderlich
hidden_text_removedbooleanerforderlich
spam_verdictstring | nullerforderlich
Erlaubt:passgrayfailnull
virus_verdictstring | nullerforderlich
Erlaubt:passfailprocessing_failednull
object
idstring<uuid>erforderlich
fromstringerforderlich
tostring[]erforderlich
ccstring[]erforderlich
bccstring[]erforderlich
reply_tostring[]erforderlich
subjectstring | nullerforderlich
message_idstring | nullerforderlich
htmlstring | nullerforderlich
textstring | nullerforderlich
attachmentsobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstringerforderlich
filenamestring | nullerforderlich
sizeinteger | nullerforderlich
readbooleanerforderlich
received_atstringerforderlich
directionstringerforderlich
Erlaubt:outbound
statusstringerforderlich

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Quarantined, or include_quarantined from an inbox-scoped key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "from": "string",
  "to": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "reply_to": [
    "string"
  ],
  "subject": "string",
  "message_id": "string",
  "html": "string",
  "text": "string",
  "attachments": [
    {
      "id": "string",
      "filename": "string",
      "size": 0
    }
  ],
  "read": true,
  "received_at": "string",
  "direction": "inbound",
  "extracted_text": "string",
  "screening": {
    "verdict": "pending",
    "sender_trust": "owner",
    "quarantine_reason": "failed_auth",
    "reasons": [
      "string"
    ],
    "injection_score": 0,
    "phishing_score": 0,
    "hidden_text_removed": true
  },
  "spam_verdict": "pass",
  "virus_verdict": "pass"
}

War diese Seite hilfreich?