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

لمزيد من المعلومات، راجِع دليل التفويض.