Method: users.drafts.list

يتم إدراج المسودات في صندوق بريد المستخدم.

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المعلّمات
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

لمزيد من المعلومات، اطّلِع على دليل التفويض.