نقل البيانات من واجهة برمجة تطبيقات إعدادات البريد الإلكتروني

يتناول هذا المستند الاختلافات الرئيسية بين واجهة برمجة التطبيقات لإعدادات البريد الإلكتروني وواجهة برمجة تطبيقات Gmail. يمكنك استخدام هذا الدليل للمساعدة في نقل تطبيقك إلى واجهة برمجة التطبيقات Gmail API.

تفويض الطلبات

مثل واجهة برمجة التطبيقات لإعدادات البريد الإلكتروني، تستخدم واجهة برمجة التطبيقات Gmail API بروتوكول OAuth 2.0 للسماح بالطلبات. يتمثل أحد الاختلافات الرئيسية في أنّ أذونات واجهة برمجة التطبيقات Gmail API يتم تحديدها لمستخدم فردي بدلاً من النطاق بالكامل. وهذا يعني أن تفويض حساب مشرف النطاق لا يسمح لك بترحيل البريد للمستخدمين الآخرين في النطاق. بدلاً من ذلك، عليك استخدام حسابات الخدمة العادية ذات التفويض على مستوى النطاق والمدرَجة في القائمة البيضاء ضمن وحدة تحكُّم المشرف لإنشاء الرمز المميّز للمصادقة المناسب.

استخدمت واجهة برمجة تطبيقات إعدادات البريد الإلكتروني النطاق:

https://apps-apis.google.com/a/feeds/emailsettings/2.0/

في ما يلي النطاقات المكافئة في Gmail API:

https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing

تغييرات البروتوكول

تستخدم واجهة برمجة التطبيقات لإعدادات البريد الإلكتروني بروتوكول GDATA المستند إلى XML. تستخدم واجهة برمجة التطبيقات Gmail JSON. ونظرًا لأن الإعدادات تتكون في الغالب من أزواج المفتاح/القيمة، فإن حمولات البيانات متشابهة من الناحية النظرية بين الإصدارات.

مثال على إنشاء تصنيف:

واجهة برمجة التطبيقات لإعدادات البريد الإلكتروني

POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
  <apps:property name="label" value="status updates" />
</atom:entry>

Gmail API

POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
   "name": "status updates"
}

استخدِم مكتبات العميل المقدَّمة بدلاً من التطبيق المباشر للبروتوكول.

إدارة التصنيفات

لإدارة التصنيفات في واجهة برمجة التطبيقات Gmail API، استخدِم المورد التصنيفات.

الإعداد القديم الإعداد الجديد Notes
labelId id
label اسم
unreadCount messagesUnread
الظهور labelListVisibility أصبحت SHOW الآن labelShow
HIDE أصبحت الآن labelHide.

التغييرات الأخرى:

  • عند تعديل التصنيفات أو حذفها، تشير واجهة برمجة التطبيقات Gmail API إلى التصنيفات حسب رقم التعريف بدلاً من الاسم.

إدارة الفلاتر

لإدارة الفلاتر في Gmail API، استخدِم مورد الفلاتر.

الإعداد القديم الإعداد الجديد Notes
من criteria.from
إلى criteria.to
صاحب شهادة المفتاح العام criteria.subject
hasTheWord criteria.query
doesNotHaveTheWord criteria.negatedQuery
hasAttachment criteria.hasAttachment
shouldArchive action.removeLabelIds استخدام INBOX كرقم تعريف التصنيف
shouldMarkAsRead action.removeLabelIds استخدام UNREAD كرقم تعريف التصنيف
shouldStar action.addLabelIds استخدام STARRED كرقم تعريف التصنيف
label action.addLabelIds استخدِم رقم تعريف التصنيف لإضافته.
forwardTo action.forward
shouldTrash action.addLabelIds استخدام TRASH كرقم تعريف التصنيف
neverSpam action.removeLabelIds استخدام SPAM كرقم تعريف التصنيف

التغييرات الأخرى:

  • إذا لم يسبق لك إضافة تصنيف مستخدم، يجب إنشاؤه بشكل صريح باستخدام طريقة labels.create.

إدارة الأسماء المستعارة لإرسال الرسائل

لإدارة الأسماء المستعارة لإرسال الرسائل الإلكترونية كـ في واجهة برمجة التطبيقات Gmail API، يمكنك استخدام المورد SendAs.

الإعداد القديم الإعداد الجديد
اسم displayName
معالجة sendAsEmail
replyTo replyToAddress
makeDefault isDefault

إدارة مقاطع الويب

لم تعد إعدادات قصاصات الويب متاحة عبر واجهة برمجة التطبيقات.

إدارة إعدادات إعادة التوجيه التلقائي

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

