במאמר הזה מוסבר איך לקרוא לשיטה messages.list של Gmail API.
השיטה מחזירה מערך של אובייקטים של Gmail messages שמכילים את ההודעה id ואת threadId. כדי לאחזר את הפרטים המלאים של ההודעה, משתמשים בשיטה messages.get.
אובייקטים messages שמוחזרים מופיעים בסדר כרונולוגי הפוך (מהחדש לישן).
דרישות מוקדמות
Python
פרויקט ב-Google Cloud שבו מופעל Gmail API. הוראות מפורטות זמינות במאמר בנושא Gmail API Python quickstart.
הצגת הודעות ברשימה
השיטה messages.list תומכת בכמה פרמטרים של שאילתות לסינון ההודעות:
-
maxResults: המספר המקסימלי של ההודעות שיוחזרו (ברירת המחדל היא 100, המקסימום הוא 500). -
pageToken: אסימון לאחזור דף ספציפי של תוצאות. -
q: מחרוזת שאילתה לסינון הודעות, כמוfrom:someuser@example.com is:unread. -
labelIds: מחזירה רק הודעות עם תוויות שתואמות לכל מזהי התוויות שצוינו. -
includeSpamTrash: כולל בתוצאות הודעות מSPAMומTRASH.
דוגמת קוד
Python
בדוגמת הקוד הבאה אפשר לראות איך לרשום הודעות של משתמש Gmail מאומת. הקוד מטפל בהחלפה בין דפים כדי לאחזר את כל ההודעות שתואמות לשאילתה.
השיטה messages.list מחזירה גוף תגובה שמכיל את הפרטים הבאים:
-
messages[]: מערך של משאביMessage. -
nextPageToken: אסימון שאפשר להשתמש בו בקריאות הבאות כדי להציג עוד הודעות, בבקשות עם כמה דפים של תוצאות. -
resultSizeEstimate: אומדן של המספר הכולל של התוצאות.
כדי לאחזר את התוכן המלא של ההודעה ואת המטא-נתונים שלה, משתמשים בשדה message.id כדי לקרוא לשיטה messages.get.