Compartir a través de

Actualizar la 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.

Habilite, configure o deshabilite una o varias de las opciones siguientes como parte de mailboxSettings de un usuario:

Al actualizar el formato de fecha u hora preferido para un usuario, especifíquelo en, respectivamente, el formato de fecha ohora corta .

Al actualizar la zona horaria preferida para un usuario, especifíquela en el formato de zona horaria de La autoridad de números asignados de Windows o Internet (IANA) (también conocida como zona horaria de Olson). También puede personalizar aún más la zona horaria, como se muestra en el ejemplo 2 siguiente.

Sugerencia

No puede crear ni eliminar ninguna configuración de buzón de correo.

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.ReadWrite No disponible.
Delegado (cuenta personal de Microsoft) MailboxSettings.ReadWrite No disponible.
Aplicación MailboxSettings.ReadWrite No disponible.

Solicitud HTTP

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

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

En el cuerpo de la solicitud, proporcione los valores de las propiedades relevantes que deben actualizarse. Las propiedades existentes que no se incluyan en el cuerpo de la solicitud mantendrán los valores anteriores o se recalcularán según los cambios efectuados en otros valores de propiedad. Para obtener el mejor rendimiento, no debe incluir valores existentes que no hayan cambiado. Las siguientes propiedades son modificables o actualizables:

Propiedad Tipo Descripción
automaticRepliesSetting automaticRepliesSetting Opciones de configuración para notificar de forma automática al remitente de un mensaje de correo entrante con un mensaje del usuario que ha iniciado sesión. Puede establecer dichas notificaciones solo para un intervalo de fechas futuro.
dateFormat string Formato de fecha del buzón del usuario.
delegateMeetingMessageDeliveryOptions delegateMeetingMessageDeliveryOptions Si el usuario tiene un delegado de calendario, especifica si el delegado, el propietario del buzón o ambos reciben mensajes de reunión y respuestas de reunión. Los valores posibles son: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal y sendToDelegateOnly.
language localeInfo Representación de la configuración regional del usuario, como el idioma preferido y el país o región.
timeFormat string Formato de hora del buzón del usuario.
timeZone string La zona horaria predeterminada del buzón del usuario.
workingHours workingHours Horas, días de la semana y zona horaria en la que trabaja el usuario.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y las propiedades actualizadas de un objeto mailboxSettings en el cuerpo de la respuesta.

Errores

Si se configura el horario laboral con valores incorrectos, pueden devolverse los errores siguientes.

Escenario Código de estado HTTP Código de error Mensaje de error
startTime o endTime no válidos 400 RequestBodyRead No se puede convertir el literal "08" al tipo esperado "Edm.TimeOfDay".
La hora de inicio es posterior a la hora de finalización 400 ErrorInvalidTimeSettings La hora de inicio debe ser anterior a la hora de finalización.
Día no válido en daysOfWeek 400 InvalidArguments No se encuentra el valor solicitado "RandomDay".
timeZone no válido 400 InvalidTimeZone La configuración de zona horaria proporcionada no es válida.

Ejemplos

Ejemplo 1

Solicitud

En el primer ejemplo se habilitan las respuestas automáticas para un intervalo de fechas; para ello, se establecen las siguientes propiedades de la propiedad automaticRepliesSetting: status, scheduledStartDateTime y scheduledEndDateTime.

PATCH https://graph.microsoft.com/beta/me/mailboxSettings
Content-Type: application/json

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

Respuesta

La respuesta incluye la configuración actualizada de las respuestas automáticas. Nota: el objeto de respuesta que se muestra aquí puede haberse acortado 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-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"
    }
}

Ejemplo 2

Solicitud

En el segundo ejemplo se personaliza la zona horaria del horario laboral del usuario que ha iniciado sesión; para ello, se establece la propiedad timeZone en una zona horaria personalizada.

PATCH https://graph.microsoft.com/beta/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 
         } 
      } 
  }
} 

Respuesta

En el ejemplo siguiente se muestra la respuesta. Nota: el objeto de respuesta que se muestra aquí puede haberse acortado 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
            }
        }
    }
}