mailSearchFolder 资源类型

命名空间:microsoft.graph

重要

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

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

搜索文件夹生命周期

Exchange Online 可能会出于以下原因之一删除应用程序创建的搜索文件夹:

  1. 搜索文件夹在 45 天未使用后过期。
  2. 每个源文件夹可以创建的搜索文件夹数有限制。 如果违反此限制,则会删除较旧的搜索文件夹,以便为新搜索文件夹让路。

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

方法

方法 返回类型 说明
创建 mailSearchFolder 在此用户的邮箱中创建搜索文件夹。
Get mailSearchFolder 获取指定的搜索文件夹。
更新 mailSearchFolder 更新指定的搜索文件夹。
删除 None 删除指定的搜索文件夹。
永久删除 None 永久删除邮件搜索文件夹,并从用户邮箱中删除其项目。
列出子文件夹 mailFolder 集合 列出此用户邮箱中的所有文件夹,包括搜索文件夹。
列出文件夹中的邮件 message 集合 列出指定搜索文件夹中的所有邮件。

属性

属性 类型 说明
isSupported 布尔值 指示是否可使用 REST API 编辑搜索文件夹。
includeNestedFolders 布尔值 指示在搜索中应如何遍历邮箱文件夹层次结构。 true 意味着应进行深度搜索,以将子文件夹包含在 sourceFolderIds 中显式指定的每个文件夹的层次结构中。 false 表示仅对 sourceFolderIds 中显式指定的每个文件夹进行浅表搜索。
sourceFolderIds 字符串集合 应挖掘的邮箱文件夹。
filterQuery String 用于筛选消息的 OData 查询。

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

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