搜索邮件【高级搜索】

标签：邮件

请求说明

字段	值
请求地址	https://openapi.wps.cn/v7/mail_messages/search
HTTP 方法	GET
接口描述	取已登录用户的，符合特定条件（支持：发件人、收件人、主题、邮件体）的邮件列表，按发信日期从新到老。目前仅支持用户登录后，访问自己的邮箱数据。支持多个邮箱账号数据搜索
签名方式	KSO-1
限频策略	无
权限要求	查询和管理邮件(用户授权) kso.mail.readwrite 查询邮件(用户授权) kso.mail.read

查询参数 (Query)

属性名	类型	是否必填	描述	可选值
mailbox_ids	string	是	多个邮箱账号的id集合,多个账号用,号分割	-
start_time	integer	否	邮件的起始时间戳（单位秒），默认为1	-
end_time	integer	否	邮件的结束时间戳（单位秒），须大于start_time。默认无穷大	-
folders	string	否	目录ID列表，限制搜索目录范围。默认搜索所有目录，多个目录用英文逗号,分割	-
exclude_folder_names	string	否	不进行搜索的目录名称列表，当前仅支持指定系统目录[Sent/Drafts]。多个用英文逗号,分割	-
filter	array	否	邮件筛选条件，默认为all。多个用英文逗号,分割	unread, flagged
has_attachment	boolean	否	true筛选包含附件，false筛选不包含附件。默认不筛选	-
category_id	string	否	标签ID，限制搜索标签范围。默认搜索所有标签	-
from	string	否	发件人搜索,支持邮箱地址、用户名搜索，默认不筛选，多个使用空格分割	-
to	string	否	收件人搜索，支持邮箱地址、用户名搜索，默认不筛选，这里包含收件人，抄送，密送人搜索，多个使用空格分割	-
subject	string	否	邮件主题搜索，默认不搜索	-
body	string	否	邮件正文搜索，支持模糊搜索，默认不搜索	-
attachment	string	否	邮件附件名称搜索,支持模糊搜索，默认不搜索	-
keyword	string	否	关键字搜索,支持模糊搜索	-
page_size	integer	否	分页大小，默认取5	-
page_token	string	否	翻页token，首次无需提供	-
priority	string	否	优先级字段，空-所有 0-普通 1-高 5-低	-

响应体(Response)

HTTP状态码: 200
响应体格式: application/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"
}