mailSearchFolder 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

mailSearchFolder 是用户邮箱中的虚拟文件夹，其中包含符合指定搜索条件的所有电子邮件项目。 mailSearchFolder 继承自 mailFolder。 可以在用户的 Exchange Online 邮箱的任何文件夹中创建搜索文件夹。 但是，若要在 Outlook、Outlook 网页或 Outlook Live 中显示搜索文件夹，必须在 WellKnownFolderName.SearchFolders 文件夹中创建该文件夹。

搜索文件夹生命周期

Exchange Online 可以删除由应用程序创建的搜索文件夹，原因如下：

1. 搜索文件夹在 45 天未使用后过期。
2. 每个源文件夹可创建的搜索文件夹数量有一些限制。 如果超过此限制，将删除较旧的搜索文件夹，为新的搜索文件夹提供途径。

删除搜索文件夹后，应用应创建新的搜索文件夹资源，并使用相同的资源。

方法

方法	返回类型	说明
创建搜索文件夹	mailSearchFolder	在此用户的邮箱中创建搜索文件夹。
列出搜索文件夹	mailFolder 集合	列出此用户邮箱中所有文件夹，包括搜索文件夹。
获取搜索文件夹	mailSearchFolder	获取指定的搜索文件夹。
更新搜索文件夹	mailSearchFolder	更新指定的搜索文件夹。
删除搜索文件夹	无	删除指定的搜索文件夹。
列出搜索文件夹中的所有邮件	message 集合	列出指定搜索文件夹中的所有邮件。

属性

属性	类型	说明
isSupported	Boolean	指示搜索文件夹是否可以使用 REST API 进行编辑。
includeNestedFolders	Boolean	指示如何在搜索中遍历邮箱文件夹层次结构。 true 意味着应执行深入搜索，以在 sourceFolderIds 中显式指定的每个文件夹的层次结构中包括子文件夹。 false 表示仅对 sourceFolderIds 中显式指定的每个文件夹进行浅表搜索。
sourceFolderIds	字符串集合	应缩小的邮箱文件夹。
filterQuery	字符串	用于筛选邮件的 OData 查询。

JSON 表示形式

下面是资源的 JSON 表示形式。

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