Method: users.drafts.list

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

בקשת HTTP

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

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

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