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.