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 du filtre attribué par le serveur.
criteria

object (Criteria)

Critères de correspondance pour le 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 "À", "Cc" et "Cci". Vous pouvez simplement utiliser la partie locale de l'adresse e-mail. Par exemple, "example" et "example@" correspondent tous deux à "example@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 en début et fin de chaîne sont supprimés, et les espaces adjacents sont réduits.
query

string

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

string

Ne renvoie que les messages ne correspondant pas à la requête spécifiée. Prend en charge le même format de requête que le champ de recherche 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'ensemble du message RFC822 en octets, y compris tous les en-têtes et pièces jointes.
sizeComparison

enum (SizeComparison)

Indique comment la taille du message en octets doit être liée au champ "size".

SizeComparison

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

Enums
unspecified
smaller Recherchez les messages dont la taille est inférieure à celle indiquée.
larger Recherchez les messages dont la taille est supérieure à celle indiqué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é. Le message est alors redirigé vers l'adresse spécifiée dans ce champ, tout en conservant l'expéditeur d'origine dans le champ "De".

Méthodes

create

 Crée un filtre.

delete

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

get

 Obtient un filtre.

list

 Liste les filtres de messages d'un utilisateur Gmail.