Compartir a través de

Obtener configuración del buzón del usuario

  • Artículo

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Obtener el objeto mailboxSettings del usuario. Puede ver toda la configuración del buzón o 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:

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

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

Esta GET operación devuelve la zona horaria preferida del usuario en el formato que el administrador ha configurado. 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 nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores 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.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) MailboxSettings.Read MailboxSettings.ReadWrite
Delegado (cuenta personal de Microsoft) MailboxSettings.Read MailboxSettings.ReadWrite
Aplicación MailboxSettings.Read MailboxSettings.ReadWrite

Solicitud HTTP

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

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

Para obtener una configuración específica: solo la configuración de respuestas automáticas, el formato de fecha, la configuración regional, el formato de hora, la zona horaria, el horario laboral o el tipo de destinatario o buzón del usuario (por ejemplo, la finalidad 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

Nombre Tipo Descripción
Authorization string {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

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:

Ejemplos

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

Obtenga toda la configuración del buzón de correo del usuario que ha iniciado sesión que incluye la configuración para 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, el horario laboral y el propósito del usuario.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye toda la configuración de 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

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 la hora de trabajo 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 del horario laboral. 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 uso del 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

Respuesta

A continuación se muestra un ejemplo de la respuesta que incluye solo la configuración de propósito del 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"
}