mailSearchFolder リソースの種類

名前空間: microsoft.graph

重要

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

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

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

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

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

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

メソッド

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

プロパティ

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

JSON 表記

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

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