تتيح لك 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 واستخدامها. ويتم استخدامه لإنشاء مكتبات العملاء ومكونات إضافية لبيئة تطوير البرامج المتكاملة وأدوات أخرى تتفاعل مع واجهات برمجة تطبيقات Google. قد توفّر خدمة واحدة عدة مستندات اكتشاف. توفّر هذه الخدمة مستند الاكتشاف التالي:
نقطة نهاية الخدمة
نقطة نهاية الخدمة هي عنوان 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 لإزالة سلسلة المحادثات المحدّدة من المهملات |