REST Resource: users.settings.filters

المرجع: فلتر

تعريف الموارد لفلاتر Gmail تنطبق الفلاتر على رسائل محدّدة بدلاً من سلسلة محادثات كاملة عبر البريد الإلكتروني.

تمثيل JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
الحقول
id

string

رقم التعريف الذي عيَّنه الخادم للفلتر.
criteria

object (Criteria)

معايير مطابقة الفلتر
action

object (Action)

الإجراء الذي ينفّذه الفلتر.

المعايير

معايير مطابقة الرسالة

تمثيل JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
الحقول
from

string

الاسم المعروض للمُرسِل أو عنوان بريده الإلكتروني
to

string

الاسم المعروض للمستلِم أو عنوان بريده الإلكتروني ويتم تضمين المستلمين في حقول العناوين "إلى" و"نسخة إلى" و "نسخة مخفية الوجهة". يمكنك استخدام الجزء المحلي من عنوان البريد الإلكتروني. على سبيل المثال، يتطابق كل من "example" و "example@" مع "example@gmail.com". هذا الحقل غير حساس لحالة الأحرف.
subject

string

عبارة غير حساسة لحالة الأحرف تم العثور عليها في موضوع الرسالة. يتم اقتطاع المسافة البيضاء البادئة واللاحقة وتصغير المسافات المتجاورة.
query

string

عدم عرض سوى الرسائل المطابقة لطلب البحث المحدد. يتيح استخدام تنسيق طلب البحث نفسه الذي يظهر في مربّع بحث Gmail. مثلاً: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
negatedQuery

string

عدم عرض سوى الرسائل التي لا تطابق طلب البحث المحدد. يتيح استخدام تنسيق طلب البحث نفسه الذي يظهر في مربّع بحث Gmail. مثلاً: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"
hasAttachment

boolean

ما إذا كانت الرسالة تحتوي على أي مرفق.
excludeChats

boolean

ما إذا كان يجب أن يستبعد الردّ المحادثات
size

integer

حجم رسالة RFC822 بالكامل بالبايت، بما في ذلك جميع الرؤوس والمرفقات.
sizeComparison

enum (SizeComparison)

كيفية يجب أن يكون حجم الرسالة بالبايت بالنسبة إلى حقل الحجم.

SizeComparison

تحدِّد هذه السمة الطريقة التي يجب مقارنة حقل الحجم بحجم الرسالة.

عمليات التعداد
unspecified
smaller يمكنك البحث عن الرسائل بحجم أصغر من الحجم المحدَّد.
larger يمكنك العثور على الرسائل الأكبر من الحجم المحدَّد.

الإجراء

مجموعة من الإجراءات التي يتم تنفيذها على الرسالة.

تمثيل JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
الحقول
addLabelIds[]

string

قائمة التصنيفات المطلوب إضافتها إلى الرسالة
removeLabelIds[]

string

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

string

عنوان البريد الإلكتروني الذي يجب إعادة توجيه الرسالة إليه.

الطُرق

create

 لإنشاء فلتر.

delete

 يؤدي إلى حذف الفلتر المحدد بشكل فوري ودائم.

get

 الحصول على فلتر

list

 يسرد فلاتر الرسائل لمستخدم Gmail.