Gmail API

تتيح لك واجهة برمجة التطبيقات Gmail API عرض بيانات صندوق بريد Gmail وإدارتها، مثل سلاسل المحادثات والرسائل والتصنيفات.

الخدمة: gmail.googleapis.com

للاتصال بهذه الخدمة، ننصحك باستخدام مكتبات العملاء التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لاستدعاء هذه الخدمة، فاستخدم المعلومات التالية عند تقديم طلبات واجهة برمجة التطبيقات.

مستند "اقتراحات"

مستند الاستكشاف هو مواصفات يمكن للآلة قراءتها لوصف واجهات برمجة تطبيقات REST واستخدامها. ويتم استخدامه لإنشاء مكتبات للعملاء ومكوّنات IDE وأدوات أخرى تتفاعل مع Google APIs. قد توفّر خدمة واحدة مستندات اكتشاف متعددة. توفّر هذه الخدمة مستند الاستكشاف التالي:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي عنوان URL أساسي يحدد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد تتضمن خدمة واحدة نقاط نهاية متعددة للخدمة. تحتوي هذه الخدمة على نقطة نهاية الخدمة التالية وجميع معرّفات الموارد المنتظمة (URI) التالية مرتبطة بنقطة نهاية الخدمة هذه:

  • https://gmail.googleapis.com

مورد REST: v1.users

الطُرق
getProfile GET /gmail/v1/users/{userId}/profile
للحصول على الملف الشخصي للمستخدم الحالي على Gmail.
stop POST /gmail/v1/users/{userId}/stop
يمكنك إيقاف تلقّي إشعارات فورية لصندوق البريد الإلكتروني المحدّد للمستخدم.
watch POST /gmail/v1/users/{userId}/watch
يمكنك إعداد ساعة إشعارات فورية أو تعديلها في صندوق بريد المستخدم المعنيّ.

مورد REST: v1.users.drafts

الطُرق
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
يتم إنشاء مسودة جديدة باستخدام التصنيف DRAFT.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
يؤدي هذا الإجراء إلى حذف المسودة المحدّدة فورًا وبشكل دائم.
get GET /gmail/v1/users/{userId}/drafts/{id}
يتم الحصول على المسودة المحدّدة.
list GET /gmail/v1/users/{userId}/drafts
يتم عرض المسودات في صندوق بريد المستخدم.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
لإرسال المسودة الحالية المحددة إلى المستلمين في العناوين To وCc وBcc.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
لاستبدال محتوى مسودة.

مورد REST: v1.users.history

الطُرق
list GET /gmail/v1/users/{userId}/history
تعرض هذه الإضافة سجلّ جميع التغييرات التي تم إجراؤها في صندوق البريد الإلكتروني المعنيّ.

مورد REST: v1.users.labels

الطُرق
create POST /gmail/v1/users/{userId}/labels
تُنشئ تصنيفًا جديدًا.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
يؤدي هذا الإجراء إلى حذف التصنيف المحدّد نهائيًا وبشكل فوري وإزالته من أي رسائل وسلاسل محادثات يتم تطبيقه عليها.
get GET /gmail/v1/users/{userId}/labels/{id}
الحصول على التصنيف المحدّد
list GET /gmail/v1/users/{userId}/labels
يتم إدراج جميع التصنيفات في صندوق بريد المستخدم.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
يمكنك تصحيح التصنيف المحدّد.
update PUT /gmail/v1/users/{userId}/labels/{id}
يعدِّل التصنيف المحدّد.

مورد REST: v1.users.messages

الطُرق
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
يؤدي هذا الإجراء إلى حذف العديد من الرسائل حسب رقم تعريف الرسالة.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
يُعدّل التصنيفات على الرسائل المحددة.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
يؤدي هذا الإجراء إلى حذف الرسالة المحدَّدة فورًا وبشكل دائم.
get GET /gmail/v1/users/{userId}/messages/{id}
يتلقّى الرسالة المحددة.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
لاستيراد رسالة إلى صندوق بريد هذا المستخدم فقط، مع فحص التسليم العادي للبريد الإلكتروني وتصنيفه على غرار الاستلام عبر SMTP.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
يمكنك إدراج رسالة مباشرةً في صندوق بريد هذا المستخدم فقط، على غرار IMAP APPEND، مع تجاوز معظم عمليات الفحص والتصنيف.
list GET /gmail/v1/users/{userId}/messages
يسرد الرسائل في صندوق بريد المستخدم.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
يُعدّل التصنيفات على الرسالة المحددة.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
لإرسال الرسالة المحددة إلى المستلِمين في العناوين To وCc وBcc.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
لنقل الرسالة المحددة إلى المهملات.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
لإزالة الرسالة المحددة من المهملات.

مورد REST: v1.users.messages.attachments

الطُرق
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
يتم الحصول على مرفق الرسالة المحدّد.

مورد REST: v1.users.settings

الطُرق
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
يُحصل على إعداد إعادة التوجيه التلقائي للحساب المحدد.
getImap GET /gmail/v1/users/{userId}/settings/imap
الحصول على إعدادات بروتوكول IMAP.
getLanguage GET /gmail/v1/users/{userId}/settings/language
عرض إعدادات اللغة
getPop GET /gmail/v1/users/{userId}/settings/pop
الحصول على إعدادات بروتوكول POP.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
لعرض إعدادات المجيب التلقائي.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
يعدِّل إعداد إعادة التوجيه التلقائي للحساب المحدّد.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
تعديل إعدادات بروتوكول IMAP.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
يعدّل هذا الخيار إعدادات اللغة.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
يعدّل إعدادات بروتوكول POP.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
لتعديل إعدادات المجيب التلقائي.

