Method: users.drafts.list

列出使用者信箱中的草稿。

HTTP 要求

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

這個網址使用 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"。
includeSpamTrash

boolean

在結果中包含 SPAM 和 TRASH 的草稿。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
欄位
drafts[]

object (Draft)

草稿清單。請注意，每個 Draft 資源中的 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

詳情請參閱授權指南。