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

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

Methods

create

 יצירת מסנן.

delete

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

get

 אחזור מסנן.

list

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