במאמר הזה מוסבר איך לקרוא לשיטה messages.list של Gmail API.
השיטה מחזירה מערך של אובייקטים של Gmail messages שמכילים את ההודעה id ואת threadId. כדי לאחזר את הפרטים המלאים של ההודעה, משתמשים בשיטה messages.get.
דרישות מוקדמות
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.