mailboxFolder : delta
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Obtenez un ensemble d’objets mailboxFolder qui ont été ajoutés, supprimés ou supprimés de la boîte aux lettres de l’utilisateur.
Un appel de fonction delta pour les dossiers d’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. Cette approche 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 cette boîte aux lettres à partir du serveur à chaque fois.
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) | MailboxFolder.Read | MailboxFolder.ReadWrite |
| Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
| Application | MailboxFolder.Read.All | MailboxFolder.ReadWrite.All |
Requête HTTP
GET /admin/exchange/mailboxes/{mailboxId}/folders/delta
GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders/delta
Paramètres de requête
Le suivi des modifications dans les dossiers 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 nextLink ou de l’URL 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 nextLink ou 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 | Description |
|---|---|
| $deltaToken | Jeton d’état retourné dans l’URL deltaLink de l’appel de fonction delta précédent pour la même collection de dossiers, qui indique la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection. |
| $skipToken | Jeton d’état retourné dans l’URL nextLink de l’appel de fonction delta précédent, indiquant que d’autres modifications peuvent être suivies dans la même collection de dossiers. |
Paramètres de requête OData
Vous pouvez utiliser le paramètre de $select requête pour spécifier uniquement les propriétés dont vous avez besoin pour des performances optimales. Les propriétés id et parentMailboxUrl sont toujours retournées.
En-têtes de demande
| Nom | Description |
|---|---|
| Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
| Préférence | odata.maxpagesize={x}. Facultatif. |
Corps de la demande
N’indiquez pas le corps de la demande pour cette méthode.
Réponse
Si elle réussit, cette fonction renvoie un 200 OK code de réponse et une collection d’objets mailboxFolder dans le corps de la réponse.
Exemples
Demande
L’exemple suivant montre comment effectuer un seul appel de fonction delta et limiter le nombre maximal de dossiers dans le corps de la réponse à deux.
Pour suivre les modifications apportées aux dossiers d’une boîte aux lettres, vous effectuez un ou plusieurs appels de fonction delta , avec les jetons d’état appropriés, pour obtenir l’ensemble des modifications incrémentielles depuis la dernière requête delta.
Pour obtenir un exemple similaire qui montre comment utiliser les jetons d’état pour suivre les modifications apportées aux éléments d’un dossier, consultez Obtenir des modifications incrémentielles des messages dans un dossier. Les différences main entre les dossiers de suivi et les éléments de suivi d’un dossier se trouvent dans les URL de requête delta et les réponses de requête qui retournent le dossier plutôt que les collections d’éléments.
GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/delta
Prefer: odata.maxpagesize=2
Réponse
Si la demande réussit, la réponse inclut un jeton d’état qui est un $skipToken (dans un en-tête de réponse @odata.nextLink ) ou 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.
L’exemple suivant montre un dans un $deltaToken en-tête de réponse @odata.deltaLink .
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
Content-length: 254
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(mailboxFolder)",
"@odata.deltaLink": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/delta?$deltatoken={_deltaToken_}",
"value": [
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"displayName": "Inbound",
"parentMailboxUrl": "https://graph.microsoft.com/beta/admin/Exchange/Mailboxes/MBX:e0643f21@a7809c93",
"id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP9AAA="
},
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"displayName": "Outbound",
"parentMailboxUrl": "https://graph.microsoft.com/beta/admin/Exchange/Mailboxes/MBX:e0643f21@a7809c93",
"id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP_AAA="
}
]
}