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

List received emails

Mail received at the team’s receiving domains and inboxes, newest first (after pages toward older mail), with cursor pagination. Needs a full access key; a domain-scoped key lists mail addressed to its domain only, an inbox-scoped key mail delivered into its inbox. Mail held for screening or in quarantine is left out unless a full access key asks for it (include_quarantined, quarantined). With wait, the request is held until matching mail arrives (long-poll). An inbox_id the key can’t reach answers 404 at once, without waiting; an inbox-scoped key naming another inbox gets 403 restricted_api_key. 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
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Query-Parameter
limitinteger

Page size, 1-100 (default 20)

min. 1 · max. 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

waitinteger

BillionSend extension: hold the request up to this many seconds (0-50) until matching mail newer than the cursor arrives; an empty list with 200 when none did

sincestring<date-time>

BillionSend extension: only mail received after this instant; with wait and no cursor it defaults to one minute before the request

inbox_idstring<uuid>

BillionSend extension: only mail delivered into this inbox

tostring

BillionSend extension: only mail with this address in received_for

max. Länge 320
fromstring

BillionSend extension: a sender address, or a domain matching itself and its subdomains

max. Länge 320
subject_containsstring

BillionSend extension: case-insensitive subject substring

max. Länge 200
unreadstring

BillionSend extension, with an inbox in context (inbox_id, or an inbox-scoped key): read state in that inbox

Erlaubt:truefalse
include_quarantinedstring

BillionSend extension, full access keys only: list held mail too, flagged by screening

Erlaubt:truefalse
quarantinedstring

BillionSend extension, full access keys only: list held mail only

Erlaubt:truefalse
Antworten
200

Received emails

objectstringerforderlich
Erlaubt:list
has_morebooleanerforderlich
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
tostring[]erforderlich
fromstringerforderlich

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

created_atstringerforderlich
subjectstringerforderlich
bccstring[]erforderlich
ccstring[]erforderlich
reply_tostring[]erforderlich
received_forstring[]erforderlich

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

message_idstringerforderlich
attachmentsobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
filenamestring | nullerforderlich
content_typestringerforderlich
content_idstring | nullerforderlich
content_dispositionstring | nullerforderlich
sizeintegererforderlich
inbox_idstring<uuid> | nullerforderlich

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

BillionSend extension: that inbox's thread

inboxesobject[]

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

Eigenschaften anzeigen
Array von object
inbox_idstring<uuid>erforderlich
thread_idstring<uuid>erforderlich
verdictstringerforderlich
Erlaubt:pendingcleansuspiciousquarantinedreleased
spam_verdictstring | nullerforderlich

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

Erlaubt:passgrayfailnull
virus_verdictstring | nullerforderlich

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

Erlaubt:passfailprocessing_failednull
readboolean

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

screeningobjecterforderlich

BillionSend extension: the screening verdict and the sender's trust tier

Eigenschaften anzeigen
verdictstringerforderlich
Erlaubt:pendingcleansuspiciousquarantinedreleased
sender_truststringerforderlich
Erlaubt:ownerallowlistedknown_threadexternalunauthenticatedfailed
extractedobjecterforderlich

BillionSend extension: whether a verification code or sign-in link was found; the values come with GET of one email

Eigenschaften anzeigen
kindsstring[]erforderlich
heldobject[]

BillionSend extension, with wait only: matching mail that arrived but is held (being screened or quarantined), ids and why only

Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
inbox_idstring<uuid> | nullerforderlich
reasonstringerforderlich
Erlaubt:pendingquarantined
quarantine_reasonstring | nullerforderlich
Erlaubt:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
created_atstringerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Restricted API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Inbox not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

Too many concurrent waits, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/emails/receiving' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "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"
      },
      "extracted": {
        "kinds": [
          "code"
        ]
      }
    }
  ],
  "held": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
      "reason": "pending",
      "quarantine_reason": "failed_auth",
      "created_at": "string"
    }
  ]
}

War diese Seite hilfreich?