REST Resource: users.settings.filters

Risorsa: filtro

Definizione della risorsa per i filtri di Gmail. I filtri vengono applicati a messaggi specifici anziché a un intero thread di email.

Rappresentazione JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Campi
id

string

L'ID assegnato dal server al filtro.
criteria

object (Criteria)

Criteri di corrispondenza per il filtro.
action

object (Action)

Azione eseguita dal filtro.

Criteri

Criteri di corrispondenza dei messaggi.

Rappresentazione JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Campi
from

string

Il nome visualizzato o l'indirizzo email del mittente.
to

string

Il nome visualizzato o l'indirizzo email del destinatario. Sono inclusi i destinatari nei campi dell'intestazione "a", "cc" e "ccn". Puoi utilizzare semplicemente la parte locale dell'indirizzo email. Ad esempio, sia "example" sia "example@" corrispondono a "example@gmail.com". Questo campo non è sensibile alle maiuscole.
subject

string

Frase senza distinzione tra maiuscole e minuscole trovata nell'oggetto del messaggio. Gli spazi vuoti iniziali e finali vengono rimossi e gli spazi adiacenti vengono accorpati.
query

string

Restituisce solo i messaggi corrispondenti alla query specificata. Supporta lo stesso formato di query della casella di ricerca di Gmail. Ad esempio, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Restituisce solo i messaggi non corrispondenti alla query specificata. Supporta lo stesso formato di query della casella di ricerca di Gmail. Ad esempio, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Indica se il messaggio contiene un allegato.
excludeChats

boolean

Indica se la risposta deve escludere le chat.
size

integer

Le dimensioni dell'intero messaggio RFC822 in byte, incluse tutte le intestazioni e gli allegati.
sizeComparison

enum (SizeComparison)

La dimensione del messaggio in byte deve essere in relazione al campo Dimensioni.

SizeComparison

Determina in che modo il campo della dimensione deve essere confrontato con le dimensioni del messaggio.

Enum
unspecified
smaller Trova i messaggi più piccoli delle dimensioni specificate.
larger Trova i messaggi più grandi delle dimensioni specificate.

Azione

Un insieme di azioni da eseguire su un messaggio.

Rappresentazione JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Campi
addLabelIds[]

string

Elenco di etichette da aggiungere al messaggio.
removeLabelIds[]

string

Elenco di etichette da rimuovere dal messaggio.
forward

string

L'indirizzo email a cui deve essere inoltrato il messaggio.

Metodi

create

 Crea un filtro.

delete

 Elimina immediatamente e definitivamente il filtro specificato.

get

 Recupera un filtro.

list

 Elenca i filtri dei messaggi di un utente di Gmail.