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 )

اندازه پیام در بایت باید در رابطه با فیلد اندازه باشد.

مقایسه اندازه

تعیین می کند که چگونه فیلد اندازه باید با اندازه پیام مقایسه شود.

Enums
unspecified
smaller پیام های کوچکتر از اندازه داده شده را پیدا کنید.
larger پیام های بزرگتر از اندازه داده شده را پیدا کنید.

اقدام

مجموعه ای از اقدامات برای انجام در یک پیام.

نمایندگی JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
فیلدها
addLabelIds[]

string

لیست برچسب هایی که باید به پیام اضافه شوند.

removeLabelIds[]

string

لیست برچسب هایی که باید از پیام حذف شوند.

forward

string

آدرس ایمیلی که پیام باید به آن فوروارد شود.

روش ها

create

 یک فیلتر ایجاد می کند.

delete

 فیلتر مشخص شده را بلافاصله و برای همیشه حذف می کند.

get

 فیلتر می گیرد.

list

 فیلترهای پیام یک کاربر جیمیل را فهرست می کند.