REST Resource: users.settings.filters

Recurso: Filter

Definición de recurso para los filtros de Gmail. Los filtros se aplican a mensajes específicos en lugar de a toda una conversación de correo electrónico.

Representación JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Campos
id

string

El ID que el servidor asignó al filtro.
criteria

object (Criteria)

Criterios de coincidencia para el filtro.
action

object (Action)

Acción que realiza el filtro.

Criterios

Criterios de coincidencia de mensajes.

Representación JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Campos
from

string

El nombre visible o la dirección de correo electrónico del remitente
to

string

El nombre visible o la dirección de correo electrónico del destinatario. Incluye los destinatarios de los campos de encabezado "Para", "Cc" y "Cco". Puedes utilizar simplemente la parte local de la dirección de correo electrónico. Por ejemplo, "ejemplo" y "ejemplo@" coinciden con "ejemplo@gmail.com". Este campo no distingue mayúsculas de minúsculas.
subject

string

Se encontró una frase que no distingue mayúsculas de minúsculas en el asunto del mensaje. Se cortarán los espacios en blanco al final y al inicio, y los adyacentes se contraerán.
query

string

Solo muestra mensajes que coinciden con la consulta especificada. Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Solo muestra mensajes que no coinciden con la consulta especificada. Admite el mismo formato de consulta que el cuadro de búsqueda de Gmail. Por ejemplo, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Indica si el mensaje tiene archivos adjuntos.
excludeChats

boolean

Si la respuesta debe excluir los chats.
size

integer

El tamaño del mensaje RFC822 completo en bytes, incluidos todos los encabezados y archivos adjuntos.
sizeComparison

enum (SizeComparison)

Indica qué tamaño debe tener el mensaje en bytes en relación con el campo de tamaño.

SizeComparison

Determina cómo se debe comparar el campo de tamaño con el tamaño del mensaje.

Enumeradores
unspecified
smaller Busca mensajes más pequeños que el tamaño especificado.
larger Busca mensajes que sean más grandes que el tamaño especificado.

Acción

Un conjunto de acciones para realizar en un mensaje.

Representación JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Campos
addLabelIds[]

string

Lista de etiquetas para agregar al mensaje.
removeLabelIds[]

string

Lista de etiquetas para quitar del mensaje.
forward

string

Dirección de correo electrónico a la que se debe reenviar el mensaje

Métodos

create

 Crea un filtro.

delete

 Borra de inmediato y permanentemente el filtro especificado.

get

 Obtiene un filtro.

list

 Muestra una lista de los filtros de mensajes de un usuario de Gmail.