mailFolder 资源类型

  • 项目

命名空间：microsoft.graph

重要

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

用户邮箱中的邮箱文件夹，例如收件箱和草稿箱。 邮箱文件夹可以包含邮件、其他 Outlook 项和子邮件文件夹。

该资源支持通过提供 delta 函数使用增量查询跟踪增量添加、删除和更新。

已知文件夹名称

Outlook 默认情况下会为用户创建某些文件夹。 为方便起见，可以在访问这些文件夹时使用已知的文件夹名称来替代使用相应的文件夹 id 值。 例如，你可以使用其已知名称和以下查询来获取“草稿”文件夹。

GET /me/mailFolders/drafts

无论用户邮箱的区域设置如何，已知名称都可用，因此，无论其命名方式如何，上述查询都将始终返回用户的 Drafts 文件夹。

已知文件夹名称 说明
archive 在支持它的 Outlook 客户端中使用 One_Click 存档功能时，将发送存档文件夹邮件。 注意： 这与 Exchange Online 的存档邮箱功能不同。
clutter 使用待筛选邮件功能时，待筛选文件夹低优先级邮件将被移动到这里。
conflicts 包含邮箱中冲突项的文件夹。
conversationhistory Skype 保存 IM 对话的文件夹（如果 Skype 配置为这样做）。
deleteditems 文件夹项被删除时，将被移动到这里。
drafts 包含未发送邮件的文件夹。
inbox 收件箱文件夹。
junkemail “垃圾邮件”文件夹。
localfailures 包含本地客户端上存在但无法上传到服务器的项目的文件夹。
msgfolderroot “最上层的信息文件”文件夹。 此文件夹是在普通邮件客户端（如收件箱）中显示的文件夹的父文件夹。
outbox “发件箱”文件夹。
recoverableitemsdeletions 包含软删除项的文件夹：从“已删除邮件”文件夹中删除，或者在 Outlook 中按 shift+delete 删除。 此文件夹在任何 Outlook 电子邮件客户端中均不可见，但最终用户可以通过 Outlook 或 Outlook 网页版中的“从服务器恢复已删除邮件”功能与其交互。
scheduled 包含计划使用 Outlook for iOS 中的“计划”功能重新出现在收件箱中的邮件的文件夹。
searchfolders 用户邮箱中定义的所有搜索文件夹的父文件夹。
sentitems 已发送项的文件夹。
serverfailures 包含服务器上存在但无法同步到本地客户端的项目的文件夹。
syncissues 包含 Outlook 创建的同步日志的文件夹。

方法

方法 返回类型 说明
List mailFolders mailFolder 集合 获取指定用户的邮箱内的所有邮件文件夹，包括所有邮件搜索文件夹。
获取 mailFolder mailFolder 读取 mailFolder 对象的属性和关系。
Create mailFolder mailFolder 在用户邮箱的根文件夹中新建邮件文件夹。
列出 childFolder mailFolder 集合 获取指定文件夹下的文件夹集合。 你可以使用 .../me/MailFolders 快捷方式获取顶级文件夹集合并导航到其他文件夹。
创建 childFolder mailFolder 通过发布到 childFolder 集合，在当前 mailFolder 下新建 mailFolder。
创建邮件 邮件 通过发布到邮件集合，在当前 mailFolder 中新建邮件。
列出邮件 message 集合 获取已登录用户邮箱中的所有邮件或邮箱的指定文件夹中的邮件。
更新 mailFolder 更新指定的 mailFolder 对象。
删除 无 删除指定的 mailFolder 对象。
复制 mailFolder 将 mailfolder 及其内容复制到其他 mailfolder。
delta mailFolder 集合 获取用户邮箱中已添加、删除或移除的邮件文件夹集。
移动 mailFolder 将 mailFolder 及其内容移动到其他 mailFolder。
扩展属性
创建单值扩展属性 mailFolder 在新建或现有的 mailFolder 中创建一个或多个单值扩展属性。
获取具有单值扩展属性的 mailFolder mailFolder 通过使用 $expand 或 $filter 获取包含一个单值扩展属性的 mailFolder。
创建多值扩展属性 mailFolder 在新建或现有的 mailFolder 中创建一个或多个多值扩展属性。
获取具有多值扩展属性的 mailFolder mailFolder 使用 $expand 获取包含一个多值扩展属性的 mailFolder。

属性

属性 类型 说明
childFolderCount Int32 当前 mailFolder 中的直接子 mailFolder 数量。
displayName String mailFolder 的显示名称。
id String MailFolder 的唯一标识符。
IsHidden 布尔值 指示 mailFolder 是否处于隐藏状态。 此属性只能在创建文件夹时设置。 请在隐藏的邮件文件夹中获取更多信息。
parentFolderId String MailFolder 的父 mailFolder 的唯一标识符。
totalItemCount Int32 邮箱中项的数量
unreadItemCount Int32 mailFolder 中标记为未读的项的数量。
wellKnownName 字符串 文件夹的已知文件夹名称。 上面列出了可能的值。 此属性仅为 Outlook 创建的默认文件夹设置。 对于其他文件夹，此属性为 null。

有效的访问项计数

使用文件夹的 TotalItemCount 和 UnreadItemCount 的属性可以方便地计算在文件夹中读取的项数。 使你避免进行可产生重大延迟的查询，如下所示：

https://outlook.office.com/api/beta/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false

Outlook 中的邮件文件夹可以包含多种类型的项目，例如，“收件箱”可以包含与邮件项目不同的会议请求项目。 TotalItemCount 和 UnreadItemCount包括邮件文件夹中的项，无论其项类型如何。

隐藏的邮件文件夹

isHidden 属性的默认值为 false。 仅当创建 mailFolder时可以设置 isHidden。 无法使用 PATCH 操作更新 属性。 若要更改 isHidden 属性，请删除现有文件夹，然后使用希望的值，新建一个文件夹。

隐藏邮件文件夹支持常规邮件文件夹支持的所有操作。

默认情况下， 列出 mailFolders 仅返回未隐藏的邮件文件夹。 若要在答复中包括隐藏的邮件文件夹，请使用查询参数 includeHiddenFolders=true。 然后使用 isHidden 属性来识别邮件文件夹是否处于隐藏状态。

关系

关系 类型 说明
childFolders MailFolder 集合 mailFolder 中的子文件夹集合。
messageRules messageRule 集合 适用于用户“收件箱”文件夹的规则集合。
messages 邮件 集合 mailFolder 中的邮件集合。
multiValueExtendedProperties multiValueLegacyExtendedProperty 集合 为 mailFolder 定义的多值扩展属性的集合。 只读。 可为 Null。
singleValueExtendedProperties singleValueLegacyExtendedProperty collection 为 mailFolder 定义的单值扩展属性的集合。 只读。 可为 Null。

JSON 表示形式

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

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "wellKnownName": "string",
  "isHidden": false,
  "childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
  "messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
  "messages": [ { "@odata.type": "microsoft.graph.message" } ],
  "multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
  "singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}

相关内容