TaskPilots Mailbox Integration Documentation main http-api/reference.md

title: Mailbox HTTP API 参考

Mailbox HTTP API 参考

这页汇总公开 HTTP API 的主要请求与响应字段。

默认情况下,下面列出的“响应字段”都位于统一返回包的 data 内,即响应体形如:

{
  "data": {},
  "code": 200,
  "msg": null,
  "errMsg": null,
  "tid": "trace-id"
}

创建邮箱

POST /api/mailboxes

请求体:

  • address:邮箱地址,可直接指定完整地址
  • displayName:显示名称
  • domainId:可选
  • localPart:可选
  • notes:可选

data 内重点字段:

  • mailbox.mailboxId
  • mailbox.address
  • mailbox.displayName
  • initialAccessToken
  • initialAccessTokenId
  • initialAccessTokenExpiresAtTs

消息列表

GET /api/messages

查询参数:

  • mailboxAddressdomain token 场景通常必填
  • limit:可选,默认 100,最大 200
  • cursor:可选,传入上一页返回的 nextCursor
  • direction:可选,仅支持 inboundoutbound

响应字段:

  • items
  • nextCursor
  • totalCount

items 内常见字段:

  • messageId
  • receiptId
  • threadId
  • mailboxId
  • direction
  • subject
  • fromAddress
  • fromDisplayName
  • toAddress
  • mailboxAddress
  • attachmentCount
  • createdAtTs
  • receivedAtTs
  • sentAtTs

兼容说明:

  • GET /api/messages 已从旧数组响应升级为分页对象响应
  • 旧解析逻辑必须改为读取 items
  • nextCursor=null 表示当前没有下一页

消息详情

`GET /api/messages/

在消息摘要字段基础上,还常见:

  • bodyText
  • bodyHtml
  • bodyFormat
  • rawContentPath
  • inReplyToMessageId
  • attachments

更新消息读状态

`PUT /api/messages/

请求体:

  • isRead

data 内重点字段:

  • messageId
  • isRead
  • readAtTs

批量更新消息读状态

POST /api/messages/bulk-read-state

请求体:

  • ids
  • isRead

data 内重点字段:

  • requestedCount
  • succeededItems
  • failedItems

删除单封消息

`DELETE /api/messages/

data 内重点字段:

  • messageId
  • deletedAtTs
  • alreadyDeleted

批量删除消息

POST /api/messages/bulk-delete

请求体:

  • ids

data 内重点字段:

  • requestedCount
  • succeededItems
  • failedItems

线程详情

`GET /api/threads/

响应字段:

  • threadId
  • mailboxId
  • subject
  • createdAtTs
  • messages

发起新邮件

POST /api/messages/send

请求体:

  • mailboxAddress
  • toAddress
  • subject
  • bodyText
  • ccAddresses
  • bccAddresses
  • attachmentIds

返回:

  • 202 Accepted

回复邮件

`POST /api/messages/

请求体:

  • mailboxAddress
  • subject
  • bodyText
  • ccAddresses
  • bccAddresses
  • attachmentIds

返回:

  • 202 Accepted

上传附件

POST /api/messages/attachments

表单字段:

  • mailboxAddress
  • file

返回重点字段:

  • attachmentUploadId

Token 自助治理

GET /api/mailbox/access-tokens

返回列表字段常见包含:

  • tokenId
  • tokenName
  • tokenPrefix
  • scopes
  • createdSource
  • expiresAtTs
  • disabledAtTs
  • lastUsedAtTs
  • lastUsedRemoteIp
  • canRevealPlaintext
  • createdAtTs

POST /api/mailbox/access-tokens

请求体:

  • tokenName
  • scopes
  • expiresAtTs

响应字段:

  • tokenId
  • tokenName
  • tokenPrefix
  • scopes
  • createdSource
  • accessToken
  • expiresAtTs
  • createdAtTs