REST Resource: users.settings.filters

منبع: فیلتر

تعریف منابع برای فیلترهای جیمیل. فیلترها به جای کل یک رشته ایمیل، روی پیام‌های خاص اعمال می‌شوند.

نمایش 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

نام نمایشی یا آدرس ایمیل گیرنده. شامل گیرندگان در فیلدهای هدر "to"، "cc" و "bcc" می‌شود. می‌توانید به سادگی از قسمت محلی آدرس ایمیل استفاده کنید. برای مثال، "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 را فهرست می‌کند.