يعرض الرسائل في صندوق بريد المستخدم.
طلب HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/messages
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
userId |
عنوان البريد الإلكتروني للمستخدِم. يمكن استخدام القيمة الخاصة |
معامِلات طلب البحث
المعلمات | |
---|---|
maxResults |
الحد الأقصى لعدد الرسائل المطلوب عرضها. القيمة التلقائية لهذا الحقل هي 100. إنّ الحدّ الأقصى المسموح به لقيمة هذا الحقل هو 500. |
pageToken |
رمز الصفحة المميّز لاسترداد صفحة معيّنة من النتائج في القائمة. |
q |
إرجاع الرسائل المطابقة لطلب البحث المحدد فقط. استخدام نفس تنسيق طلب البحث الذي يستخدمه مربّع بحث Gmail. مثلاً: |
labelIds[] |
إرجاع الرسائل ذات التصنيفات التي تطابق جميع معرّفات التصنيفات المحددة فقط. قد تحتوي الرسائل في سلسلة المحادثات على تصنيفات لا تتضمّنها الرسائل الأخرى في سلسلة المحادثات نفسها. لمزيد من المعلومات، راجِع إدارة التصنيفات في الرسائل وسلاسل المحادثات. |
includeSpamTrash |
تضمين رسائل من |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"messages": [
{
object ( |
الحقول | |
---|---|
messages[] |
قائمة الرسائل يُرجى العلم أنّ كل مورد رسائل يحتوي على |
nextPageToken |
رمز مميز لاسترداد الصفحة التالية من النتائج في القائمة. |
resultSizeEstimate |
العدد الإجمالي المقدَّر للنتائج. |
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات 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
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.