通过

mailboxFolder： delta

  • 项目

命名空间：microsoft.graph

重要

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

获取一组 mailboxFolder 对象，这些对象已从用户的邮箱中添加、删除或删除。

邮箱中文件夹的 delta 函数调用类似于 GET 请求，不同之处在于，通过在一个或多个调用中适当应用 状态令牌 ，可以查询文件夹中的增量更改。 此方法允许维护和同步用户邮件文件夹的本地存储，而无需每次从服务器提取该邮箱的所有文件夹。

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时，才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息，请参阅权限类型。 要了解有关这些权限的详细信息，请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派（工作或学校帐户） MailboxFolder.Read MailboxFolder.ReadWrite
委派（个人 Microsoft 帐户） 不支持。 不支持。
应用程序 MailboxFolder.Read.All MailboxFolder.ReadWrite.All

HTTP 请求

GET /admin/exchange/mailboxes/{mailboxId}/folders/delta
GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/childFolders/delta

查询参数

跟踪文件夹中的更改会产生一轮或多次 delta 函数调用。 如果要使用任意查询参数（$deltaToken 和 $skipToken 除外），则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 nextLink 或 deltaLink URL 的令牌部分。 只需预先指定所需的任何查询参数一次。 在后续请求中，只需复制并应用 nextLink 上一响应中的 或 deltaLink URL，因为该 URL 已包含编码的所需参数。

查询参数 说明
$deltaToken 在上一个 delta 函数的 URL 中deltaLink返回的状态令牌调用同一文件夹集合，指示完成这一轮更改跟踪。 将此令牌包含在对该集合的下一组更改追踪的首次请求中，并保存和应用整个 deltaLink URL。
$skipToken 在上一个 delta 函数调用的 URL 中nextLink返回的状态令牌，指示可以在同一文件夹集合中跟踪进一步的更改。

OData 查询参数

可以使用 $select 查询参数仅指定所需的属性来获得最佳性能。 始终返回 ID 和 parentMailboxUrl 属性。

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Prefer odata.maxpagesize={x}。 可选。

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此函数在 200 OK 响应正文中返回响应代码和 mailboxFolder 对象的集合。

示例

请求

以下示例演示如何进行单个 delta 函数调用，并将响应正文中文件夹的最大数目限制为 2。

若要跟踪邮箱文件夹中的更改，请使用适当的状态令牌进行一个或多个 delta 函数调用，以获取自上次增量查询以来的增量更改集。

有关演示如何使用状态令牌跟踪文件夹项目更改的类似示例，请参阅 获取对文件夹中邮件的增量更改。 跟踪文件夹和文件夹中跟踪项之间的main差异在于增量查询请求 URL 以及返回文件夹而不是项集合的查询响应。

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/delta
Prefer: odata.maxpagesize=2

响应

如果请求成功，响应将包括状态令牌，该令牌可以是 $skipToken@odata.nextLink 响应标头) 中的 (，或者$deltaToken@odata.deltaLink 响应标头) 中的 (。 它们分别指示是应继续执行回合还是完成获取该回合的所有更改。

以下示例显示了 $deltaToken@odata.deltaLink 响应标头中的 。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 254

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(mailboxFolder)",
    "@odata.deltaLink": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/delta?$deltatoken={_deltaToken_}",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "displayName": "Inbound",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/Exchange/Mailboxes/MBX:e0643f21@a7809c93",
            "id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP9AAA="
        },
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "displayName": "Outbound",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/Exchange/Mailboxes/MBX:e0643f21@a7809c93",
            "id": "AAMkAGUwNjQ4ZjIxLTQ3Y2YtNDViMi1iZjc4LTMzNjMwNWM0ZGE2YQAuAAAAAADbrwBIJbBSTKolRbhHUzSHAQCQ2fKdhq8oSKEDSVrdi3lRAAACgfP_AAA="
        }
    ]
}

相关内容