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 una conversación de correo electrónico completa.

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

string

El ID asignado del filtro 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 de encabezado “Para”, “Cc” y “Cco”. Puedes usar solo 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 sin distinción entre mayúsculas y minúsculas en el asunto del mensaje. Se recortan los espacios en blanco iniciales y finales, y se contraen los espacios adyacentes.
query

string

Solo muestra los mensajes que coincidan con la búsqueda 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 los mensajes que no coinciden con la búsqueda 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 algún archivo adjunto.
excludeChats

boolean

Indica si la respuesta debe excluir los chats.
size

integer

Es el tamaño de todo el mensaje RFC822 en bytes, incluidos todos los encabezados y archivos adjuntos.
sizeComparison

enum (SizeComparison)

Indica 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 más pequeños que el tamaño determinado.
larger Busca mensajes de un tamaño superior al especificado.

Acción

Es un conjunto de acciones que se pueden realizar en un mensaje.

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

string

Es la lista de etiquetas que se agregarán al mensaje.
removeLabelIds[]

string

Es la lista de etiquetas que se quitarán del mensaje.
forward

string

Es la dirección de correo electrónico a la que se debe reenviar el mensaje.

Métodos

create

 Crea un filtro.

delete

 Borra de forma inmediata y permanente el filtro especificado.

get

 Obtiene un filtro.

list

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