搜索邮件
POST/v2/users/:email/messages/query
根据查询语句搜索指定用户邮箱中的邮件。默认仅返回基本信息;可使用 $select 指定扩展字段,例如 $select=internetMessageId,toRecipients。
搜索结果不支持通过 $select 返回 body、internetMessageHeaders、replyTo 和 isReadReceiptRequested。如需这些字段,请调用获取单封邮件接口。
查询语法
查询语法参考 KQL。字符串值可以使用双引号包裹;双引号内出现的 " 需要写成两个连续双引号。不使用双引号时,值中不能包含空白字符、双引号或括号。
示例:
date>2025-01-01T00:00:00Z AND (NOT folderId:3) AND (NOT folderId:6)
(from:"alice") OR (to:"alice<a@b.com>" AND folderId:1 AND toEmail="a@b.com")
(subject:"test") OR (attachname:"""quoteString""" AND from:alice<a@b.com>)
支持的字段
- 通用字段:
date、size、tag、folderId、isRead、hasAttachments、subject、attachname和body。 - 发件人和收件人字段:
from、fromEmail、to和toEmail。 isRead与hasAttachments支持1、0、true和false。from、to支持alias<address@example.com>格式;fromEmail、toEmail使用纯邮箱地址。
操作符
- 字段操作符:
:(包含)、=(等于)、>(大于)、>=(大于等于)、<(小于)和<(小于等于)。 - 逻辑操作符:
AND、OR和NOT。 - 运算优先级:
NOT>AND>OR。
Request
Path parameters
用户邮箱地址
Query parameters
请求体参数
查询语句
邮件的起始偏移标识, 其值取自响应中的nextCursor字段。“”表示从头开始
返回邮件数量,最大100
响应
- PRY_HIGH:
- PRY_NORMAL:
- none:
- posting:
- partial_success:
- success:
- failed:
- unknown:
messages object[]
邮件列表
由RFC2822指定格式的邮件消息Id(可选字段:在URL中增加$select=internetMessageId查询参数后返回,如需多个字段使用英文逗号分隔)
邮件主题
邮件摘要信息
邮件的重要性, 值可以是 HIGH、NORMAL、LOW,默认为NORMAL
Possible values: [PRY_HIGH, PRY_NORMAL]
from object
发送邮件邮箱的所有者,在多数情况中,此数值与“sender”属性相同
人员或实体的电子邮件地址
人员或实体的显示名称
toRecipients object[]
邮件的收件人(可选字段:在URL中增加$select=toRecipients查询参数后返回,如需多个字段使用英文逗号分隔)
人员或实体的电子邮件地址
人员或实体的显示名称
ccRecipients object[]
邮件的抄送收件人(可选字段:在URL中增加$select=ccRecipients查询参数后返回,如需多个字段使用英文逗号分隔)
人员或实体的电子邮件地址
人员或实体的显示名称
bccRecipients object[]
邮件的密送收件人(可选字段:在URL中增加$select=bccRecipients查询参数后返回,如需多个字段使用英文逗号分隔)
人员或实体的电子邮件地址
人员或 实体的显示名称
sender object
实际用于生成邮件的帐户,大多数情况下,此值与“from”属性相同,在任何情况下,此值必须对应于使用的实际邮箱(可选字段:在URL中增加$select=sender查询参数后返回,如需多个字段使用英文逗号分隔)
人员或实体的电子邮件地址
人员或实体的显示名称
internetMessageHeaders object
由RFC5322定义的邮件头集合
由RFC5322定义的邮件头集合
邮件所属文件夹唯一标识
邮件唯一标识
指明邮件是否含有附件(不包括inline资源)
指明邮件是否已读
邮件所属会话唯一标识
邮件发送时间
邮件最后修改时间(可选字段:在URL中增加$select=lastModifiedDateTime查询参数后返回,如需多个字段使用英文逗号分隔)
收件人接收该邮件的时间(可选字段:在URL中增加$select=receivedDateTime查询参数后返回,如需多个字段使用英文逗号分隔)
邮件标签列表(可选字段:在URL中增加$select=tags查询参数后返回,如需多个字段使用英文逗号分隔)
指明邮件是否已回复
指明邮件是否已转发
邮件发送状态(可选字段:在URL中增加$select=sendStatus查询参数后返回,如需多个字段使用英文逗号分隔)
Possible values: [none, posting, partial_success, success, failed, unknown]
邮件大小(字节)
总邮件数
下一页光标 $表示已经到达邮件列表尾部
错误
401 | 访问未授权,请检查是否传递了正确的授权token |
403 | 无API访问权限,请在域管的应用管理页面完成相关授权 |
412 |