mailboxFolder 资源类型

命名空间:microsoft.graph

重要

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

表示用户邮箱中的文件夹,例如收件箱、草稿或其他用户创建的文件夹。 文件夹可以包含各种邮箱项目,例如邮件、事件、联系人、其他 Outlook 项目和子文件夹。

此资源通过提供 delta 函数支持增量查询来跟踪增量添加、删除和更新。 它还支持单值和多值扩展属性,用于存储和访问Microsoft图形 API元数据中尚未公开的自定义数据。

方法

方法 返回类型 Description
List mailboxFolder 集合 获取指定 邮箱中的所有 mailboxFolder 对象,包括任何搜索文件夹。
创建 mailboxFolder 在用户的邮箱中创建新的 mailboxFolder 或子 mailboxFolder
Get mailboxFolder 读取 mailboxFolder 对象的属性和关系。
更新 mailboxFolder 更新 mailboxFolder 属性,例如邮箱中的 displayName
删除 None 删除 邮箱中的 mailboxFolder 或子 mailboxFolder
获取增量 mailboxFolder 集合 获取一组 mailboxFolder 对象,这些对象已从用户的邮箱中添加、删除或删除。
列出子邮箱文件夹 mailboxFolder 集合 获取邮箱中指定 mailboxFolder 下的 mailboxFolder 集合。
列出文件夹中的项目 mailboxItem 集合 获取邮箱中指定 mailboxFolder 中的 mailboxItem 集合。
扩展属性
创建单值属性 mailboxFolder 在新的或现有的邮箱文件夹中创建一个或多个单值扩展属性。
获取单值属性 mailboxFolder 使用 $expand$filter获取包含单值扩展属性的邮箱文件夹。
创建多值属性 mailboxFolder 在新的或现有的邮箱文件夹中创建一个或多个多值扩展属性。
获取多值属性 mailboxFolder 使用 $expand获取包含多值扩展属性的邮箱文件夹。

属性

属性 类型 说明
childFolderCount Int32 当前文件夹中的直接子文件夹数。
displayName String 文件夹的显示名称。
id String 文件夹的唯一标识符。
parentFolderId String 此文件夹的父文件夹的唯一标识符。
parentMailboxUrl String 指向文件夹物理驻留的实际基础邮箱的路由链接。 可以使用 访问 GET {parentMailboxUrl}/folders/{id}文件夹,它将整个 URL 视为不透明的字符串。

为用户的就地存档邮箱启用自动扩展存档时,此方法尤其重要。 在这种情况下,用户的存档内容可以跨越多个邮箱。
totalItemCount Int32 文件夹中的项目数。
type String 描述文件夹类类型。

关系

关系 类型 说明
childFolders mailboxFolder 集合 此文件夹中子文件夹的集合。
items mailboxItem 集合 此文件夹中的项目集合。
multiValueExtendedProperties multiValueLegacyExtendedProperty 集合 mailboxFolder 定义的多值扩展属性的集合。
singleValueExtendedProperties singleValueLegacyExtendedProperty collection mailboxFolder 定义的单值扩展属性的集合。

JSON 表示形式

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

{
  "@odata.type": "#microsoft.graph.mailboxFolder",
  "displayName": "String",
  "childFolderCount": "Int32",
  "id": "String (identifier)",
  "parentFolderId": "String",
  "parentMailboxUrl": "String",
  "totalItemCount": "Int32",
  "type": "String"
}