mailSearchFolder リソースの種類

名前空間: microsoft.graph

mailSearchFolder は、指定された検索条件に一致するすべての電子メール アイテムを含むユーザーのメールボックス内の仮想フォルダーです。 mailSearchFolder は mailFolder から継承します。 検索フォルダーは、ユーザーのメールボックス内の任意のフォルダー Exchange Onlineできます。 ただし、Outlook、Outlook for the web、または Outlook Live に検索フォルダーを表示するには、そのフォルダーを WellKnownFolderName.SearchFolders フォルダーに作成する必要があります。

検索フォルダーのライフサイクル

アプリケーションによって作成された検索フォルダーは、次のいずれかの理由Exchange Onlineによって削除できます。

  1. 検索フォルダーの有効期限は、使用が 45 日経過した後です。
  2. ソース フォルダーごとに作成できる検索フォルダーの数には制限があります。 この制限に違反すると、古い検索フォルダーが削除され、新しい検索フォルダーが削除されます。

検索フォルダーが削除された場合、アプリは新しい検索フォルダー リソースを作成し、同じリソースを使用する必要があります。

メソッド

メソッド 戻り値の型 説明
検索フォルダーを作成する mailSearchFolder このユーザーのメールボックスに検索フォルダーを作成します。
検索フォルダーの一覧 mailFolder コレクション 検索フォルダーを含む、このユーザーのメールボックス内のすべてのフォルダーを一覧表示します。
検索フォルダ―を取得する mailSearchFolder 指定した検索フォルダーを取得します。
検索フォルダーを更新する mailSearchFolder 指定した検索フォルダーを更新します。
検索フォルダーを削除する None 指定した検索フォルダーを削除します。
検索フォルダー内のすべてのメッセージを一覧表示する message コレクション 指定した検索フォルダー内のすべてのメッセージを一覧表示します。

プロパティ

プロパティ 説明
isSupported Boolean REST API を使用して検索フォルダーを編集できるかどうかを示します。
includeNestedFolders Boolean メールボックス フォルダー階層を検索で走査する方法を示します。 true つまり、sourceFolderIds で明示的に指定された各フォルダーの階層に子フォルダーを含めるには、詳細な 検索を行う必要がありますfalsesourceFolderIds で明示的に指定された各フォルダーのみを浅く検索することを意味します。
sourceFolderIds String collection マイニングする必要があるメールボックス フォルダー。
filterQuery String メッセージをフィルター処理する OData クエリ。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "isSupported": true,
  "includeNestedFolders": true,
  "sourceFolderIds": ["string"],
  "filterQuery": "string"
}