Mettre à jour les paramètres de boîte aux lettres d’utilisateur

Espace de noms: microsoft.graph

Activez, configurez ou désactivez un ou plusieurs des paramètres suivants dans le cadre de mailboxSettings d’un utilisateur :

Lors de la mise à jour du format de date ou d’heure préféré pour un utilisateur, spécifiez-le respectivement au format de date courte ou d’heure courte .

Lors de la mise à jour du fuseau horaire par défaut pour un utilisateur, spécifiez-le au format IANA (Windows ou Internet Assigned Numbers Authority) (également appelé fuseau horaire Olson). Vous pouvez également personnaliser davantage le fuseau horaire, comme indiqué dans l’exemple 2 ci-dessous.

Conseil

Vous ne pouvez pas créer ou supprimer des paramètres de boîte aux lettres.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) MailboxSettings.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) MailboxSettings.ReadWrite Non disponible.
Application MailboxSettings.ReadWrite Non disponible.

Requête HTTP

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

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire.

Corps de la demande

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 :

Propriété Type Description
automaticRepliesSetting automaticRepliesSetting 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é. Vous pouvez définir ces notifications uniquement pour une plage de dates ultérieure.
Dateformat chaîne Format de date de la boîte aux lettres de l’utilisateur.
delegateMeetingMessageDeliveryOptions delegateMeetingMessageDeliveryOptions 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 les messages de réunion et les réponses aux réunions. Les valeurs possibles sont sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal et sendToDelegateOnly.
language localeInfo 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.
timeFormat string Format d’heure de la boîte aux lettres de l’utilisateur.
timeZone chaîne Fuseau horaire par défaut pour la boîte aux lettres de l’utilisateur.
workingHours workingHours Heures, jours de la semaine et fuseau horaire pendant lesquels l’utilisateur travaille.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et les propriétés mises à jour d’un objet mailboxSettings dans le corps de la réponse.

Erreurs

Définir des valeurs inappropriées pour les heures de travail peut renvoyer les messages d’erreur suivants.

Scénario Code d’état HTTP Code d’erreur Message d’erreur
Valeur startTime ou endTime non valide 400 RequestBodyRead Impossible de convertir le littéral « 08 » vers le type attendu « Edm.TimeOfDay ».
L’heure de début est ultérieure à l’heure de fin 400 ErrorInvalidTimeSettings L’heure de début doit être antérieure à l’heure de fin.
Jour non valide dans daysOfWeek 400 InvalidArguments Valeur demandée « RandomDay » introuvable.
Valeur timeZone non valide 400 InvalidTimeZone Les paramètres de fuseau horaire fournis ne sont pas valides.

Exemples

Exemple 1

Demande

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.

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éponse

La réponse inclut les paramètres mis à jour pour les réponses automatiques. Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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 2

Demande

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é.

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éponse

L’exemple suivant illustre la réponse. Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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