Method: users.messages.list

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

طلب HTTP

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

يستخدم عنوان 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" لا يمكن استخدام المعلّمة عند الوصول إلى واجهة برمجة التطبيقات باستخدام نطاق gmail.metadata.

labelIds[]

string

لا تعرض سوى الرسائل التي تتضمن تصنيفات تتطابق مع جميع أرقام تعريف التصنيفات المحدّدة. قد تحتوي الرسائل في سلسلة محادثات على تصنيفات لا تحتوي عليها الرسائل الأخرى في سلسلة المحادثات نفسها. لمزيد من المعلومات، يُرجى الاطّلاع على إدارة التصنيفات على الرسائل وسلاسل المحادثات.

includeSpamTrash

boolean

تضمين رسائل من SPAM وTRASH في النتائج.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string,
  "resultSizeEstimate": integer
}
الحقول
messages[]

object (Message)

قائمة الرسائل يُرجى العِلم أنّ كل مورد للرسائل يحتوي على 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.readonly
  • https://www.googleapis.com/auth/gmail.metadata

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