Mettre à jour les paramètres de boîte aux lettres d’utilisateurUpdate user mailbox settings

Espace de noms: microsoft.graphNamespace: microsoft.graph

Activez, configurez ou désactivez un ou plusieurs des paramètres suivants dans le cadre des paramètres mailboxSettingsd’un utilisateur :Enable, configure, or disable one or more of the following settings as part of a user's mailboxSettings:

Lors de la mise à jour du format de date ou d’heure préféré d’un utilisateur, spécifiez-le au format de date courte ou d’heure courte, respectivement.When updating the preferred date or time format for a user, specify it in respectively, the short date or short time format.

Lors de la mise à jour du fuseau horaire préféré pour un utilisateur, spécifiez-le au format Windows ou IANA (Internet Assigned Numbers Authority) (également appelé fuseau horaire Olson).When updating the preferred time zone for a user, specify it in the Windows or Internet Assigned Numbers Authority (IANA) time zone (also known as Olson time zone) format. Vous pouvez également personnaliser davantage le fuseau horaire comme illustré dans l’exemple 2 ci-dessous.You can also further customize the time zone as shown in example 2 below.

Conseil

Vous ne pouvez pas créer ou supprimer de paramètres de boîte aux lettres.You cannot create or delete any mailbox settings.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) MailboxSettings.ReadWriteMailboxSettings.ReadWrite
ApplicationApplication MailboxSettings.ReadWriteMailboxSettings.ReadWrite

Requête HTTPHTTP request

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

Paramètres facultatifs de la requêteOptional query parameters

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.This method supports the OData Query Parameters to help customize the response.

En-têtes de demandeRequest headers

NomName TypeType DescriptionDescription
AutorisationAuthorization stringstring Porteur {token}. Obligatoire.Bearer {token}. Required.

Corps de la demandeRequest body

Dans le corps de la demande, fournissez les valeurs pour les propriétés appropriées qui doivent être mises à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conserveront leurs valeurs précédentes ou seront recalculées en fonction des modifications apportées à d’autres valeurs des propriétés. Pour de meilleures performances, vous ne devriez pas inclure de valeurs existantes qui n’ont pas changé. Les propriétés accessibles en écriture et pouvant être mises à jour sont les suivantes :In the request body, supply the values for the relevant properties that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed. The following are the writable/updatable properties:

PropriétéProperty TypeType DescriptionDescription
automaticRepliesSettingautomaticRepliesSetting automaticRepliesSettingautomaticRepliesSetting Paramètres de configuration destinés à avertir automatiquement l’expéditeur d’un message entrant au moyen d’un message émis par l’utilisateur connecté.Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user. Vous pouvez définir ces notifications uniquement pour une plage de dates future.You can set such notifications for only a future date range.
dateFormatdateFormat stringstring Format de date pour la boîte aux lettres de l’utilisateur.The date format for the user's mailbox.
delegateMeetingMessageDeliveryOptionsdelegateMeetingMessageDeliveryOptions delegateMeetingMessageDeliveryOptionsdelegateMeetingMessageDeliveryOptions Si l’utilisateur dispose d’un délégué de calendrier, cela spécifie si le délégué, le propriétaire de la boîte aux lettres ou les deux reçoivent des messages de réunion et des réponses à la réunion.If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. Les valeurs possibles sont sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal et sendToDelegateOnly.Possible values are: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly.
languagelanguage localeInfolocaleInfo Informations de paramètres régionaux de l’utilisateur, y compris la langue par défaut et le pays/région préférés.The locale information for the user, including the preferred language and country/region.
timeFormattimeFormat stringstring Format d’heure pour la boîte aux lettres de l’utilisateur.The time format for the user's mailbox.
timeZonetimeZone chaînestring Fuseau horaire par défaut pour la boîte aux lettres de l’utilisateur.The default time zone for the user's mailbox.
workingHoursworkingHours workingHoursworkingHours Heures, jours de la semaine et fuseau horaire pendant lesquels l’utilisateur travaille.The hours, days of a week, and time zone that the user works.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse et les propriétés mises à jour d’un objet 200 OK mailboxSettings dans le corps de la réponse.If successful, this method returns a 200 OK response code and the updated properties of a mailboxSettings object in the response body.

ErreursErrors

Définir des valeurs inappropriées pour les heures de travail peut renvoyer les messages d’erreur suivants.Setting working hours with inappropriate values may return the following errors.

ScénarioScenario Code d’état HTTPHTTP status code Code d’erreurError code Message d’erreurError message
Valeur startTime ou endTime non valideInvalid startTime or endTime 400400 RequestBodyReadRequestBodyRead Impossible de convertir le littéral « 08 » vers le type attendu « Edm.TimeOfDay ».Cannot convert the literal '08' to the expected type 'Edm.TimeOfDay'.
L’heure de début est ultérieure à l’heure de finStart time is greater than end time 400400 ErrorInvalidTimeSettingsErrorInvalidTimeSettings L’heure de début doit être antérieure à l’heure de fin.Start Time should occur before End Time.
Jour non valide dans daysOfWeekInvalid day in daysOfWeek 400400 InvalidArgumentsInvalidArguments Valeur demandée « RandomDay » introuvable.Requested value 'RandomDay' was not found.
Valeur timeZone non valideInvalid timeZone 400400 InvalidTimeZoneInvalidTimeZone Les paramètres de fuseau horaire fournis ne sont pas valides.Time Zone settings provided are invalid.

ExemplesExamples

Exemple 1Example 1

DemandeRequest

Le premier exemple active des réponses automatiques pour une plage de dates, en définissant les propriétés suivantes de la propriété automaticRepliesSetting : status, scheduledStartDateTime et scheduledEndDateTime.The first example enables automatic replies for a date range, by setting the following properties of the automaticRepliesSetting property: status, scheduledStartDateTime and scheduledEndDateTime.

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

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

RéponseResponse

La réponse inclut les paramètres mis à jour pour les réponses automatiques.The response includes the updated settings for automatic replies. Remarque : l’objet de réponse illustré ici peut être tronqué à des fins de concision.Note: The response object shown here may be truncated for brevity. Toutes les propriétés sont renvoyées à partir d’un appel réel.All of the properties will be returned from an actual call.

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

Exemple 2Example 2

DemandeRequest

Le deuxième exemple personnalise le fuseau horaire pour les heures de travail de l’utilisateur connecté, en définissant la propriété timeZone sur un fuseau horaire personnalisé.The second example customizes the time zone for the working hours of the signed-in user, by setting the timeZone property to a custom time zone.

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

RéponseResponse

Voici un exemple de la réponse. Remarque : L’objet de réponse illustré ici peut être tronqué à des fins de concision. Toutes les propriétés sont renvoyées à partir d’un appel réel.Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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