Compartilhar via


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:

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 no formato de fuso horário IANA (Internet Assigned Numbers Authority ). 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.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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 definições específicas – apenas as definições de respostas automáticas, o formato de data, a região, o formato de hora, o fuso horário, o horário de trabalho ou o tipo de caixa de correio ou destinatário do utilizador (por exemplo, para fins de utilizador):

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. Saiba mais sobre autenticação e autorização.

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:

Exemplos

Exemplo 1: Obter todas as definições de caixa de correio da caixa de correio do utilizador com sessão iniciada

Obtenha todas as definições de caixa de correio da caixa de correio do utilizador com sessão iniciada que incluem definições para respostas automáticas, formato de data, região (idioma e país/região), formato de hora, fuso horário, horário de trabalho e finalidade do utilizador.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings

Resposta

Segue-se um exemplo da resposta que inclui todas as definições de caixa de correio do utilizador com sessão iniciada.

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 definições de respostas automáticas da caixa de correio do utilizador com sessão iniciada

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/automaticRepliesSetting

Resposta

Segue-se um exemplo da resposta que inclui apenas as definiçõ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 definições de hora de trabalho da caixa de correio do utilizador com sessão iniciada

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/workingHours

Resposta

Segue-se um exemplo da resposta que inclui apenas as definições do horário 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 definições de finalidade do utilizador da caixa de correio do utilizador com sessão iniciada

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/userPurpose

Resposta

Segue-se um exemplo da resposta que inclui apenas as definições de finalidade do utilizador .

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"
}