Method: users.messages.list

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

طلب HTTP

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

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

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