资源工坊

获取特定目录下的邮件列表 ​

标签：邮件

请求说明 ​

字段值
请求地址
https://openapi.wps.cn/v7/mailboxes/{mailbox_id}/folders/{folder_id}/messages
HTTP 方法
GET
接口描述
取已登录用户的，特定邮箱中的邮件列表。目前仅支持用户登录后，访问自己的邮箱数据。
签名方式
KSO-1
限频策略
无
权限要求
查询和管理邮件(用户授权) kso.mail.readwrite
查询邮件(用户授权) kso.mail.read

路径参数 (Path) ​

属性名类型是否必填描述可选值
mailbox_id
string是-
folder_id
string是-

查询参数 (Query) ​

属性名类型是否必填描述可选值
start_time
integer否邮件的起始时间戳（单位秒），默认为1-
end_time
integer否邮件的结束时间戳（单位秒），须大于start_time。默认无穷大-
filter
array否邮件筛选条件，默认为allunread, flagged
page_size
integer是分页大小，默认取5-
page_token
string否翻页token，首次无需提供-
thread_id
string否会话id-

响应体(Response) ​

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例 ​

json
{
  "data": {
    "items": [
      {
        "bcc_recipient": [
          {
            "avatar": "string",
            "email_address": "string",
            "name": "string"
          }
        ],
        "body_preview": "string",
        "cc_recipient": [
          {
            "avatar": "string",
            "email_address": "string",
            "name": "string"
          }
        ],
        "ctime": 0,
        "folder_id": "string",
        "from": {
          "avatar": "string",
          "email_address": "string",
          "name": "string"
        },
        "has_attachments": true,
        "importance_flag": [
          0
        ],
        "is_draft": true,
        "is_flag": true,
        "is_read": true,
        "mailbox_id": "string",
        "message_id": "string",
        "priority": 0,
        "sender": "string",
        "subject": "string",
        "thread_id": "string",
        "to_recipient": [
          {
            "avatar": "string",
            "email_address": "string",
            "name": "string"
          }
        ]
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "msg": "string"
}