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)

حداکثر تعداد پیش‌نویس‌هایی که باید برگردانده شوند. این فیلد به صورت پیش‌فرض ۱۰۰ است. حداکثر مقدار مجاز برای این فیلد ۵۰۰ است.

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

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .