Method: users.drafts.list

پیش نویس های موجود در صندوق پستی کاربر را فهرست می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.