mailFolder: delta

  • Article

Espace de noms: microsoft.graph

Obtenez un ensemble de dossiers de courriers qui ont été ajoutés ou supprimés de la boîte aux lettres de l’utilisateur.

Un appel de fonction delta pour les dossiers de messagerie dans une boîte aux lettres est similaire à une requête GET, sauf qu’en appliquant de manière appropriée des jetons d’état dans un ou plusieurs de ces appels, vous pouvez interroger les modifications incrémentielles dans les dossiers de courrier. Cela vous permet de gérer et de synchroniser un magasin local des dossiers de messagerie d’un utilisateur sans avoir à extraire tous les dossiers de messagerie de cette boîte aux lettres à partir du serveur à chaque fois.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Mail.ReadBasic Mail.Read, Mail.ReadWrite
Déléguée (compte Microsoft personnel) Mail.ReadBasic Mail.Read, Mail.ReadWrite
Application Mail.ReadBasic.All Mail.Read, Mail.ReadWrite

Requête HTTP

GET /me/mailFolders/delta
GET /users/{id}/mailFolders/delta

Paramètres de requête

Le suivi des modifications dans les dossiers de messagerie entraîne une série d’appels de fonction delta . Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du @odata.nextLink ou de l’URL @odata.deltaLink fournie dans la réponse. Il vous suffit de spécifier les paramètres de requête de votre choix la première fois. Dans les requêtes suivantes, copiez et appliquez simplement l’URL @odata.nextLink ou @odata.deltaLink de la réponse précédente, car cette URL inclut déjà les paramètres encodés souhaités.

Paramètre de requête Type Description
$deltatoken string Jeton d’état retourné dans l’URL @odata.deltaLink de l’appel de fonction delta précédent pour la même collection de dossiers de messagerie, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL @odata.deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skiptoken string Jeton d’état renvoyé dans l’URL @odata.nextLink de l’appel de fonction delta précédent, indiquant que des modifications supplémentaires doivent être suivies dans la même collection de dossiers de courrier.

Paramètres de requête OData

Vous pouvez utiliser un paramètre de requête $select comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée.

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire.
Content-Type string application/json. Obligatoire.
Préférence chaîne odata.maxpagesize={x}. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet mailFolder dans le corps de la réponse.

Exemple

Demande

L’exemple suivant montre comment effectuer un seul appel de fonction delta et limiter le nombre maximal de dossiers de courriers dans le corps de réponse à 2.

Pour effectuer le suivi des modifications dans les dossiers de courriers d’une boîte aux lettres, effectuez un ou plusieurs appels de fonction delta avec des jetons d’état appropriés, pour accéder à l’ensemble des modifications incrémentielles depuis la dernière requête delta.

Vous trouverez un exemple similaire qui montre comment utiliser les jetons d’état pour suivre les modifications apportées aux messages d’un dossier de messagerie : Obtenir les modifications incrémentielles apportées aux messages dans un dossier. Les différences main entre le suivi des dossiers de courrier et le suivi des messages dans un dossier se trouvent dans les URL de requête delta, et les réponses de requête retournant mailFolder plutôt que les collections de messages.

GET https://graph.microsoft.com/v1.0/me/mailFolders/delta

Prefer: odata.maxpagesize=2
Réponse

Si la demande réussit, la réponse inclut un jeton d’état, qui est soit un skipToken (dans un en-tête de réponse @odata.nextLink ) soit un deltaToken (dans un en-tête de réponse @odata.deltaLink ). Respectivement, ils indiquent si vous devez poursuivre la ronde ou si vous avez terminé d’obtenir toutes les modifications pour cette ronde.

La réponse suivante illustre un skipToken dans un en-tête de réponse @odata.nextLink.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/mailFolders/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "displayName": "displayName-value",
      "parentFolderId": "parentFolderId-value",
      "childFolderCount": 99,
      "unreadItemCount": 99,
      "totalItemCount": 99
    }
  ]
}

Contenu connexe