REST Resource: users.settings.filters

Ressource: Filtre

Définition de la ressource pour les filtres Gmail. Les filtres s'appliquent à des messages spécifiques plutôt qu'à un fil de discussion entier.

Représentation JSON 
{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}
Champs
id

string

ID attribué par le serveur au filtre.
criteria

object (Criteria)

Critères de correspondance du filtre.
action

object (Action)

Action effectuée par le filtre.

Critères

Critères de correspondance des messages.

Représentation JSON 
{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}
Champs
from

string

Nom à afficher ou adresse e-mail de l'expéditeur.
to

string

Nom à afficher ou adresse e-mail du destinataire. Inclut les destinataires dans les champs d'en-tête "to", "cc" et "bcc". Vous pouvez simplement utiliser la partie locale de l'adresse e-mail. Par exemple, "exemple" et "exemple@" correspondent tous deux à "exemple@gmail.com". Ce champ n'est pas sensible à la casse.
subject

string

Expression non sensible à la casse trouvée dans l'objet du message. Les espaces blancs de début et de fin sont supprimés, et les espaces adjacents sont tronqués.
query

string

Ne renvoie que les messages correspondant à la requête spécifiée. Compatible avec le même format de requête que le champ de recherche de Gmail. Par exemple, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
negatedQuery

string

Ne renvoie que les messages qui ne correspondent pas à la requête spécifiée. Compatible avec le même format de requête que le champ de recherche de Gmail. Par exemple, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
hasAttachment

boolean

Indique si le message contient une pièce jointe.
excludeChats

boolean

Indique si la réponse doit exclure les chats.
size

integer

Taille de l'intégralité du message RFC822 en octets, y compris tous les en-têtes et les pièces jointes.
sizeComparison

enum (SizeComparison)

Relation entre la taille du message en octets et le champ de taille.

SizeComparison

Détermine comment le champ de taille doit être comparé à la taille du message.

Enums
unspecified
smaller Recherchez les messages de taille inférieure à la taille donnée.
larger Recherchez les messages de taille supérieure à la taille donnée.

Action

Ensemble d'actions à effectuer sur un message.

Représentation JSON 
{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}
Champs
addLabelIds[]

string

Liste des libellés à ajouter au message.
removeLabelIds[]

string

Liste des libellés à supprimer du message.
forward

string

Adresse e-mail à laquelle le message doit être transféré.

Méthodes

create

 Crée un filtre.

delete

 Supprime immédiatement et définitivement le filtre spécifié.

get

 Récupère un filtre.

list

 Liste les filtres de messages d'un utilisateur Gmail.