- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- HistoryType
- Historique
- MessageAdded
- MessageDeleted
- LabelAdded
- LabelRemoved
- Essayer
Affiche l'historique de toutes les modifications apportées à la boîte aux lettres indiquée. Les résultats de l'historique sont renvoyés dans l'ordre chronologique (en augmentant la valeur historyId
).
Requête HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/history
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
userId |
Adresse e-mail de l'utilisateur. La valeur spéciale |
Paramètres de requête
Paramètres | |
---|---|
maxResults |
Nombre maximal d'enregistrements de l'historique à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est 500. |
pageToken |
Jeton de page permettant de récupérer une page spécifique de résultats dans la liste. |
startHistoryId |
Obligatoire. Renvoie les enregistrements d'historique après la date |
labelId |
Afficher uniquement les messages dont le libellé correspond à l'ID. |
historyTypes[] |
Types d'historiques que la fonction doit renvoyer |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
Représentation JSON |
---|
{
"history": [
{
object ( |
Champs | |
---|---|
history[] |
Liste des enregistrements de l'historique. Tout |
nextPageToken |
Jeton de page permettant de récupérer la page de résultats suivante dans la liste. |
historyId |
ID de l'enregistrement d'historique actuel de la boîte aux lettres. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.readonly
https://www.googleapis.com/auth/gmail.metadata
Pour en savoir plus, consultez le guide relatif aux autorisations.
HistoryType
Enums | |
---|---|
messageAdded |
|
messageDeleted |
|
labelAdded |
|
labelRemoved |
Historique
Enregistrement d'une modification apportée à la boîte aux lettres de l'utilisateur. Chaque modification de l'historique peut affecter plusieurs messages de différentes manières.
Représentation JSON |
---|
{ "id": string, "messages": [ { object ( |
Champs | |
---|---|
id |
ID de séquence de la boîte aux lettres. |
messages[] |
Liste des messages modifiée dans cet enregistrement d'historique. Les champs associés à des types de modifications spécifiques, tels que |
messagesAdded[] |
Messages ajoutés à la boîte aux lettres dans cet enregistrement d'historique. |
messagesDeleted[] |
Messages supprimés de la boîte aux lettres (et non placés dans la corbeille) dans cet enregistrement de l'historique. |
labelsAdded[] |
Libellés ajoutés aux messages de cet enregistrement d'historique. |
labelsRemoved[] |
Les libellés ont été supprimés des messages de cet enregistrement d'historique. |
MessageAdded
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
MessageDeleted
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
LabelAdded
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
labelIds[] |
ID des libellés ajoutés au message. |
LabelRemoved
Représentation JSON |
---|
{
"message": {
object ( |
Champs | |
---|---|
message |
|
labelIds[] |
Les ID des libellés ont été supprimés du message. |