Method: users.drafts.list

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

בקשת HTTP

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

בכתובת ה-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".
includeSpamTrash

boolean

יש לכלול בתוצאות טיוטות של SPAM ושל TRASH.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "drafts": [
    {
      object (Draft)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
שדות
drafts[]

object (Draft)

רשימת הטיוטות. לתשומת ליבך, המאפיין Message בכל משאב Draft מכיל רק 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.compose
  • https://www.googleapis.com/auth/gmail.readonly

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