REST Resource: users.settings.filters

Ressource: Filtre

Définition des ressources pour les filtres Gmail. Ils s'appliquent à des messages spécifiques et non à l'ensemble d'un fil de discussion.

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

string

Identifiant attribué au filtre par le serveur.

criteria

object (Criteria)

Critères de correspondance pour le filtre.

action

object (Action)

Action exécutée par le filtre.

Critères

Critères de correspondance du message.

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 figurant dans les champs d'en-tête "À", "Cc" et "Cci". Vous pouvez simplement utiliser la partie locale de l'adresse e-mail. Par exemple, les mots "exemple" et "exemple@" correspondent tous deux à "exemple@gmail.com". Ce champ n'est pas sensible à la casse.

subject

string

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

query

string

Renvoie uniquement les messages correspondant à la requête spécifiée. Ce paramètre est compatible avec 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

Renvoie uniquement les messages qui ne correspondent pas à la requête spécifiée. Ce paramètre est compatible avec 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 comporte une pièce jointe.

excludeChats

boolean

Indique si la réponse doit exclure des chats.

size

integer

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

sizeComparison

enum (SizeComparison)

Indique la taille du message en octets par rapport au champ de taille.

SizeComparison

Détermine la manière dont le champ de taille doit être comparé à la taille du message.

Enums
unspecified
smaller Rechercher les messages dont la taille est inférieure à celle indiquée
larger Rechercher 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 vers 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 de Gmail.