REST Resource: users.settings.filters

Zasób: Filtr

Definicja zasobu dla filtrów Gmaila. Filtry są stosowane do konkretnych wiadomości, a nie do całego wątku e-maili.

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

string

Identyfikator filtra przypisany przez serwer.
criteria

object (Criteria)

Kryteria dopasowania filtra.
action

object (Action)

Działanie wykonywane przez filtr.

Kryteria

Kryteria dopasowania wiadomości.

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. Obejmuje odbiorców w polach nagłówka „Do”, „DW” i „UDW”. Możesz użyć tylko lokalnej części adresu e-mail. Na przykład „example” i „example@” pasują do „example@gmail.com”. W tym polu nie jest rozróżniana wielkość liter.
subject

string

Wyrażenie znalezione w temacie wiadomości, w którym nie jest rozróżniana wielkość liter. Odstępy na początku i na końcu są usuwane, a sąsiadujące spacje są łączone.
query

string

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

string

Zwracaj tylko wiadomości, które nie pasują do określonego zapytania. Obsługuje ten sam format zapytań co pole wyszukiwania w Gmailu. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

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

boolean

Określa, czy odpowiedź ma wykluczać czaty.
size

integer

Rozmiar całej wiadomości RFC822 w bajtach, w tym wszystkie nagłówki i załączniki.
sizeComparison

enum (SizeComparison)

Określa, jak rozmiar wiadomości w bajtach ma się odnosić do pola rozmiaru.

SizeComparison

Określa, jak pole rozmiaru ma być porównywane 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ń do wykonania w wiadomości.

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

string

Lista etykiet do dodania do wiadomości.
removeLabelIds[]

string

Lista etykiet do usunięcia z wiadomości.
forward

string

Adres e-mail, na który ma zostać przekazana wiadomość. Powoduje to przekierowanie wiadomości na adres podany w tym polu, przy zachowaniu pierwotnego nadawcy w polu „Od”.

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.