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

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