يوضّح هذا المستند كيفية استدعاء طريقة
messages.list
في Gmail API.
تعرض الطريقة مصفوفة من عناصر messages في Gmail تتضمّن id وthreadId للرسالة. لاسترداد التفاصيل الكاملة للرسالة، استخدم
الطريقة messages.get.
تظهر عناصر messages التي يتم عرضها بترتيب زمني عكسي (الأحدث أولاً).
المتطلبات الأساسية
Python
يجب أن يكون لديك مشروع على Google Cloud مفعَّلة فيه واجهة برمجة التطبيقات Gmail API. للاطّلاع على الخطوات، أكمل التشغيل السريع لواجهة برمجة التطبيقات Gmail API في Python.
عرض قائمة بالرسائل
تتوافق طريقة messages.list مع عدة مَعلمات طلب بحث لفلترة الرسائل:
maxResults: الحد الأقصى لعدد الرسائل المطلوب عرضها (القيمة التلقائية هي 100، والحد الأقصى هو 500).pageToken: الرمز المميّز لاسترداد صفحة معيّنة من النتائج.q: سلسلة طلب البحث لفلترة الرسائل، مثلfrom:someuser@example.com is:unread.labelIds: عرض الرسائل التي تتضمّن تصنيفات تطابق جميع معرّفات التصنيفات المحدّدة فقط.includeSpamTrash: تضمين الرسائل منSPAMوTRASHفي النتائج.
عيّنة تعليمات برمجية
Python
تعرض عيّنة التعليمات البرمجية التالية كيفية عرض قائمة بالرسائل لمستخدم Gmail الذي تم التحقّق من هويته. تتعامل التعليمات البرمجية مع تقسيم النتائج على صفحات لاسترداد جميع الرسائل التي تطابق طلب البحث.
تعرض طريقة messages.list نص استجابة يتضمّن ما يلي:
messages[]: مصفوفة من مصادرMessage.nextPageToken: للطلبات التي تتضمّن صفحات متعددة من النتائج، يكون هذا الرمز المميّز قابلاً للاستخدام مع عمليات الاستدعاء اللاحقة لعرض المزيد من الرسائل.resultSizeEstimate: العدد الإجمالي المقدّر للنتائج.
لجلب محتوى الرسالة والبيانات الوصفية الكاملة، استخدِم الحقل message.id لـ
استدعاء الـ
messages.get
طريقة.