Method: users.messages.list

列出用户邮箱中的邮件。

HTTP 请求

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages

网址采用 gRPC 转码语法。

路径参数

参数
userId

string

用户的电子邮件地址。特殊值 me 可用于指示通过身份验证的用户。

查询参数

参数
maxResults

integer (uint32 format)

要返回的消息数量上限。此字段默认为 100。此字段允许的最大值为 500。
pageToken

string

用于检索列表中特定结果页的页面令牌。
q

string

仅返回与指定查询匹配的消息。支持与 Gmail 搜索框相同的查询格式。例如，"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"。使用 gmail.metadata 范围访问 API 时，不能使用参数。
labelIds[]

string

仅返回标签与所有指定标签 ID 匹配的邮件。同一会话中的其他邮件可能没有标签。有关详情，请参阅管理邮件和会话的标签。
includeSpamTrash

boolean

在结果中包含来自 SPAM 和 TRASH 的邮件。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
字段
messages[]

object (Message)

消息列表。请注意，每个消息资源仅包含一个 id 和一个 threadId。可使用 messages.get 方法获取其他消息详情。
nextPageToken

string

用于检索列表中下一页结果的令牌。
resultSizeEstimate

integer (uint32 format)

估算的结果总数。

授权范围

需要以下 OAuth 范围之一：

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.metadata

有关详情，请参阅授权指南。