列出邮件

列出邮件

Tip: 使用应用权限访问时，需要申请邮件数据资源的数据权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/messages
HTTP Method	GET
接口频率限制	10 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:user_mailbox.message:readonly 查询用户邮件

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址。当使用用户身份访问时，可以输入"me"代表当前调用接口用户 示例值："user@xxx.xx 或 me"

查询参数

名称	类型	必填	描述
page_size	int	是	分页大小 示例值：1 数据校验规则： - 取值范围：1 ～ 20
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：xxx
folder_id	string	否	文件夹 id， 获取方式见 列出邮箱文件夹 示例值：INBOX 或者用户文件夹 id
only_unread	boolean	否	是否只查询未读邮件 示例值：true
label_id	string	否	标签id，支持IMPORTANT、OTHER、FLAGGED、SCHEDULED以及自定义文件夹标签 示例值：FLAGGED

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	string\[\]	邮件 id 列表
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            "ZWEyNGRmY2QtOTVlNy00NzlhLTg5MjItMjFjOTQ5ZjIzZjJl"
        ],
        "page_token": "xxx",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	invalid param	修改参数后重试
403	1230002	no permission	无权限访问，请确认应用是否具备访问该资源的权限。如使用用户身份访问，请确认具备此用户的访问权限；如使用租户身份访问，请确认已申请对应的数据范围权限。
500	1230003	internal error	请稍后重试