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

لمزيد من المعلومات، يُرجى الاطّلاع على OAuth 2.0 Overview.