Method: users.messages.list

בתיבת הדואר הנכנס של המשתמש.

בקשת HTTP

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

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של 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". לא ניתן להשתמש בפרמטר כשניגשים לממשק ה-API באמצעות ההיקף gmail.metadata.
labelIds[]

string

מוחזרות רק הודעות עם תוויות שתואמות לכל מזהי התוויות שצוינו. יכול להיות שלהודעות בשרשור יהיו תוויות שאין להודעות אחרות באותו שרשור. מידע נוסף מופיע במאמר ניהול תוויות בהודעות ובשרשורים.
includeSpamTrash

boolean

תוצאות שכוללות הודעות מאת SPAM ומ-TRASH.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
שדות
messages[]

object (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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

מידע נוסף זמין במדריך להרשאות.