Method: users.messages.list

רשימת ההודעות בתיבת הדואר של המשתמש. לדוגמה לשימוש, אפשר לעיין במאמר בנושא הצגת רשימה של הודעות Gmail.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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. אפשר לאחזר פרטים נוספים על ההודעה באמצעות method‏ 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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.