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

在搜尋結果中包含來自 SPAMTRASH 的訊息。

要求主體

要求主體必須為空白。

回應主體

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

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

object (Message)

訊息清單。請注意,每個訊息資源只包含 idthreadId。您可以使用 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

詳情請參閱授權指南