Répertorier les mailFolders

Espace de noms: microsoft.graph

Obtenir la collection de dossiers de courrier figurant directement sous le dossier racine de l’utilisateur connecté. La collection renvoyée inclut tous les dossiers de recherche de courrier directement sous la racine.

Par défaut, cette opération ne renvoie pas les dossiers cachés. Utilisez un paramètre de requête includeHiddenFolders pour les inclure dans la réponse.

Autorisations

L’une des autorisations suivantes est requise pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
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

Pour obtenir tous les dossiers de courrier de la boîte aux lettres de l’utilisateur spécifié, à l’exception de ceux qui sont masqués :

GET /me/mailFolders
GET /users/{id | userPrincipalName}/mailFolders

Pour inclure les dossiers de courrier masqués dans la réponse :

GET /me/mailFolders/?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/?includeHiddenFolders=true

Paramètres facultatifs de la requête

Pour renvoyer une liste de tous les mailFolders, y compris ceux qui sont masqués (leur propriété isHidden est true), dans l’URL de la requête, définissez le paramètre de requête includeHiddenFolders sur true, comme indiqué dans la section Requête HTTP.

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

En-têtes de demande

En-tête	Valeur
Autorisation	Porteur {token}. Obligatoire.
Content-Type	application/json

Corps de la demande

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

Réponse

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

Exemples

Exemple 1 : répertorier les dossiers de courrier de la boîte aux lettres de l’utilisateur connecté

Cet exemple inclut un objet mailSearchFolder dans la réponse. Le dossier de recherche de courrier est un dossier enfant de la boîte de réception avec comme nom d’affichage « Synthèses hebdomadaires ».

Demande

Voici un exemple de demande.

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Me.MailFolders.GetAsync();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



result, err := graphClient.Me().MailFolders().Get(context.Background(), nil)

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

MailFolderCollectionPage mailFolders = graphClient.me().mailFolders()
	.buildRequest()
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let mailFolders = await client.api('/me/mailFolders')
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);


$result = $graphServiceClient->me()->mailFolders()->get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

PowerShell

Import-Module Microsoft.Graph.Mail

# A UPN can also be used as -UserId.
Get-MgUserMailFolder -UserId $userId

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Réponse

Voici un exemple de réponse, qui inclut un dossier mailSearchFolder qui est un dossier enfant sous la boîte de réception.

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.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AQMkADYAAAIBXQAAAA==",
            "displayName": "Archive",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBFQAAAA==",
            "displayName": "Conversation History",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCgAAAA==",
            "displayName": "Deleted Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDwAAAA==",
            "displayName": "Drafts",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDAAAAA==",
            "displayName": "Inbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 70,
            "totalItemCount": 71,
            "isHidden": false
        },
        {
            "@odata.type": "#microsoft.graph.mailSearchFolder",
            "id": "AAMkADYRAAAZg1yTAAA=",
            "displayName": "Weekly digests",
            "parentFolderId": "AQMkADYAAAIBDAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 4,
            "totalItemCount": 5,
            "isHidden": false,
            "isSupported": true,
            "filterQuery": "contains(subject, 'weekly digest')"
        },
        {
            "id": "AQMkADYAAAIBGQAAAA==",
            "displayName": "Junk Email",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCwAAAA==",
            "displayName": "Outbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCQAAAA==",
            "displayName": "Sent Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        }
    ]
}

Exemple 2 : Inclure les dossiers masqués de la boîte aux lettres de l’utilisateur connecté

Cet exemple utilise le paramètre de includeHiddenFolders requête pour obtenir une liste de dossiers de courrier, y compris les dossiers de courrier masqués. La réponse inclut le dossier « Courriers » pour lequel isHidden est défini sur true.

Demande

HTTP

GET https://graph.microsoft.com/beta/me/mailFolders/?includeHiddenFolders=true

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Me.MailFolders.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Includehiddenfolders = true;
});

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphconfig "github.com/microsoftgraph/msgraph-beta-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestIncludehiddenfolders := true

requestParameters := &graphconfig.ItemMailFoldersRequestBuilderGetQueryParameters{
	Includehiddenfolders: &requestIncludehiddenfolders,
}
configuration := &graphconfig.ItemMailFoldersRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Me().MailFolders().Get(context.Background(), configuration)

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new QueryOption("includeHiddenFolders", "true"));

MailFolderCollectionPage mailFolders = graphClient.me().mailFolders()
	.buildRequest( requestOptions )
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let mailFolders = await client.api('/me/mailFolders/?includeHiddenFolders=true')
	.version('beta')
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new MailFoldersRequestBuilderGetRequestConfiguration();
$queryParameters = MailFoldersRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->includehiddenfolders = true;
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->mailFolders()->get($requestConfiguration);

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

PowerShell

Import-Module Microsoft.Graph.Mail

# A UPN can also be used as -UserId.
Get-MgUserMailFolder -UserId $userId -Includehiddenfolders true 

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Réponse

Voici un exemple de réponse.

Remarque : L’objet de réponse illustré ici est raccourci pour plus de lisibilité et n’inclut pas tous les dossiers par défaut d’une boîte aux lettres utilisateur.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Clutters",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": true
        },
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Conversation History",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "isHidden": false
        }
    ]
}