跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

查询参数
limitinteger

Page size, 1-100 (default 20)

最小值 1 · 最大值 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

最大长度 320
fromstring

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

最大长度 320
subject_containsstring

BillionSend extension: case-insensitive subject substring

最大长度 200
unreadstring

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

允许值:truefalse
include_quarantinedstring

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

允许值:truefalse
quarantinedstring

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

允许值:truefalse
响应
200

Received emails

objectstring必填
允许值:list
has_moreboolean必填
dataobject[]必填
显示属性
object 数组
idstring<uuid>必填
tostring[]必填
fromstring必填

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

created_atstring必填
subjectstring必填
bccstring[]必填
ccstring[]必填
reply_tostring[]必填
received_forstring[]必填

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

message_idstring必填
attachmentsobject[]必填
显示属性
object 数组
idstring<uuid>必填
filenamestring | null必填
content_typestring必填
content_idstring | null必填
content_dispositionstring | null必填
sizeinteger必填
inbox_idstring<uuid> | null必填

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> | null必填

BillionSend extension: that inbox's thread

inboxesobject[]

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

显示属性
object 数组
inbox_idstring<uuid>必填
thread_idstring<uuid>必填
verdictstring必填
允许值:pendingcleansuspiciousquarantinedreleased
spam_verdictstring | null必填

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

允许值:passgrayfailnull
virus_verdictstring | null必填

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

允许值:passfailprocessing_failednull
readboolean

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

screeningobject必填

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

显示属性
verdictstring必填
允许值:pendingcleansuspiciousquarantinedreleased
sender_truststring必填
允许值:ownerallowlistedknown_threadexternalunauthenticatedfailed
extractedobject必填

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

显示属性
kindsstring[]必填
heldobject[]

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

显示属性
object 数组
idstring<uuid>必填
inbox_idstring<uuid> | null必填
reasonstring必填
允许值:pendingquarantined
quarantine_reasonstring | null必填
允许值:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
created_atstring必填
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

Restricted API key

statusCodenumber必填
namestring必填
messagestring必填
404

Inbox not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/emails/receiving' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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"
    }
  ]
}

这个页面有帮助吗?