Method: users.threads.list

列出用户邮箱中的会话。

HTTP 请求

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

网址采用 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 表示法 
{
  "threads": [
    {
      object (Thread)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
字段
threads[]

object (Thread)

线程列表。请注意，每个线程资源都不包含 messages 列表。您可以使用 threads.get 方法提取给定线程的 messages 列表。
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

如需了解详情，请参阅授权指南。