Method: users.messages.list

הצגת רשימת ההודעות בתיבת הדואר של המשתמש.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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