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

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

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

פעולה

קבוצת פעולות שאפשר לבצע בהודעה.

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

string

רשימת התוויות שצריך להוסיף להודעה.
removeLabelIds[]

string

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

string

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

שיטות

create

 יצירת מסנן.

delete

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

get

 הפונקציה מקבלת מסנן.

list

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