Method: users.messages.list

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

طلب 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

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