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

ההגדרה הזו קובעת איך להשוות בין שדה הגודל לגודל ההודעה.

טיפוסים בני מנייה (enum)
unspecified
smaller חיפוש הודעות קטנות יותר מהגודל הנתון.
larger חיפוש הודעות גדולות יותר מהגודל הנתון.

פעולה

קבוצת פעולות לביצוע בהודעה.

ייצוג JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
שדות
addLabelIds[]

string

רשימת התוויות להוספה להודעה.
removeLabelIds[]

string

רשימת תוויות להסרה מההודעה.
forward

string

כתובת האימייל שאליה צריך להעביר את ההודעה.

שיטות

create

 יצירת מסנן

delete

 מוחקת את המסנן שצוין באופן מיידי וסופי.

get

 מקבל מסנן.

list

 רשימה של מסנני ההודעות של משתמש Gmail.