تتيح لك واجهة برمجة التطبيقات Gmail API عرض بيانات صندوق بريد Gmail وإدارتها، مثل سلاسل المحادثات والرسائل والتصنيفات.
- مورد REST: v1.users
- مورد REST: v1.users.drafts
- مورد REST: v1.users.history
- مورد REST: v1.users.labels
- مورد REST: v1.users.messages
- مورد REST: v1.users.messages.attachments
- مورد REST: v1.users.settings
- مورد REST: v1.users.settings.cse.identities
- مورد REST: v1.users.settings.cse.keypairs
- مورد REST: v1.users.settings.delegates
- مورد REST: v1.users.settings.filters
- مورد REST: v1.users.settings.forwardingAddresses
- مورد REST: v1.users.settings.sendAs
- مورد REST: v1.users.settings.sendAs.smimeInfo
- مورد REST: v1.users.threads
الخدمة: gmail.googleapis.com
لطلب هذه الخدمة، ننصح باستخدام مكتبات العميل التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لطلب هذه الخدمة، استخدِم المعلومات التالية عند طلب بيانات من واجهة برمجة التطبيقات.
مستند الاستكشاف
مستند الاستكشاف هو عبارة عن مواصفات يمكن أن تقرأها الآلة لوصف REST API واستخدامها. وهو يُستخدم لإنشاء مكتبات العميل ومكوّنات 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 تزيل هذه السمة سلسلة المحادثات المحدّدة من المهملات. |