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 )

Как должен выглядеть размер сообщения в байтах относительно поля размера.

Сравнение размеров

Определяет, как следует сравнивать поле размера с размером сообщения.

Перечисления
unspecified
smaller Найти сообщения меньшего размера, чем заданный.
larger Найти сообщения, размер которых превышает заданный.

Действие

Набор действий, которые необходимо выполнить с сообщением.

JSON-представление 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Поля
addLabelIds[]

string

Список меток для добавления к сообщению.

removeLabelIds[]

string

Список меток, которые следует удалить из сообщения.

forward

string

Адрес электронной почты, на который следует переслать сообщение. Это фактически перенаправляет сообщение на адрес, указанный в этом поле, сохраняя при этом отправителя в поле «От».

Методы

create

 Создает фильтр.

delete

 Немедленно и навсегда удаляет указанный фильтр.

get

 Получает фильтр.

list

 Отображает список фильтров сообщений пользователя Gmail.