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.