mailSearchFolder リソースの種類

名前空間: microsoft.graph

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

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

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

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

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

メソッド

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

プロパティ

プロパティ	種類	説明
filterQuery	String	メッセージをフィルター処理する OData クエリ。
includeNestedFolders	ブール型	検索でメールボックス フォルダー階層を走査する方法を示します。 true は、 sourceFolderIds で明示的に指定された各フォルダーの階層に子フォルダーを含めるために、ディープ検索を実行する必要があることを意味します。 falseは、sourceFolderIds で明示的に指定された各フォルダーの浅い検索のみを意味します。
Issupported	ブール型	検索フォルダーが REST API を使用して編集可能かどうかを示します。
sourceFolderIds	String collection	採掘するメールボックス フォルダー。

JSON 表記

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

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