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

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