获取用户的邮箱设置

更新用户邮箱的一个或多个设置。这包括自动答复(收到发件人的电子邮件时自动通知发件人)、区域设置或时区设置。

可以作为 mailboxSettings 的一部分启用、配置或禁用其中的一个或多个设置。

注意 不能创建或删除任何邮箱设置。

权限

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限

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

HTTP 请求

PATCH /me/mailboxSettings
PATCH /users/{id|userPrincipalName}/mailboxSettings

可选的查询参数

此方法支持 OData 查询参数 来帮助自定义响应。

请求标头

名称 类型 说明
Authorization string Bearer {token}。必需。

请求正文

在请求正文中,提供应更新的相关属性的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。以下是可写/可更新的属性:

属性 类型 说明
automaticRepliesSetting automaticRepliesSetting 自动通知发件人有传入电子邮件(包含一封来自已登录用户的邮件)的配置设置。
语言 localeInfo 用户的区域设置信息,包括首选语言和国家/地区。
timeZone string 用户邮箱的默认时区。

响应

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

示例

请求

以下示例通过设置 automaticRepliesSetting 属性的以下属性来启用对日期范围的自动答复:statusscheduledStartDateTimescheduledEndDateTime

PATCH https://graph.microsoft.com/api/v1.0/me/mailboxSettings
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/api/v1.0/$metadata#Me/mailboxSettings",
    "automaticRepliesSetting": {
        "status": "Scheduled",
        "scheduledStartDateTime": {
          "dateTime": "2016-03-20T18:00:00.0000000",
          "timeZone": "UTC"
        },
        "scheduledEndDateTime": {
          "dateTime": "2016-03-28T18:00:00.0000000",
          "timeZone": "UTC"
        }
    }
}
响应

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。

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

{
    "@odata.context": "https://graph.microsoft.com/api/v1.0/$metadata#Me/mailboxSettings",
    "automaticRepliesSetting": {
        "status": "scheduled",
        "externalAudience": "none",
        "scheduledStartDateTime": {
            "dateTime": "2016-03-20T02:00:00.0000000",
            "timeZone": "UTC"
        },
        "scheduledEndDateTime": {
            "dateTime": "2016-03-28T02:00:00.0000000",
            "timeZone": "UTC"
        },
    "internalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
    "externalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
    },
    "timeZone":"UTC",
    "language":{
      "locale":"en-US",
      "displayName":"English (United States)"
    }
}