مورد REST: v1.users.settings.cse.identities

الطُرق
create POST /gmail/v1/users/{userId}/settings/cse/identities
لإنشاء وإعداد هوية مشفّرة من جهة العميل، يتم السماح لها بإرسال الرسائل الإلكترونية من حساب المستخدم.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
يؤدي هذا الإجراء إلى حذف هوية مشفّرة من جهة العميل.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
يسترد هذا الإعداد إعدادات الهوية في ميزة "التشفير من جهة العميل".
list GET /gmail/v1/users/{userId}/settings/cse/identities
يتم عرض الهويات المشفَّرة من جهة العميل لمستخدم تمت مصادقته.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
لربط زوج مفاتيح مختلف بهوية حالية للتشفير من جهة العميل.

مورد REST: v1.users.settings.cse.keypairs

الطُرق
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
تنشئ وتحميل سلسلة شهادات S/MIME للمفتاح العام للتشفير من جهة العميل والبيانات الوصفية للمفتاح الخاص للمستخدم الذي تمت المصادقة عليه.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
يتم إيقاف زوج مفاتيح التشفير من جهة العميل.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
يتم تفعيل مفتاحَي التشفير من جهة العميل الذي تم إيقافه.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
يتم استرداد زوج مفاتيح حالي للتشفير من جهة العميل.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
يتم عرض أزواج مفاتيح التشفير من جهة العميل للمستخدم الذي تمت مصادقته.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
يؤدي هذا الإجراء إلى حذف مفتاحَي تشفير من جهة العميل نهائيًا وعلى الفور.

مورد REST: v1.users.settings.delegates

الطُرق
create POST /gmail/v1/users/{userId}/settings/delegates
تتم إضافة المفوَّض مع ضبط حالة التحقّق مباشرةً على accepted، بدون إرسال أي رسالة تحقُّق.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
تتم إزالة المفوَّض المحدّد (الذي قد يكون من أي حالة إثبات هوية) وإبطال أي عملية تحقّق قد تكون مطلوبة لاستخدامها.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
الحصول على المفوَّض المحدّد
list GET /gmail/v1/users/{userId}/settings/delegates
تتضمّن قائمة بالمفوَّضين للحساب المحدّد.

مورد REST: v1.users.settings.filters

الطُرق
create POST /gmail/v1/users/{userId}/settings/filters
لإنشاء فلتر.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
يؤدي هذا الإجراء إلى حذف الفلتر المحدَّد نهائيًا وبشكل فوري.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
يتم إجراء فلتر.
list GET /gmail/v1/users/{userId}/settings/filters
يسرد فلاتر الرسائل لمستخدم Gmail.

مورد REST: v1.users.settings.forwardingAddresses

الطُرق
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
ينشئ عنوان إعادة التوجيه.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
يؤدي هذا الإجراء إلى حذف عنوان إعادة التوجيه المحدَّد وإلغاء أي عملية إثبات ملكية قد تكون مطلوبة.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
الحصول على عنوان إعادة التوجيه المحدّد
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
يتم إدراج عناوين إعادة التوجيه للحساب المحدّد.

مورد REST: v1.users.settings.sendAs

الطُرق
create POST /gmail/v1/users/{userId}/settings/sendAs
ينشئ هذا الإعداد حقلاً مخصّصًا للإرسال كاسم مستعار للبريد الإلكتروني "من".
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
يؤدي هذا الخيار إلى حذف الاسم المستعار المحدَّد "إرسال كـ".
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
الحصول على الاسم المستعار المحدَّد للإرسال كـ
list GET /gmail/v1/users/{userId}/settings/sendAs
يتم إدراج الأسماء المستعارة للبريد الإلكتروني التي يتم إرسالها للحساب المحدّد.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
يمكنك تصحيح الاسم المستعار المحدَّد للإرسال باسم.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
يعدّل عنوان البريد الإلكتروني البديل للبريد الإلكتروني "إرسال كـ".
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
لإرسال رسالة تحقق إلى عنوان البريد الإلكتروني البديل المحدد.

مورد REST: v1.users.settings.sendAs.smimeInfo

الطُرق
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
لحذف إعدادات S/MIME المحدّدة للاسم المستعار المحدَّد للإرسال باسم.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
الحصول على إعداد S/MIME المحدّد للاسم المستعار المحدَّد للإرسال باسم.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
يمكنك إدراج (تحميل) إعدادات S/MIME المحدّدة للاسم المستعار المحدَّد للإرسال باسم.
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
يتم إدراج إعدادات S/MIME للاسم المستعار المحدَّد للإرسال باسم.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
لضبط إعداد S/MIME التلقائي للاسم المستعار المحدَّد للإرسال باسم.

مورد REST: v1.users.threads

الطُرق
delete DELETE /gmail/v1/users/{userId}/threads/{id}
يؤدي هذا الإجراء إلى حذف سلسلة المحادثات المحدّدة فورًا وبشكل نهائي.
get GET /gmail/v1/users/{userId}/threads/{id}
يتم الحصول على سلسلة المحادثات المحدّدة.
list GET /gmail/v1/users/{userId}/threads
يتم إدراج سلاسل المحادثات في صندوق بريد المستخدم.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
لتعديل التصنيفات المطبَّقة على سلسلة المحادثات.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
نقل سلسلة المحادثات المحدّدة إلى المهملات
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
لإزالة سلسلة المحادثات المحدّدة من المهملات.