Method: users.history.list

Répertorie l'historique de toutes les modifications apportées à la boîte de réception donnée. Les résultats de l'historique sont renvoyés dans l'ordre chronologique (historyId croissant).

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

string

Adresse e-mail de l'utilisateur. La valeur spéciale me peut être utilisée pour indiquer l'utilisateur authentifié.

Paramètres de requête

Paramètres
maxResults

integer (uint32 format)

Nombre maximal d'enregistrements d'historique à renvoyer. La valeur par défaut de ce champ est 100. La valeur maximale autorisée pour ce champ est de 500.
pageToken

string

Jeton de page permettant de récupérer une page de résultats spécifique dans la liste.
startHistoryId

string

Obligatoire. Renvoie les enregistrements d'historique après l'startHistoryId spécifiée. Le startHistoryId fourni doit être obtenu à partir du historyId d'un message, d'un fil de discussion ou d'une réponse list précédente. Les ID d'historique augmentent de manière chronologique, mais ne sont pas contigus et présentent des écarts aléatoires entre les ID valides. Si vous fournissez une startHistoryId non valide ou obsolète, un code d'erreur HTTP 404 est généralement renvoyé. Un historyId est généralement valide pendant au moins une semaine, mais dans de rares cas, il peut ne l'être que pendant quelques heures. Si vous recevez une réponse d'erreur HTTP 404, votre application doit effectuer une synchronisation complète. Si vous ne recevez pas de nextPageToken dans la réponse, aucune mise à jour n'est à récupérer, et vous pouvez stocker le historyId renvoyé pour une prochaine requête.
labelId

string

Ne renvoie que les messages dont le libellé correspond à l'ID.
historyTypes[]

enum (HistoryType)

Types d'historiques à renvoyer par la fonction

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 (History)
    }
  ],
  "nextPageToken": string,
  "historyId": string
}
Champs
history[]

object (History)

Liste des enregistrements de l'historique. Les champs id et threadId sont généralement les seuls à être renseignés dans les messages contenues dans la réponse.
nextPageToken

string

Jeton de page permettant de récupérer la page suivante des résultats dans la liste.
historyId

string

ID de l'enregistrement d'historique actuel de la boîte de réception.

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 d'autorisation.

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 (Message)
    }
  ],
  "messagesAdded": [
    {
      object (MessageAdded)
    }
  ],
  "messagesDeleted": [
    {
      object (MessageDeleted)
    }
  ],
  "labelsAdded": [
    {
      object (LabelAdded)
    }
  ],
  "labelsRemoved": [
    {
      object (LabelRemoved)
    }
  ]
}
Champs
id

string

ID de séquence de boîte de réception.
messages[]

object (Message)

Liste des messages modifiés dans cet enregistrement d'historique. Les champs pour des types de modifications spécifiques, tels que messagesAdded, peuvent dupliquer les messages dans ce champ. Nous vous recommandons d'utiliser les champs de type de modification spécifiques à la place.
messagesAdded[]

object (MessageAdded)

Messages ajoutés à la boîte de réception dans cet enregistrement d'historique.
messagesDeleted[]

object (MessageDeleted)

Messages supprimés (et non placés dans la corbeille) de la boîte de réception dans cet enregistrement d'historique.
labelsAdded[]

object (LabelAdded)

Libellés ajoutés aux messages dans cet enregistrement d'historique.
labelsRemoved[]

object (LabelRemoved)

Libellés supprimés des messages de cet enregistrement d'historique.

MessageAdded

Représentation JSON 
{
  "message": {
    object (Message)
  }
}
Champs
message

object (Message)

MessageDeleted

Représentation JSON 
{
  "message": {
    object (Message)
  }
}
Champs
message

object (Message)

LabelAdded

Représentation JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Champs
message

object (Message)
labelIds[]

string

ID des libellés ajoutés au message.

LabelRemoved

Représentation JSON 
{
  "message": {
    object (Message)
  },
  "labelIds": [
    string
  ]
}
Champs
message

object (Message)
labelIds[]

string

ID de libellé supprimés du message.