列出使用者信箱中的郵件。
HTTP 要求
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
userId |
使用者的電子郵件地址。特殊值 |
查詢參數
參數 | |
---|---|
maxResults |
傳回的訊息數量上限。這個欄位的預設值為 100。這個欄位允許的值上限為 500。 |
pageToken |
用於擷取清單中特定結果頁面的網頁符記。 |
q |
只傳回符合指定查詢的訊息。支援與 Gmail 搜尋框相同的查詢格式。例如: |
labelIds[] |
只傳回符合所有指定標籤 ID 的郵件。討論串中的郵件可能會有標籤,但同一個討論串中的其他郵件可能沒有這些標籤。詳情請參閱管理郵件和討論串標籤。 |
includeSpamTrash |
在結果中包含來自 |
要求主體
要求主體必須為空白。
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"messages": [
{
object ( |
欄位 | |
---|---|
messages[] |
訊息清單。請注意,每個訊息資源都只包含 |
nextPageToken |
用於擷取清單中結果下一頁的符記。 |
resultSizeEstimate |
預估的結果總數。 |
授權範圍
需要下列其中一種 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
詳情請參閱授權指南。