Obter as configurações da caixa de correio do usuário
Namespace: microsoft.graph
Obtenha as mailboxSettings do usuário. Você pode exibir todas as configurações de caixa de correio ou obter configurações específicas.
Os usuários podem definir as configurações a seguir para suas caixas de correio por meio de um cliente do Outlook:
- respostas automáticas (notificar pessoas automaticamente ao receber seus emails)
- formato de data
- delegateMeetingMessageDeliveryOptions
- localidade (idioma e país/região)
- formato de hora
- fuso horário
- horário de trabalho
- finalidade do usuário
Os usuários podem definir os formatos de data e hora preferidos usando o Outlook na Web. Os usuários podem escolher um dos formatos de data abreviada ou de tempo abreviado com suporte. Essa operação GET
retorna o formato escolhido pelo usuário.
Os usuários podem definir o fuso horário preferido em qualquer cliente do Outlook, escolhendo entre os fusos horários com suporte que o administrador configurou para o servidor da caixa de correio. O administrador pode configurar fusos horários no formato de fuso horário do Windows ou fuso horário IANA (Autoridade de Números Atribuídos à Internet) (também conhecido como fuso horário de Olson). O formato do Windows é o padrão.
Essa operação GET
retorna o fuso horário preferido do usuário no formato configurado pelo administrador. Se quiser que o fuso horário esteja em um formato específico (Windows ou IANA), você pode primeiro atualizar o fuso horário de preferência nesse formato como uma configuração de caixa de correio. Posteriormente, você poderá obter o fuso horário nesse formato. Como alternativa, você pode gerenciar a conversão de formato separadamente no seu aplicativo.
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.Read | MailboxSettings.ReadWrite |
Delegado (conta pessoal da Microsoft) | MailboxSettings.Read | MailboxSettings.ReadWrite |
Aplicativo | MailboxSettings.Read | MailboxSettings.ReadWrite |
Solicitação HTTP
Para obter todas as configurações de caixa de correio de um usuário:
GET /me/mailboxSettings
GET /users/{id|userPrincipalName}/mailboxSettings
Para obter configurações específicas - apenas as configurações automáticas de respostas, formato de data, localidade, formato de horário, fuso horário, horário de trabalho ou o destinatário ou tipo de caixa de correio do usuário (por exemplo, finalidade do usuário):
GET /me/mailboxSettings/automaticRepliesSetting
GET /users/{id|userPrincipalName}/mailboxSettings/automaticRepliesSetting
GET /me/mailboxSettings/dateFormat
GET /users/{id|userPrincipalName}/mailboxSettings/dateFormat
GET /me/mailboxSettings/delegateMeetingMessageDeliveryOptions
GET /users/{id|userPrincipalName}/mailboxSettings/delegateMeetingMessageDeliveryOptions
GET /me/mailboxSettings/language
GET /users/{id|userPrincipalName}/mailboxSettings/language
GET /me/mailboxSettings/timeFormat
GET /users/{id|userPrincipalName}/mailboxSettings/timeFormat
GET /me/mailboxSettings/timeZone
GET /users/{id|userPrincipalName}/mailboxSettings/timeZone
GET /me/mailboxSettings/workingHours
GET /users/{id|userPrincipalName}/mailboxSettings/workingHours
GET /me/mailboxSettings/userPurpose
GET /users/{id|userPrincipalName}/mailboxSettings/userPurpose
Parâmetros de consulta opcionais
Este método também dá suporte a alguns 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
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, este método retornará um código de resposta 200 OK
e um dos seguintes objetos solicitados no corpo da resposta:
- Objeto mailboxSettings
- Objeto automaticRepliesSetting
- cadeia de caracteres (para dateFormat)
- cadeia de caracteres (para delegateMeetingMessageDeliveryOptions)
- Objeto localeInfo
- cadeia de caracteres (para timeFormat)
- cadeia de caracteres (para timeZone)
- workingHours
- userPurpose
Exemplos
Exemplo 1: Obter todas as configurações de caixa de correio da caixa de correio do usuário conectado
Obtenha todas as configurações de caixa de correio da caixa de correio do usuário conectado que incluem configurações para respostas automáticas, formato de data, localidade (idioma e país/região), formato de horário, fuso horário, horas de trabalho e finalidade do usuário.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/v1.0/me/mailboxSettings
Resposta
A seguir está um exemplo da resposta que inclui todas as configurações de caixa de correio do usuário conectado.
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#Me/mailboxSettings",
"automaticRepliesSetting": {
"status": "Scheduled",
"externalAudience": "All",
"scheduledStartDateTime": {
"dateTime": "2016-03-14T07:00:00.0000000",
"timeZone": "UTC"
},
"scheduledEndDateTime": {
"dateTime": "2016-03-28T07: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)"
},
"workingHours":{
"daysOfWeek":[
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"startTime": "08:00:00.0000000",
"endTime": "17:00:00.0000000",
"timeZone":{
"name":"Pacific Standard Time"
}
},
"userPurpose": {
"value": "user"
},
"dateFormat": "MM/dd/yyyy",
"timeFormat": "hh:mm tt",
"delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly"
}
Exemplo 2: obter especificamente as configurações de respostas automáticas da caixa de correio do usuário conectado
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/v1.0/me/mailboxSettings/automaticRepliesSetting
Resposta
A seguir está um exemplo da resposta que inclui apenas as configurações de respostas automáticas.
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#Me/mailboxSettings/automaticRepliesSetting",
"status": "alwaysEnabled",
"externalAudience": "None",
"scheduledStartDateTime": {
"dateTime": "2016-03-19T02:00:00.0000000",
"timeZone": "UTC"
},
"scheduledEndDateTime": {
"dateTime": "2016-03-20T02: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 3: obter especificamente as configurações de hora de trabalho da caixa de correio do usuário conectado
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/v1.0/me/mailboxSettings/workingHours
Resposta
A seguir está um exemplo da resposta que inclui apenas as configurações de horas de trabalho. As horas de trabalho do usuário estão em um fuso horário personalizado.
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
}
}
}
Exemplo 4: obter especificamente as configurações de uso do usuário da caixa de correio do usuário conectado
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/v1.0/me/mailboxSettings/userPurpose
Resposta
A seguir está um exemplo da resposta que inclui apenas as configurações de finalidade do usuário .
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('622eaaff-0683-4862-9de4-f2ec83c2bd98')/mailboxSettings/userPurpose",
"value": "user"
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: ao longo de 2024, vamos eliminar problemas do GitHub como o mecanismo de comentários para conteúdo e substituí-lo por um novo sistema de comentários. Para obter mais informações, consulte:Enviar e exibir comentários de