Обновление параметров почтового ящика пользователя
Пространство имен: microsoft.graph
Включение, настройка или отключение одного или нескольких из следующих параметров в составе почтового ящика пользователяSettings:
- автоматические ответы (автоматическое уведомление пользователей при получении их почты);
- dateFormat
- delegateMeetingMessageDeliveryOptions
- языковой стандарт (язык и страну или регион);
- TimeFormat
- часовой пояс;
- рабочее время.
При обновлении предпочтительного формата даты или времени для пользователя укажите их соответственно в формате короткой даты или короткого времени .
При обновлении предпочтительного часового пояса для пользователя укажите его в формате часового пояса Windows или IANA (также известного как часовой пояс Олсона). Вы также можете дополнительно настроить часовой пояс, как показано в примере 2 ниже.
Совет
Невозможно создать или удалить параметры почтового ящика.
Этот API доступен в следующих национальных облачных развертываниях.
Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
---|---|---|
Делегированные (рабочая или учебная учетная запись) | MailboxSettings.ReadWrite | Недоступно. |
Делегированные (личная учетная запись Майкрософт) | MailboxSettings.ReadWrite | Недоступно. |
Приложение | MailboxSettings.ReadWrite | Недоступно. |
HTTP-запрос
PATCH /me/mailboxSettings
PATCH /users/{id|userPrincipalName}/mailboxSettings
Необязательные параметры запросов
Этот метод поддерживает параметры запросов OData для настройки ответа.
Заголовки запросов
Имя | Тип | Описание |
---|---|---|
Authorization | string | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
Текст запроса
В тексте запроса укажите значения для соответствующих свойств, которые необходимо обновить. Предыдущие значения существующих свойств, не включенных в текст запроса, останутся прежними или будут повторно вычислены с учетом измененных значений других свойств. Чтобы обеспечить максимальную производительность, не включайте существующие значения, которые не изменились, в запрос. Ниже перечислены свойства, значения которых можно записать или обновить.
Свойство | Тип | Описание |
---|---|---|
automaticRepliesSetting | automaticRepliesSetting | Параметры конфигурации для автоматического уведомления отправителя о входящем письме с помощью сообщения от пользователя, вошедшего в систему. Такие уведомления можно задать только для диапазона дат в будущем. |
dateFormat | string | Формат даты для почтового ящика пользователя. |
delegateMeetingMessageDeliveryOptions | delegateMeetingMessageDeliveryOptions | Если у пользователя есть делегат календаря, это указывает, будет ли делегат, владелец почтового ящика или оба получать сообщения о собрании и ответы на собрания. Возможные значения: sendToDelegateAndInformationToPrincipal , sendToDelegateAndPrincipal , sendToDelegateOnly . |
language | localeInfo | Сведения о языковом стандарте пользователя, в том числе о предпочитаемом языке и стране или регионе. |
TimeFormat | string | Формат времени для почтового ящика пользователя. |
timeZone | string | Часовой пояс, используемый по умолчанию, для почтового ящика пользователя. |
workingHours | workingHours | Часы, дни недели и часовой пояс работы пользователя. |
Отклик
В случае успешного выполнения этот метод возвращает код отклика 200 OK
и обновленные свойства объекта mailboxSettings в тексте отклика.
Ошибки
Если заданы недопустимые значения рабочего времени, могут возникать указанные ниже ошибки.
Сценарий | Код состояния HTTP | Код ошибки | Сообщение об ошибке |
---|---|---|---|
Недопустимое значение startTime или endTime | 400 | RequestBodyRead | Не удается преобразовать литерал "08" в ожидаемый тип Edm.TimeOfDay. |
Время начала больше времени окончания | 400 | ErrorInvalidTimeSettings | Время начало должно быть раньше, чем время окончания. |
Недопустимый день в свойстве daysOfWeek | 400 | InvalidArguments | Запрашиваемое значение RandomDay не найдено. |
Недопустимое значение timeZone | 400 | InvalidTimeZone | Указаны недопустимые параметры часового пояса. |
Примеры
Пример 1
Запрос
В первом примере показано, как включить автоматические ответы для диапазона дат, настроив для свойства automaticRepliesSetting следующие свойства: status, scheduledStartDateTime и scheduledEndDateTime.
PATCH https://graph.microsoft.com/v1.0/me/mailboxSettings
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/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/v1.0/$metadata#Me/mailboxSettings",
"automaticRepliesSetting": {
"status": "scheduled",
"externalAudience": "all",
"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"
}
}
Пример 2
Запрос
Во втором примере настраивается часовой пояс для рабочего времени вошедшего пользователя. Для этого в свойстве timeZone указывается пользовательский часовой пояс.
PATCH https://graph.microsoft.com/v1.0/me/mailboxSettings
Content-Type: application/json
{
"workingHours": {
"endTime" : "18:30:00.0000000",
"daysOfWeek": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"timeZone" : {
"@odata.type": "#microsoft.graph.customTimeZone",
"bias":-300,
"name": "Customized Time Zone",
"standardOffset":{
"time":"02:00:00.0000000",
"dayOccurrence":2,
"dayOfWeek":"Sunday",
"month":10,
"year":0
},
"daylightOffset":{
"daylightBias":100,
"time":"02:00:00.0000000",
"dayOccurrence":4,
"dayOfWeek":"Sunday",
"month":5,
"year":0
}
}
}
}
Отклик
Ниже показан пример отклика. Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users('94447c6e-ea4c-494c-a9ed-d905e366c5cb')/mailboxSettings",
"workingHours":{
"daysOfWeek":[
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
],
"startTime":"09:00:00.0000000",
"endTime":"18:30:00.0000000",
"timeZone":{
"@odata.type":"#microsoft.graph.customTimeZone",
"bias":-200,
"name":"Customized Time Zone",
"standardOffset":{
"time":"02:00:00.0000000",
"dayOccurrence":4,
"dayOfWeek":"sunday",
"month":5,
"year":0
},
"daylightOffset":{
"daylightBias":-100,
"time":"02:00:00.0000000",
"dayOccurrence":2,
"dayOfWeek":"sunday",
"month":10,
"year":0
}
}
}
}