Atualizar as configurações de caixa de correio do usuário
Namespace: microsoft.graph
Habilite, configure ou desabilite uma ou mais das seguintes configurações como parte das caixas de correio de um usuárioSettings:
- respostas automáticas (notificar pessoas automaticamente ao receber seus emails)
- Dateformat
- delegateMeetingMessageDeliveryOptions
- localidade (idioma e país/região)
- Timeformat
- fuso horário
- horário de trabalho
Ao atualizar o formato de data ou hora preferencial para um usuário, especifique-o, respectivamente, no formato de data curta ou de tempo curto .
Ao atualizar o fuso horário preferencial para um usuário, especifique-o no formato de fuso horário IANA (Windows ou Internet Assigned Numbers Authority) (também conhecido como fuso horário de Olson). Você também pode personalizar ainda mais o fuso horário, conforme mostrado no exemplo 2 abaixo.
Dica
Você não pode criar ou excluir nenhuma configuração de caixa de correio.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
Delegado (conta corporativa ou de estudante) | MailboxSettings.ReadWrite | Indisponível. |
Delegado (conta pessoal da Microsoft) | MailboxSettings.ReadWrite | Indisponível. |
Application | MailboxSettings.ReadWrite | Indisponível. |
Solicitação HTTP
PATCH /me/mailboxSettings
PATCH /users/{id|userPrincipalName}/mailboxSettings
Parâmetros de consulta opcionais
Este método dá suporte a Parâmetros de consulta OData para ajudar a personalizar a resposta.
Cabeçalhos de solicitação
Nome | Tipo | Descrição |
---|---|---|
Autorização | string | {token} de portador. Obrigatório. |
Corpo da solicitação
No corpo da solicitação, forneça os valores para as propriedades relevantes que devem ser atualizadas. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas alterações a outros valores de propriedade. Para obter o melhor desempenho, não inclua valores existentes que não foram alterados. Estas são as propriedades graváveis/atualizáveis:
Propriedade | Tipo | Descrição |
---|---|---|
automaticRepliesSetting | automaticRepliesSetting | Definições de configuração para notificar automaticamente o remetente de um email recebido com uma mensagem do usuário conectado. Você pode definir essas notificações para apenas um intervalo de datas futuro. |
Dateformat | string | O formato de data da caixa de correio do usuário. |
delegateMeetingMessageDeliveryOptions | delegateMeetingMessageDeliveryOptions | Se o usuário tiver um delegado de calendário, isso especifica se o delegado, o proprietário da caixa de correio ou ambos recebem mensagens de reunião e respostas de reunião. Os valores possíveis são: sendToDelegateAndInformationToPrincipal , sendToDelegateAndPrincipal , sendToDelegateOnly . |
idioma | localeInfo | Informações sobre a localidade do usuário, incluindo o idioma preferencial e o país/região. |
Timeformat | string | O formato de tempo para a caixa de correio do usuário. |
timeZone | string | O fuso horário padrão para a caixa de correio do usuário. |
workingHours | workingHours | As horas, os dias de uma semana e o fuso horário em que o usuário trabalha. |
Resposta
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e as propriedades atualizadas de um objeto mailboxSettings no corpo da resposta.
Erros
Definir horas de trabalho com valores inadequados pode retornar os seguintes erros.
Cenário | Código de status de HTTP | Código de erro | Mensagem de erro |
---|---|---|---|
startTime ou endTime inválido | 400 | RequestBodyRead | Não é possível converter o literal '08"para o tipo 'Edm.TimeOfDay' esperado. |
A hora de início é maior do que a hora de término | 400 | ErrorInvalidTimeSettings | A Hora de Início deve ocorrer antes da Hora de Término. |
Dia inválido em daysOfWeek | 400 | InvalidArguments | O valor solicitada "RandomDay" não foi encontrado. |
timeZone inválido | 400 | InvalidTimeZone | As configurações de Fuso Horário fornecidas são inválidas. |
Exemplos
Exemplo 1
Solicitação
O primeiro exemplo habilita as respostas automáticas de um intervalo de datas, definindo as seguintes propriedades da propriedade automaticRepliesSetting: status, scheduledStartDateTime e 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"
}
}
}
Resposta
A resposta inclui apenas as configurações atualizadas de respostas automáticas. Observação: O objeto de resposta exibido aqui pode ser encurtado para legibilidade.
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"
}
}
Exemplo 2
Solicitação
O segundo exemplo personaliza o fuso horário das horas de trabalho do usuário conectado definindo a propriedade timeZone para um fuso horário personalizado.
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
}
}
}
}
Resposta
O exemplo a seguir mostra a resposta. Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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
}
}
}
}
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários