REST Resource: users.settings.filters

Recurso: filtro

Definición de recursos 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 del filtro asignado por el servidor.
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 a los destinatarios en los campos "Para", "Cc" y "Cco" campos de encabezado correspondientes. Puedes usar simplemente la parte local de la dirección de correo electrónico. Por ejemplo, “ejemplo” y "ejemplo@" ambas coinciden con "example@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 iniciales y finales, y se contraen los espacios adyacentes.
query

string

Solo mostrar mensajes que coincidan 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 mostrar mensajes que no coincidan 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

Si el mensaje tiene algún archivo adjunto.
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 los archivos adjuntos.
sizeComparison

enum (SizeComparison)

Cómo debe ser el tamaño del 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.

Enumeraciones
unspecified
smaller Busca mensajes con un tamaño inferior al especificado.
larger Busca mensajes con un tamaño superior al especificado.

Acción

Es 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 que se deben 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 el filtro especificado de forma inmediata y permanente.

get

 Obtiene un filtro.

list

 Enumera los filtros para mensajes de un usuario de Gmail.