Rechercher et filtrer des messages

Ce document explique comment interroger et rechercher des messages à l'aide de l'API Gmail.

Vous pouvez rechercher ou filtrer des fichiers à l'aide des méthodes messages.list et threads.list. Ces méthodes acceptent le paramètre de requête q, qui est compatible avec la plupart des syntaxes de recherche avancée de l'interface Web Gmail. Pour obtenir la liste des différences entre l'interface utilisateur Gmail et l'API Gmail en termes de recherche et de filtrage, consultez Différences par rapport à l'interface utilisateur Gmail.

Cette syntaxe de recherche avancée vous permet d'utiliser des requêtes pour filtrer les messages par propriétés telles que l'expéditeur, la date ou le libellé. Par exemple, la requête de méthode messages.list suivante récupère tous les messages envoyés par l'utilisateur en janvier 2014 :

GET https://www.googleapis.com/gmail/v1/users/me/messages?q=in:sent after:2014/01/01 before:2014/02/01

En plus des requêtes de recherche, vous pouvez également filtrer les messages et les fils de discussion par libellé à l'aide du paramètre labelIds[]. Cela vous permet de rechercher des messages et des fils de discussion auxquels les libellés système ou utilisateur spécifiés sont appliqués. Pour en savoir plus, consultez les méthodes messages.list et threads.list. Pour en savoir plus sur les libellés, consultez Gérer les libellés.

Différences par rapport à l'interface utilisateur Gmail

Bien que l'API Gmail soit compatible avec la plupart des syntaxes de recherche avancée utilisées dans l'interface utilisateur Gmail, il existe quelques différences :

  • L'interface utilisateur Gmail effectue une expansion d'alias, ce qui lui permet d'inférer un alias de compte à partir d'un compte Google Workspace. Par exemple, supposons que vous ayez un compte myprimary@cymbalgroup.com et que votre administrateur configure un alias myalias@cymbalgroup.com pour ce compte. Si myalias@cymbalgroup.com envoie un e-mail, mais que vous recherchez "from: myprimary@cymbalgroup.com", l'e-mail envoyé par myalias@cymbalgroup.com s'affiche dans les résultats de recherche de l'UI Gmail, mais pas dans la réponse de l'API.

  • L'interface utilisateur Gmail permet aux utilisateurs d'effectuer des recherches dans l'ensemble des fils de discussion, mais l'API ne le permet pas.