الإعداد القديم الإعداد الجديد Notes
enable مفعّلة
forwardTo emailAddress
إجراء التصرف تغيّر اسم KEEP ليصبح leaveInInbox
ARCHIVE الآن archive
DELETE أصبح trash
MARK_READ الآن markRead.

التغييرات الأخرى:

  • يجب إنشاء عناوين إعادة التوجيه وإثبات ملكيتها قبل الاستخدام.
  • يمكن إدارة عناوين إعادة التوجيه من خلال المورد ForwardingAddresses.

إدارة إعدادات بروتوكول POP

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

الإعداد القديم الإعداد الجديد Notes
enable accessWindow يتم إيقاف الميزة عند ضبطها على disabled.
enableFor accessWindow أصبحت ALL_MAIL الآن allMail
MAIL_FROM_NOW_ON أصبحت الآن fromNowOn.
إجراء التصرف تغيّر اسم KEEP ليصبح leaveInInbox
ARCHIVE الآن archive
DELETE أصبح trash
MARK_READ الآن markRead.

إدارة إعدادات الوصول عبر IMAP

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

الإعداد القديم الإعداد الجديد
enable مفعّلة

إدارة إعدادات الرد التلقائي أثناء الإجازة

لإدارة ميزة "الرد التلقائي أثناء الإجازة" في واجهة برمجة التطبيقات Gmail API، يمكنك استخدام مرجع الإعدادات.

الإعداد القديم الإعداد الجديد
contactsOnly restrictToContacts
domainOnly restrictToDomain
enable enableAutoReply
endDate endTime
رسالة ReplyBodyHtml
ResponseBodyPlainText
startDate startTime
صاحب شهادة المفتاح العام responseSubject

إدارة إعدادات التوقيع

لإدارة توقيعات البريد الإلكتروني في واجهة برمجة التطبيقات Gmail API، يمكنك استخدام المورد SendAs.

الإعداد القديم الإعداد الجديد
signature signature

التغييرات الأخرى:

  • تتم الآن إدارة التوقيعات لكل اسم مستعار.

إدارة إعدادات اللغة

لإدارة إعدادات اللغة في واجهة برمجة التطبيقات Gmail API، يمكنك استخدام مرجع الإعدادات.

الإعداد القديم الإعداد الجديد
language displayLanguage

يُرجى الرجوع إلى دليل إدارة إعدادات اللغة للحصول على مزيد من المعلومات.

إدارة إعدادات التفويض

لإدارة التفويض في واجهة برمجة التطبيقات Gmail API، يمكنك استخدام المورد المفوَّضين.

الإعداد القديم الإعداد الجديد
معالجة delegateEmail
status verificationStatus

التغييرات الأخرى:

  • معلومات عامة
    • لاستخدام أي من طرق التفويض (بما في ذلك delegates.create)، يجب تفعيل حساب المستخدم المفوَّض في Gmail. ويعني هذا مثلاً أنّه لا يمكن تعليق المستخدم المفوَّض في Google Workspace.
    • لا يمكن استخدام عنوان البريد الإلكتروني البديل كإدخال البريد الإلكتروني المفوَّض لأي من الطرق الجديدة. يجب الإشارة إلى المستخدم المفوَّض باستخدام عنوان بريده الإلكتروني الرئيسي.
  • delegates.create
    • يمكن استخدام هذه الطريقة الآن لإنشاء علاقات المفوَّضين على مستوى نطاقات متعدّدة تنتمي إلى Google Workspace المؤسسة نفسها.
    • يمكن الآن استخدام هذه الطريقة للمستخدمين الذين يحتاجون إلى تغيير كلمة المرور عند تسجيل الدخول في المرة التالية.
    • في حال نجاح هذه الطريقة، تعرض هذه الطريقة موردUsers.settings.delegates في نص الاستجابة، بدلاً من نص استجابة فارغ.
    • في حال إيقاف أي من المستخدمين المفوَّضين أو المستخدمين المفوَّضين (على سبيل المثال، تعليقهما في Google Workspace)، تعذَّر تنفيذ هذه الطريقة مع ظهور خطأ HTTP 4XX بدلاً من ظهور الخطأ HTTP 500.
  • delegates.delete
    • يمكن استخدام هذه الطريقة الآن لحذف المفوَّضين الذين لديهم أي verificationStatus، بدلاً من المستخدمين المفوَّضين accepted أو expired فقط.
  • delegates.get
    • هذه طريقة جديدة، يُفضَّل استخدامها على طريقة delegates.list حسب الحاجة.

إدارة الإعدادات العامة

لم تعُد الإعدادات العامة متاحة عبر واجهة برمجة التطبيقات.