次の方法で共有


mailSearchFolder を作成する

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

指定したユーザーのメールボックスに新しい mailSearchFolder を作成します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) Mail.ReadWrite 注意事項なし。
委任 (個人用 Microsoft アカウント) Mail.ReadWrite 注意事項なし。
アプリケーション Mail.ReadWrite 注意事項なし。

HTTP 要求

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

クエリ URL の親フォルダーをフォルダー ID または既知のフォルダー名として指定します。 サポートされている既知のフォルダー名の一覧については、「mailFolder リソースの種類」を参照してください。

要求ヘッダー

ヘッダー
Authorization Bearer {token}. 必須です。
Content-Type application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター 説明
@odata.type 文字列 作成するフォルダーの種類。 "microsoft.graph.mailSearchFolder" に設定します。
displayName String 新しいフォルダーの表示名です。
includeNestedFolders ブール値 検索でメールボックス フォルダー階層を走査する方法を示します。 true は、 sourceFolderIds で明示的に指定された各フォルダーの階層に子フォルダーを含めるために、ディープ検索を実行する必要があることを意味します。 false は、sourceFolderIds で明示的に指定された各フォルダーの浅い検索のみを意味します。
sourceFolderIds String collection 採掘するメールボックス フォルダー。
filterQuery 文字列 メッセージをフィルター処理する OData クエリ。

応答

成功した場合、このメソッドは応答コード 201 Created と、応答本文に mailSearchFolder オブジェクトを返します。

要求

要求の例を次に示します。件名に "週単位のダイジェスト" という文字列を含むメッセージの検索フォルダーを作成します。 検索フォルダーは、指定したフィルター クエリが適用されるのと同じフォルダーの下にあります。

POST https://graph.microsoft.com/beta/me/mailFolders/AQMkADYAAAIBDAAAAA==/childFolders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.mailSearchFolder",
  "displayName": "Weekly digests",
  "includeNestedFolders": true,
  "sourceFolderIds": ["AQMkADYAAAIBDAAAAA=="],
  "filterQuery": "contains(subject, 'weekly digest')"
}

応答

次の例は応答を示しています。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders('AQMkADYAAAIBDAAAAA%3D%3D')/childFolders/$entity",
    "@odata.type": "#microsoft.graph.mailSearchFolder",
    "id": "AAMkADYfRAAAZg1yTAAA=",
    "displayName": "Weekly digests",
    "parentFolderId": "AQMkADYAAAIBDAAAAA==",
    "childFolderCount": 0,
    "unreadItemCount": 0,
    "totalItemCount": 0,
    "wellKnownName": null,
    "isSupported": true,
    "includeNestedFolders": true,
    "sourceFolderIds": [
        "AQMkADYAAAIBDAAAAA=="
    ],
    "filterQuery": "contains(subject, 'weekly digest')"
}