mailSearchFolder リソースの種類mailSearchFolder resource type

名前空間: microsoft.graphNamespace: microsoft.graph

Mailsearchfolderは、指定した検索条件に一致するすべての電子メールアイテムを含む、ユーザーのメールボックス内の仮想フォルダーです。A mailSearchFolder is a virtual folder in the user's mailbox that contains all the email items matching specified search criteria. Mailsearchfoldermailfolderから継承します。mailSearchFolder inherits from mailFolder. 検索フォルダーは、ユーザーの Exchange Online メールボックス内の任意のフォルダーに作成できます。Search folders can be created in any folder in a user's Exchange Online mailbox. ただし、検索フォルダーが Outlook、web 用の Outlook、または Outlook Live に表示されるようにするには、 WellKnownFolderName フォルダー内にフォルダーを作成する必要があります。However, for a search folder to appear in Outlook, Outlook for the web, or Outlook Live, the folder must be created in the WellKnownFolderName.SearchFolders folder.

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

アプリケーションによって作成された検索フォルダーは、次のいずれかの理由により、Exchange Online で削除できます。Search folders created by your application can be deleted by Exchange Online for one of the following reasons:

  1. 検索フォルダーは利用できなくなってから45日後に有効期限が切れます。Search folders expire after 45 days of no usage.
  2. ソースフォルダーごとに作成できる検索フォルダーの数には制限があります。There are limits on the number of search folders that can be created per source folder. この制限が侵害された場合は、古い検索フォルダーが削除され、新しいフォルダーを使用できるようになります。When this limit is breached, older search folders are deleted to make way for new ones.

検索フォルダーが削除されると、アプリは新しい検索フォルダーリソースを作成して同じものを使用する必要があります。When a search folder is deleted, your app should create a new search folder resource and use the same.

メソッドMethods

メソッドMethod 戻り値の型Return Type 説明Description
検索フォルダーを作成するCreate a search folder mailSearchFoldermailSearchFolder このユーザーのメールボックスに検索フォルダーを作成します。Create a search folder in this user's mailbox.
検索フォルダーを一覧表示するList search folders mailFolder コレクションmailFolder collection このユーザーのメールボックス内のすべてのフォルダー (検索フォルダーを含む) を一覧表示します。List all the folders in this user's mailbox, including search folders.
検索フォルダ―を取得するGet a search folder mailSearchFoldermailSearchFolder 指定した検索フォルダーを取得します。Get the specified search folder.
検索フォルダーを更新するUpdate a search folder mailSearchFoldermailSearchFolder 指定した検索フォルダーを更新します。Update the specified search folder.
検索フォルダーを削除するDelete a search folder なしNone 指定した検索フォルダーを削除します。Delete the specified search folder.
検索フォルダー内のすべてのメッセージを一覧表示するList all messages in a search folder message コレクションmessage collection 指定した検索フォルダー内のすべてのメッセージを一覧表示します。List all the messages in the specified search folder.

プロパティProperties

プロパティProperty 種類Type 説明Description
isSupportedisSupported ブール型Boolean 検索フォルダーが REST Api を使用して編集可能かどうかを示します。Indicates whether a search folder is editable using REST APIs.
includeNestedFoldersincludeNestedFolders ブール型Boolean 検索でメールボックスフォルダー階層をスキャンする方法を示します。Indicates how the mailbox folder hierarchy should be traversed in the search. truesourceFolderIdsで明示的に指定された各フォルダーの階層内に子フォルダーを含めるには、詳細検索を実行する必要があることを意味します。true means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. false は、 sourceFolderIdsで明示的に指定された各フォルダーの浅い検索を意味します。false means a shallow search of only each of the folders explicitly specified in sourceFolderIds.
sourceFolderIdssourceFolderIds String collectionString collection マイニングするメールボックスフォルダー。The mailbox folders that should be mined.
filterQueryfilterQuery 文字列String メッセージをフィルター処理するための OData クエリ。The OData query to filter the messages.

JSON 表記JSON representation

リソースの JSON 表記を次に示します。The following is a JSON representation of the resource.

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