REST Resource: users.settings.filters

Zasób: filtr

Definicja zasobu filtrów Gmaila. Filtry mają zastosowanie do konkretnych wiadomości, a nie do całego wątku.

Zapis JSON
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Pola
id

string

Identyfikator filtra przypisany do serwera.

criteria

object (Criteria)

Spełnione kryteria filtra.

action

object (Action)

Działanie wykonywane przez filtr.

Kryteria

Wiadomość zgodna z kryteriami.

Zapis JSON
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Pola
from

string

Wyświetlana nazwa lub adres e-mail nadawcy.

to

string

Wyświetlana nazwa lub adres e-mail odbiorcy. Uwzględnia adresatów w polach „Do”, „DW” i „UDW” pola nagłówka. Możesz użyć lokalnej części adresu e-mail. Na przykład „przykład” i „example@” oba pasują do adresu „example@gmail.com”. Wielkość liter w tym polu nie jest rozróżniana.

subject

string

W temacie wiadomości znaleziono wyrażenie bez rozróżniania wielkości liter. Odstępy na końcu i na początku zostaną usunięte, a sąsiednie spacje zostaną zwinięte.

query

string

Zwraca tylko wiadomości pasujące do określonego zapytania. Obsługuje ten sam format zapytania co pole wyszukiwania w Gmailu. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".

negatedQuery

string

Zwraca tylko wiadomości niepasujące do podanego zapytania. Obsługuje ten sam format zapytania co pole wyszukiwania w Gmailu. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".

hasAttachment

boolean

Określa, czy wiadomość ma załącznik.

excludeChats

boolean

Określa, czy odpowiedź ma wykluczyć czaty.

size

integer

Rozmiar całej wiadomości RFC822 w bajtach, w tym wszystkich nagłówków i załączników.

sizeComparison

enum (SizeComparison)

Wpływ rozmiaru wiadomości w bajtach do pola rozmiaru.

SizeComparison

Określa, jak należy porównywać pole rozmiaru z rozmiarem wiadomości.

Wartości w polu enum
unspecified
smaller Znajdź wiadomości mniejsze niż podany rozmiar.
larger Znajdź wiadomości większe niż podany rozmiar.

Działanie

Zestaw działań, które mają zostać wykonane na wiadomości.

Zapis JSON
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Pola
addLabelIds[]

string

Lista etykiet, które mają zostać dodane do wiadomości.

removeLabelIds[]

string

Lista etykiet, które mają zostać usunięte z wiadomości.

forward

string

Adres e-mail, na który ma zostać przekazana wiadomość.

Metody

create

Tworzy filtr.

delete

Natychmiast i trwale usuwa określony filtr.

get

Pobiera filtr.

list

Wyświetla listę filtrów wiadomości użytkownika Gmaila.