更新规则

命名空间:microsoft.graph

messageRule 对象更改可写属性并保存更改。

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

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

权限

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

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) MailboxSettings.ReadWrite 不可用。
委派(个人 Microsoft 帐户) MailboxSettings.ReadWrite 不可用。
应用程序 MailboxSettings.ReadWrite 不可用。

HTTP 请求

PATCH /me/mailFolders/inbox/messageRules/{id}
PATCH /users/{id | userPrincipalName}/mailFolders/inbox/messageRules/{id}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json. 必需。

请求正文

在请求正文中,提供应更新的相关字段的值。 请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。 为了实现最佳性能,不得添加未变化的现有值。

属性 类型 说明
actions messageRuleActions 满足相应条件时对邮件执行的操作。
conditions messageRulePredicates 满足条件时,将触发该规则的相应操作。
displayName String 规则的显示名称。
exceptions messageRulePredicates 规则的例外情况。
isEnabled Boolean 指示是否启用规则以应用到邮件。
isReadOnly Boolean 表示规则是否为只读且无法由规则 REST API 修改或删除。
Sequence Int32 表示在其他规则中执行规则的顺序。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和更新的 messageRule 对象。

示例

请求

下面的示例更改规则名称,并更改针对获取规则示例中的规则所采取的操作,从转发到一个地址到将其重要性标记为“高”。

PATCH https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messageRules/AQAAAJ5dZqA=
Content-type: application/json

{
    "displayName": "Important from partner",
    "actions": {
        "markImportance": "high"
     }
}
响应

以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#Me/mailFolders('inbox')/messageRules/$entity",
  "id":"AQAAAJ5dZqA=",
  "displayName":"Important from partner",
  "sequence":2,
  "isEnabled":true,
  "hasError":false,
  "isReadOnly":false,
  "conditions":{
    "senderContains":[
      "ADELE"
    ]
  },
  "actions":{
    "markImportance": "high"
  }
}