Obtenir des paramètres de boîte aux lettres d’utilisateurGet user mailbox settings

Obtenez les éléments mailboxSettings de l’utilisateur. Cela inclut des paramètres pour des réponses automatiques (envoi automatique de notifications aux personnes concernées lors de la réception de leur e-mail), des paramètres régionaux (langue et pays/région), le fuseau horaire et les heures de travail.Get the user's mailboxSettings. This includes settings for automatic replies (notify people automatically upon receipt of their email), locale (language and country/region), and time zone, and working hours.

Vous pouvez afficher tous les paramètres de boîte aux lettres ou obtenir des paramètres spécifiques.You can view all mailbox settings, or, get specific settings.

Le fuseau horaire est l’un des paramètres de préférence qu’un utilisateur peut configurer pour sa boîte aux lettres.Time zone is one of the preferred settings a user can set up for the user's mailbox. Les formats de fuseau horaire valides incluent le format Windows et celui de l’organisme IANA (Internet Assigned Numbers Authority), également appelé fuseau horaire Olson.Valid time zone formats include the Windows time zone format and Internet Assigned Numbers Authority (IANA) time zone (also known as Olson time zone) format. Le format Windows est défini par défaut.The Windows format is the default.

Quand vous obtenez le fuseau horaire défini par un utilisateur, son format correspond à celui choisi lors de sa configuration.When you get a user's preferred time zone, the time zone is returned in the format that it was set up. Si vous souhaitez que ce fuseau horaire ait un format spécifique (Windows ou IANA), vous pouvez tout d’abord mettre à jour le fuseau horaire défini selon ce format en tant que paramètre de boîte aux lettres.If you want that time zone to be in a specific format (Windows or IANA), you can first update the preferred time zone in that format as a mailbox setting. Vous pourrez ensuite obtenir le fuseau horaire dans le format de votre choix.Subsequently you will be able to get the time zone in that format. Vous pouvez également gérer la conversion du format indépendamment depuis votre application.Alternatively, you can manage the format conversion separately in your app.

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.Read, MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) MailboxSettings.Read, MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite
ApplicationApplication MailboxSettings.Read, MailboxSettings.ReadWriteMailboxSettings.Read, MailboxSettings.ReadWrite

Requête HTTPHTTP request

Pour obtenir tous les paramètres de boîte aux lettres d’un utilisateur :To get all mailbox settings for a user:

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

Pour obtenir des paramètres spécifiques, par exemple, uniquement les paramètres de réponse automatique, les paramètres régionaux, le fuseau horaire ou les heures de travail :To get specific settings - for example, only the automatic replies settings, locale, time zone, or working hours:

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

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

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

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

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

N’indiquez pas le corps de la demande pour cette méthode.Do not supply a request body for this method.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et l’un des objets demandés suivants dans le corps de la réponse :If successful, this method returns a 200 OK response code and one of the following requested objects in the response body:

ExempleExample

Demande 1Request 1

Le premier exemple obtient tous les paramètres de boîte aux lettres de l’utilisateur connecté, ce qui inclut les paramètres de fuseau horaire, de réponses automatiques, les paramètres régionaux (langue et pays/région), ainsi que les heures de travail.The first example gets all the mailbox settings of the signed-in user's mailbox, which include settings for time zone, automatic replies, locale (language and country/region), and working hours.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings
Réponse 1Response 1

La réponse inclut tous les paramètres de boîte aux lettres. 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.The response includes all the mailbox settings. 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#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"
        }
    }
}

Exemple de code SDKSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var me = await graphClient.Me
    .Request()
    .Select( e => new {
             e.MailboxSettings 
             })
    .GetAsync();

var mailboxSettings = me.MailboxSettings;

Pour plus d’informations sur la façon d' Ajouter le kit de développement logiciel (SDK) à votre projet et de créer une instance authProvider , consultez la documentation SDK .Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Demande 2Request 2

Le second exemple obtient spécifiquement les paramètres de réponse automatique de la boîte aux lettres de l’utilisateur connecté.The second example gets specifically the automatic replies settings of the signed-in user's mailbox.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/automaticRepliesSetting
Réponse 2Response 2

La réponse inclut uniquement les paramètres de réponse automatique. 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.The response includes only the automatic replies settings. 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#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"
}

Exemple de code SDKSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var me = await graphClient.Me
    .Request()
    .Select( e => new {
             e.MailboxSettings 
             })
    .GetAsync();

var automaticRepliesSetting = me.MailboxSettings.AutomaticRepliesSetting;

Pour plus d’informations sur la façon d' Ajouter le kit de développement logiciel (SDK) à votre projet et de créer une instance authProvider , consultez la documentation SDK .Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.

Demande 3Request 3

Le troisième exemple obtient spécifiquement les paramètres d’heures de travail de la boîte aux lettres de l’utilisateur connecté.The third example gets specifically the working hour settings of the signed-in user's mailbox.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/workingHours
Réponse 3Response 3

La réponse inclut uniquement les paramètres d’heures de travail.The response includes only the working hours settings. Les heures de travail de l’utilisateur sont indiquées dans un fuseau horaire personnalisé.Notice that the user's work hours are in a custom time zone. 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#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
        }
    }
}