REST Resource: users.settings.filters

Recurso: Filter

Es la definición del recurso para los filtros de Gmail. Los filtros se aplican a mensajes específicos, no a toda la conversación por correo electrónico.

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

string

Es el ID del filtro asignado por el servidor.
criteria

object (Criteria)

Son los criterios de coincidencia del filtro.
action

object (Action)

Es la acción que realiza el filtro.

Criterios

Son los 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

Es el nombre visible o la dirección de correo electrónico del remitente.
to

string

Es el nombre visible o la dirección de correo electrónico del destinatario. Incluye 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". En este campo, no se distinguen mayúsculas de minúsculas.
subject

string

Es la frase que no distingue mayúsculas de minúsculas que se encontró en el asunto del mensaje. Se recortarán los espacios en blanco iniciales y finales, y se contraerán los espacios adyacentes.
query

string

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

string

Solo se devuelven los mensajes que no coinciden con la búsqueda especificada. Admite el mismo formato de búsqueda 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)

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.

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

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

Lista de etiquetas que se quitarán del mensaje.
forward

string

Dirección de correo electrónico a la que se debe reenviar el mensaje. Esto redirecciona el mensaje de manera efectiva a la dirección especificada en este campo, y mantiene el remitente original en el campo “De”.

Métodos

create

 Crea un filtro.

delete

 Borra de inmediato y de forma permanente el filtro especificado.

get

 Obtiene un filtro.

list

 Enumera los filtros de mensajes de un usuario de Gmail.