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 e-mail.

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

string

Identyfikator filtra przypisany przez serwer.
criteria

object (Criteria)

Spełniające kryteria filtra.
action

object (Action)

Działanie wykonywane przez filtr.

Kryteria

Wiadomość spełniająca kryteria.

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ć po prostu lokalnej części adresu e-mail. Na przykład adresy „example” i „example@” będą pasować 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 początku i na końcu ścieżki zostaną usunięte, a przylegające do nich spacje zostaną zwinięte.
query

string

Zwracaj tylko wiadomości pasujące do podanego zapytania. Obsługuje ten sam format zapytań co pole wyszukiwania Gmaila. 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 Gmaila. Na przykład: "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Wskazuje, czy wiadomość ma załącznik.
excludeChats

boolean

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

integer

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

enum (SizeComparison)

Jaki powinien być stosunek rozmiaru wiadomości w bajtach do pola rozmiaru.

SizeComparison

Określa, jak należy porównać 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ń do wykonania w odniesieniu do wiadomości.

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

string

Lista etykiet, które można dodać do wiadomości.
removeLabelIds[]

string

Lista etykiet, które można usunąć z wiadomości.
forward

string

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

Metody

create

 Tworzy filtr.

delete

 Natychmiast i trwale usuwa określony filtr.

get

 Pobiera filtr.

list

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