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)

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

مقارنة الحجم

لتحديد كيفية مقارنة حقل الحجم بحجم الرسالة.

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

الإجراء

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

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

string

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

string

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

string

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

الطُرق

create

 لإنشاء فلتر.

delete

 لحذف الفلتر المحدّد على الفور وبشكل نهائي.

get

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

list

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