Lister les dossiers

Espace de noms: microsoft.graph

Obtenir tous les objets mailboxFolder dans la boîte aux lettres spécifiée, y compris les dossiers de recherche.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet

Autorisations

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

Type d’autorisation Autorisations les moins privilégiées Autorisations à privilèges plus élevés
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

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de $selectrequête , , $top$filter, $count$skip$orderby, , et $expand OData pour personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

En cas de réussite, cette méthode renvoie un 200 OK code de réponse et une collection d’objets mailboxFolder dans le corps de la réponse.

Exemples

Exemple 1 : Lister les dossiers

L’exemple suivant montre comment obtenir la collection mailboxFolder directement sous le dossier racine de la boîte aux lettres de l’utilisateur.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders

Réponse

L’exemple suivant illustre la réponse.

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: 232

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "EDSVrdi3lRAAACgfQBAAA=",
            "displayName": "Archive",
            "parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 0,
            "totalItemCount": 2,
            "wellKnownName": "archive",
            "type": "IPF.Note"
        },
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "NJWt2LeVEAAAIBDQAAAA==",
            "displayName": "Project Calendar",
            "parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 5,
            "totalItemCount": 6,
            "wellKnownName": null,
            "type": "IPF.Appointment"
        }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?%24skip=10"
}

Exemple 2 : répertorier les dossiers avec les paramètres de requête

L’exemple suivant utilise les $filterparamètres , $selectet $top de requête. Le $filter paramètre affine les résultats et renvoie uniquement les dossiers de typeIPF.Appointment. Le $select paramètre est spécifié pour renvoyer uniquement les propriétés displayName, type et wellKnownName , et définit $top la taille de page du jeu de résultats pour renvoyer les cinq premiers dossiers de la boîte aux lettres.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?$filter=type eq 'IPF.Appointment'&$select=displayName,type,wellKnownName&$top=5

Réponse

L’exemple suivant illustre la réponse.

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: 232

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "NJWt2LeVEAAAIBDQAAAA==",
            "displayName": "Project Calendar",
            "parentMailboxUrl": "https://graph.microsoft.com/v1.0/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "type": "IPF.Appointment",
            "wellKnownName": null
        }
    ]
}