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@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.