REST Resource: users.settings.filters

Zasób: Filtr

Definicja zasobu dla filtrów Gmaila. Filtry są stosowane do konkretnych wiadomości zamiast 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)

Kryteria dopasowywania filtra.

action

object (Action)

Działanie wykonywane przez filtr.

Kryteria

Kryteria dopasowywania 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. zawiera adresató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 wielkość liter nie ma znaczenia.

subject

string

W temacie wiadomości wykryto wyrażenie, w którym nie jest rozróżniana wielkość liter. Spacje na początku i na końcu zostaną usunięte, a sąsiednie spacje zostaną połączone.

query

string

zwracać 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

Czy wiadomość zawiera załącznik.

excludeChats

boolean

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

size

integer

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

sizeComparison

enum (SizeComparison)

Jaki powinien być rozmiar wiadomości w bajtach w stosunku 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 o rozmiarze mniejszym niż podany rozmiar.
larger Znajdź wiadomości o rozmiarze większym niż podany.

Działanie

Zestaw działań, które można wykonać na 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ść.

Metody

create

tworzy filtr.

delete

natychmiast i trwało usuwa określony filtr.

get

Pobiera filtr.

list

Wyświetla filtry wiadomości użytkownika Gmaila.