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

詳情請參閱授權指南。