childFolders を一覧表示する

[アーティクル]
01/20/2022

名前空間: microsoft.graph

指定したフォルダーの下のフォルダーのコレクションを取得します。.../me/mailFolders ショートカットを使用して、最上位フォルダーのコレクションを取得して、別のフォルダーに移動することができます。

既定では、この操作は隠しフォルダーを返しません。クエリパラメーター includeHiddenFolders を使用して、応答にそれらを含めます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Mail.ReadBasic, Mail.Read, Mail.ReadWrite
委任 (個人用 Microsoft アカウント)	Mail.ReadBasic, Mail.Read, Mail.ReadWrite
アプリケーション	Mail.ReadBasic.All, Mail.Read, Mail.ReadWrite

HTTP 要求

指定されたフォルダー内にあるすべての子フォルダー (メール検索フォルダーなど) を取得するには、以下のようにします。

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

非表示の 子フォルダーを応答に含めるには、以下のようにします。

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

オプションのクエリパラメーター

非表示 (isHidden プロパティが true) のものを含むすべての子フォルダーのリストを返すには、HTTP 要求セクションで示したように、リクエスト URL で true としての includeHiddenFolders クエリパラメーターと指定します。

このメソッドは、応答をカスタマイズするための OData クエリパラメーターをサポートします。

要求ヘッダー

名前	種類	説明
Authorization	string	ベアラー {token}。必須。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で mailFolder オブジェクトのコレクションを返します。

例

例 1: メールフォルダーを一覧表示する

要求の例を次に示します。

要求

以下は、要求の例です。

GET https://graph.microsoft.com/v1.0/me/mailFolders/{id}/childFolders


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var childFolders = await graphClient.Me.MailFolders["{mailFolder-id}"].ChildFolders
    .Request()
    .GetAsync();


const options = {
    authProvider,
};

const client = Client.init(options);

let childFolders = await client.api('/me/mailFolders/{id}/childFolders')
    .get();


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/v1.0/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me/mailFolders/{id}/childFolders"]]];
[urlRequest setHTTPMethod:@"GET"];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        NSError *jsonError = nil;
        MSCollection *collection = [[MSCollection alloc] initWithData:data error:&jsonError];
        MSGraphMailFolder *mailFolder = [[MSGraphMailFolder alloc] initWithDictionary:[[collection value] objectAtIndex: 0] error:&nserror];

}];

[meDataTask execute];


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

MailFolderCollectionPage childFolders = graphClient.me().mailFolders("{id}").childFolders()
    .buildRequest()
    .get();


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

mailFolderId := "mailFolder-id"
result, err := graphClient.Me().MailFoldersById(&mailFolderId).ChildFolders().Get()


Import-Module Microsoft.Graph.Mail

# A UPN can also be used as -UserId.
Get-MgUserMailFolderChildFolder -UserId $userId -MailFolderId $mailFolderId

応答

以下に応答の例を示します。注: ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

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

{
  "value": [
    {
      "id": "id-value",
      "displayName": "displayName-value",
      "parentFolderId": "parentFolderId-value",
      "childFolderCount": 99,
      "unreadItemCount": 99,
      "totalItemCount": 99,
      "isHidden": false
    }
  ]
}

例 2: 指定したメールフォルダーの下に隠し子フォルダーを含める

次の例では、includeHiddenFolders クエリパラメーターを使用して、隠しメールフォルダーを含む指定されたメールフォルダーにある子フォルダーのリストを取得します。応答には、isHidden が true に設定された "低優先メール" フォルダーが含まれます。

要求