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

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

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

thread_idstring<uuid>obligatorio

The thread ID

email_idstring<uuid>obligatorio

The email ID

Parámetros de consulta
include_quarantinedboolean

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

Respuestas
200

Email

Al menos uno de:
object
idstring<uuid>obligatorio
fromstringobligatorio
tostring[]obligatorio
ccstring[]obligatorio
bccstring[]obligatorio
reply_tostring[]obligatorio
subjectstring | nullobligatorio
message_idstring | nullobligatorio
htmlstring | nullobligatorio
textstring | nullobligatorio
attachmentsobject[]obligatorio
Mostrar propiedades
Array de object
idstringobligatorio
filenamestring | nullobligatorio
sizeinteger | nullobligatorio
readbooleanobligatorio
received_atstringobligatorio
directionstringobligatorio
Valores permitidos:inbound
extracted_textstring | nullobligatorio

BillionSend extension: hidden text, quotes and signature removed

screeningobjectobligatorio
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_verdictstring | nullobligatorio
Valores permitidos:passgrayfailnull
virus_verdictstring | nullobligatorio
Valores permitidos:passfailprocessing_failednull
object
idstring<uuid>obligatorio
fromstringobligatorio
tostring[]obligatorio
ccstring[]obligatorio
bccstring[]obligatorio
reply_tostring[]obligatorio
subjectstring | nullobligatorio
message_idstring | nullobligatorio
htmlstring | nullobligatorio
textstring | nullobligatorio
attachmentsobject[]obligatorio
Mostrar propiedades
Array de object
idstringobligatorio
filenamestring | nullobligatorio
sizeinteger | nullobligatorio
readbooleanobligatorio
received_atstringobligatorio
directionstringobligatorio
Valores permitidos:outbound
statusstringobligatorio

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Quarantined, or include_quarantined from an inbox-scoped key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

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/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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"
}

¿Te ha resultado útil esta página?