يسرد الرسائل في صندوق بريد المستخدم.
طلب 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
لمزيد من المعلومات، راجِع دليل التفويض.