Method: users.messages.modify

يعدِّل التصنيفات وقيم "تصنيف الرسالة" في الرسالة المحدّدة. بالنسبة إلى المشرفين الذين يعدّلون الرسائل للمستخدمين في مؤسستهم، تتطلّب الطلبات الحصول على إذن باستخدام حساب خدمة لديه إذن تفويض على مستوى النطاق لانتحال صفة المستخدمين الذين لديهم النطاق https://www.googleapis.com/auth/gmail.modify.restricted.

طلب HTTP

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/messages/{id}/modify

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
userId

string

عنوان البريد الإلكتروني للمستخدم. يمكن استخدام القيمة الخاصة me للإشارة إلى المستخدم الذي تم التحقّق من هويته.
id

string

رقم تعريف الرسالة المطلوب تعديلها.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "addClassificationLabels": [
    {
      object (ClassificationLabelValue)
    }
  ],
  "removeClassificationLabelIds": [
    string
  ]
}
الحقول
addLabelIds[]

string

قائمة بمعرّفات التصنيفات المطلوب إضافتها إلى هذه الرسالة. يمكنك إضافة ما يصل إلى 100 تصنيف مع كل تعديل.
removeLabelIds[]

string

قائمة بمعرّفات التصنيفات المطلوب إزالتها من هذه الرسالة. يمكنك إزالة ما يصل إلى 100 تصنيف مع كل تعديل.
addClassificationLabels[]

object (ClassificationLabelValue)

قائمة بقيم "تصنيف الرسالة" المطلوب إضافتها. إذا تم تطبيق "تصنيف رسالة" يتضمّن معرّف التصنيف نفسه على الرسالة، سيتم تعديل الحقول التي تتضمّن معرّفات الحقول الحالية وإضافة الحقول التي تتضمّن معرّفات الحقول الجديدة. يبلغ الحد الأقصى لقيم "تصنيف الرسالة" 20 قيمة لكل طلب. إذا كانت الرسالة مصنّفة وكان العدد الإجمالي النهائي لقيم "تصنيف الرسالة" يتجاوز الحد الأقصى المسموح به لقيم "تصنيف الرسالة" لكل رسالة، سيفشل التعديل.
removeClassificationLabelIds[]

string

قائمة بقيم "تصنيف الرسالة" المطلوب إزالتها من هذه الرسالة.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال Message.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.modify.restricted

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.