Gmail API

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

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

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

مستند Discovery

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

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

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

  • 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
يزيل سلسلة المحادثات المحدّدة من المهملات.