نقل البيانات من Email Settings API

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

السماح بالطلبات

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

استخدمت واجهة برمجة التطبيقات Email Settings 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

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

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

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

واجهة برمجة التطبيقات Email Settings API

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، استخدِم المصدر labels.

الإعداد القديم	الإعداد الجديد	ملاحظات
labelId	id
label	name
unreadCount	messagesUnread
visibility	labelListVisibility	أصبحت SHOW الآن labelShow أصبحت HIDE الآن labelHide

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

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

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

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

الإعداد القديم	الإعداد الجديد	ملاحظات
from	criteria.from
to	criteria.to
subject	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، استخدِم الـ settings.sendAs مصدر.

الإعداد القديم	الإعداد الجديد
name	displayName
address	sendAsEmail
replyTo	replyToAddress
makeDefault	isDefault

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

لا تتوفّر إعدادات "مقطع الويب" في واجهة برمجة التطبيقات Gmail API.

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

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

الإعداد القديم	الإعداد الجديد	ملاحظات
enable	enabled
forwardTo	emailAddress
action	disposition	KEEP أصبحت الآن leaveInInbox أصبحت الآن archive أصبحت الآن trash أصبحت الآن markReadARCHIVEDELETEMARK_READ

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

• يجب إنشاء عناوين إعادة التوجيه وتأكيدها قبل استخدامها.
• يمكن إدارة عناوين إعادة التوجيه باستخدام الـ settings.forwardingAddresses مصدر.

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

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

الإعداد القديم	الإعداد الجديد	ملاحظات
enable	accessWindow	يتم إيقاف هذا الخيار عند ضبطه على disabled
enableFor	accessWindow	أصبحت ALL_MAIL الآن allMail أصبحت MAIL_FROM_NOW_ON الآن fromNowOn
action	disposition	KEEP أصبحت الآن leaveInInbox أصبحت الآن archive أصبحت الآن trash أصبحت الآن markReadARCHIVEDELETEMARK_READ

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

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

الإعداد القديم	الإعداد الجديد
enable	enabled

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

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

الإعداد القديم	الإعداد الجديد
contactsOnly	restrictToContacts
domainOnly	restrictToDomain
enable	enableAutoReply
endDate	endTime
message	responseBodyHtml responseBodyPlainText
startDate	startTime
subject	responseSubject

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

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

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

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

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

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

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

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

لمزيد من المعلومات، يُرجى الاطّلاع على إدارة إعدادات اللغة.

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

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

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

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

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

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

لا تتوفّر الإعدادات العامة في واجهة برمجة التطبيقات Gmail API.