mailSearchFolder リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
mailSearchFolder は、指定した検索条件に一致するすべてのメール アイテムを含む、ユーザーのメールボックス内の仮想フォルダーです。 mailSearchFolder は mailFolder から継承します。 検索フォルダーは、ユーザーの Exchange Online メールボックス内の任意のフォルダーに作成できます。 ただし、Outlook、Outlook for the web、または Outlook Live に検索フォルダーを表示するには、 フォルダーを WellKnownFolderName.SearchFolders フォルダーに作成する必要があります。
検索フォルダーのライフサイクル
Exchange Online では、次のいずれかの理由で、アプリケーションによって作成された検索フォルダーを削除できます。
- 検索フォルダーは、45 日間使用しなかった後に有効期限が切れます。
- ソース フォルダーごとに作成できる検索フォルダーの数には制限があります。 この制限に違反すると、古い検索フォルダーが削除され、新しい検索フォルダーが作成されます。
検索フォルダーが削除されると、アプリで新しい検索フォルダー リソースを作成し、同じリソースを使用する必要があります。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| Create | mailSearchFolder | このユーザーのメールボックスに検索フォルダーを作成します。 |
| Get | mailSearchFolder | 指定した検索フォルダーを取得します。 |
| Update | mailSearchFolder | 指定した検索フォルダーを更新します。 |
| Delete | なし | 指定した検索フォルダーを削除します。 |
| 完全に削除 | なし | メール検索フォルダーを完全に削除し、そのアイテムをユーザーのメールボックスから削除します。 |
| 子フォルダーを一覧表示する | mailFolder コレクション | 検索フォルダーを含め、このユーザーのメールボックス内のすべてのフォルダーを一覧表示します。 |
| フォルダー内のメッセージを一覧表示する | message コレクション | 指定した検索フォルダー内のすべてのメッセージを一覧表示します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| isSupported | ブール型 | 検索フォルダーが REST API を使用して編集可能かどうかを示します。 |
| includeNestedFolders | ブール型 | 検索でメールボックス フォルダー階層を走査する方法を示します。
true は、 sourceFolderIds で明示的に指定された各フォルダーの階層に子フォルダーを含めるために、ディープ検索を実行する必要があることを意味します。
false
は、sourceFolderIds で明示的に指定された各フォルダーの浅い検索のみを意味します。 |
| sourceFolderIds | String collection | 採掘するメールボックス フォルダー。 |
| filterQuery | String | メッセージをフィルター処理する OData クエリ。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": ["string"],
"filterQuery": "string"
}