Obtener configuración del buzón del usuario

Espacio de nombres: microsoft.graph

Obtener el objeto mailboxSettings del usuario. Puede ver toda la configuración del buzón u obtener una configuración específica.

Los usuarios pueden establecer la siguiente configuración para sus buzones a través de un cliente de Outlook:

• Respuestas automáticas (notificar a los usuarios automáticamente al recibir su correo electrónico)
• formato de fecha
• delegateMeetingMessageDeliveryOptions
• Configuración regional (idioma y país/región)
• Formato de hora
• zona horaria
• horario laboral
• Finalidad de usuario

Los usuarios pueden establecer sus formatos de fecha y hora preferidos con Outlook en la Web. Los usuarios pueden elegir uno de los formatos admitidos de fecha corta o de hora corta . Esta GET operación devuelve el formato que el usuario ha elegido.

Los usuarios pueden establecer la zona horaria que prefieran en cualquier cliente de Outlook eligiendo entre las zonas horarias admitidas que su administrador haya configurado para su servidor de buzones de correo. El administrador puede configurar zonas horarias en el formato de zona horaria de Windows o zona horaria de la Autoridad de números asignados de Internet (IANA) (también conocida como zona horaria Olson). El formato Windows es el predeterminado.

Esta GET operación devuelve la zona horaria preferida del usuario en el formato que haya configurado el administrador. Si quiere que esa zona horaria se muestre en un formato específico (Windows o IANA), puede actualizar primero la zona horaria preferida en ese formato como opción de configuración del buzón. Posteriormente, podrá obtener la zona horaria en ese formato. Como alternativa, puede administrar la conversión de formato por separado en la aplicación.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Solicitud HTTP

Para obtener toda la configuración del buzón de un usuario:

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

Para obtener configuraciones específicas, solo la configuración de respuestas automáticas, el formato de fecha, la configuración regional, el formato de hora, la zona horaria, las horas de trabajo o el tipo de destinatario o buzón del usuario (por ejemplo, el propósito del usuario):

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 opcionales

Este método admite los Parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.

Encabezados de solicitud

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y uno de los siguientes objetos solicitados en el cuerpo de la respuesta:

• Objeto mailboxSettings
• Objeto automaticRepliesSetting
• string (for dateFormat)
• string (para delegateMeetingMessageDeliveryOptions)
• Objeto localeInfo
• string (for timeFormat)
• string (para timeZone)
• workingHours
• userPurpose

Ejemplos

Ejemplo 1: Obtener toda la configuración del buzón del usuario que ha iniciado sesión

Obtenga toda la configuración del buzón del buzón del usuario que ha iniciado sesión, que incluye la configuración de las respuestas automáticas, el formato de fecha, la configuración regional (idioma y país o región), el formato de hora, la zona horaria, las horas laborables y el propósito del usuario.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/me/mailboxSettings

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailboxSettings.GetAsync();

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mailboxSettings, err := graphClient.Me().MailboxSettings().Get(context.Background(), nil)

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

MailboxSettings result = graphClient.me().mailboxSettings().get();

const options = {
	authProvider,
};

const client = Client.init(options);

let mailboxSettings = await client.api('/me/mailboxSettings')
	.version('beta')
	.get();

<?php
use Microsoft\Graph\Beta\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->mailboxSettings()->get()->wait();

Import-Module Microsoft.Graph.Beta.Users

# A UPN can also be used as -UserId.
Get-MgBetaUserMailboxSetting -UserId $userId

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.mailbox_settings.get()

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye toda la configuración del buzón del usuario que ha iniciado sesión.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$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"
}

Ejemplo 2: Obtener específicamente la configuración de respuestas automáticas del buzón del usuario que ha iniciado sesión

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/me/mailboxSettings/automaticRepliesSetting

Snippet not available

Snippet not available

Snippet not available

const options = {
	authProvider,
};

const client = Client.init(options);

let automaticRepliesSetting = await client.api('/me/mailboxSettings/automaticRepliesSetting')
	.version('beta')
	.get();

Snippet not available

Snippet not available

Snippet not available

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye solo la configuración de respuestas automáticas.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$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"
}

Ejemplo 3: Obtener específicamente la configuración de horario laboral del buzón del usuario que ha iniciado sesión

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/me/mailboxSettings/workingHours

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye solo la configuración de las horas de trabajo. Observe que la jornada laboral del usuario se encuentra en una zona horaria personalizada.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

{
    "@odata.context":"https://graph.microsoft.com/beta/$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
        }
    }
}

Ejemplo 4: Obtener específicamente la configuración de propósito de usuario del buzón del usuario que ha iniciado sesión

Solicitud

En el ejemplo siguiente se muestra la solicitud.

GET https://graph.microsoft.com/beta/me/mailboxSettings/userPurpose

Snippet not available

Snippet not available

Snippet not available

const options = {
	authProvider,
};

const client = Client.init(options);

let userPurpose = await client.api('/me/mailboxSettings/userPurpose')
	.version('beta')
	.get();

Snippet not available

Snippet not available

Snippet not available

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye solo la configuración de propósito de usuario .

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('622eaaff-0683-4862-9de4-f2ec83c2bd98')/mailboxSettings/userPurpose",
    "value": "user"
}