Obtenir des paramètres de boîte aux lettres d’utilisateur

Article
10/02/2023

Espace de noms: microsoft.graph

Obtient les mailboxSettings de l’utilisateur. Vous pouvez afficher tous les paramètres de boîte aux lettres ou obtenir des paramètres spécifiques.

Les utilisateurs peuvent spécifier les paramètres suivants pour leurs boîtes aux lettres via un client Outlook :

réponses automatiques (envoi automatique de notifications aux personnes concernées sur réception de leur e-mail)
format de date
delegateMeetingMessageDeliveryOptions
paramètres régionaux (langue et pays/région)
format d’heure
fuseau horaire
heures de travail
objectif de l’utilisateur

Les utilisateurs peuvent régler leurs formats de date et d’heure préférés à l’aide d’Outlook sur le web. Les utilisateurs peuvent choisir l’une des formats pris en charge de date courte ou d’heure courte. Cette opération GET renvoie le format choisi par l’utilisateur.

Les utilisateurs peuvent configurer leurs fuseaux horaires préférés sur n’importe quel client Outlook en choisissant l’un des fuseaux horaires pris en charge que leur administrateur a configuré pour leur serveur de boîtes aux lettres. L’administrateur peut configurer des fuseaux horaires au format de fuseau horaire Windows ou au format IANA (Internet Assigned Numbers Authority) (également appelé fuseau horaire Olson). Le format Windows est défini par défaut.

Cette opération GET renvoie le fuseau horaire favori de l’utilisateur au format configuré par l’administrateur. 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. Vous pourrez ensuite obtenir le fuseau horaire dans le format de votre choix. Vous pouvez également gérer la conversion du format indépendamment depuis votre application.

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.Read	MailboxSettings.ReadWrite
Déléguée (compte Microsoft personnel)	MailboxSettings.Read	MailboxSettings.ReadWrite
Application	MailboxSettings.Read	MailboxSettings.ReadWrite

Requête HTTP

Pour obtenir tous les paramètres de boîte aux lettres d’un utilisateur :

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

Pour obtenir des paramètres spécifiques : seuls les paramètres des réponses automatiques, le format de date, les paramètres régionaux, le format de l’heure, le fuseau horaire, les heures de travail ou le type de destinataire ou de boîte aux lettres de l’utilisateur (par exemple, usage de l’utilisateur) :

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

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. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

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 :

objet mailboxSettings
objet automaticRepliesSetting
chaîne (pour dateFormat)
string (pour delegateMeetingMessageDeliveryOptions)
objet localeInfo
chaîne (pour timeFormat)
chaîne (pour timeZone)
workingHours
userPurpose

Exemples

Exemple 1 : Obtenir tous les paramètres de boîte aux lettres de la boîte aux lettres de l’utilisateur connecté

Obtenez tous les paramètres de boîte aux lettres de la boîte aux lettres de l’utilisateur connecté qui incluent les paramètres des réponses automatiques, le format de date, les paramètres régionaux (langue et pays/région), le format d’heure, le fuseau horaire, les heures de travail et l’objectif de l’utilisateur.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.MailboxSettings.GetAsync();



mgc users mailbox-settings get --user-id {user-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
mailboxSettings, err := graphClient.Me().MailboxSettings().Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

MailboxSettings result = graphClient.me().mailboxSettings().get();


const options = {
	authProvider,
};

const client = Client.init(options);

let mailboxSettings = await client.api('/me/mailboxSettings')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->me()->mailboxSettings()->get()->wait();


Import-Module Microsoft.Graph.Users

# A UPN can also be used as -UserId.
Get-MgUserMailboxSetting -UserId $userId


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.me.mailbox_settings.get()

Réponse

Voici un exemple de réponse qui inclut tous les paramètres de boîte aux lettres de l’utilisateur connecté.

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"
        }
    },
    "userPurpose": {
        "value": "user"
    },
    "dateFormat": "MM/dd/yyyy",
    "timeFormat": "hh:mm tt",
    "delegateMeetingMessageDeliveryOptions": "sendToDelegateOnly"
}

Exemple 2 : Obtenir spécifiquement les paramètres de réponses automatiques de la boîte aux lettres de l’utilisateur connecté

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/automaticRepliesSetting

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let automaticRepliesSetting = await client.api('/me/mailboxSettings/automaticRepliesSetting')
	.get();

Snippet not available

Snippet not available

Snippet not available

Réponse

Voici un exemple de réponse qui inclut uniquement les paramètres de réponses automatiques.

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 3 : Obtenir spécifiquement les paramètres d’heure de travail de la boîte aux lettres de l’utilisateur connecté

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/workingHours

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let workingHours = await client.api('/me/mailboxSettings/workingHours')
	.get();

Snippet not available

Snippet not available

Snippet not available

Réponse

Voici un exemple de réponse qui inclut uniquement les paramètres des heures de travail. Les heures de travail de l’utilisateur sont indiquées dans un fuseau horaire personnalisé.

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

Exemple 4 : Obtenir spécifiquement les paramètres d’objectif utilisateur de la boîte aux lettres de l’utilisateur connecté

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/mailboxSettings/userPurpose

Snippet not available

Snippet not available

Snippet not available

Snippet not available


const options = {
	authProvider,
};

const client = Client.init(options);

let userPurpose = await client.api('/me/mailboxSettings/userPurpose')
	.get();

Snippet not available

Snippet not available

Snippet not available

Réponse

Voici un exemple de réponse qui inclut uniquement les paramètres d’utilisation de l’utilisateur .

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('622eaaff-0683-4862-9de4-f2ec83c2bd98')/mailboxSettings/userPurpose",
    "value": "user"
}

Partager via

Obtenir des paramètres de boîte aux lettres d’utilisateur

Autorisations

Requête HTTP

Paramètres facultatifs de la requête

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Obtenir tous les paramètres de boîte aux lettres de la boîte aux lettres de l’utilisateur connecté

Demande

Réponse

Exemple 2 : Obtenir spécifiquement les paramètres de réponses automatiques de la boîte aux lettres de l’utilisateur connecté

Demande

Réponse

Exemple 3 : Obtenir spécifiquement les paramètres d’heure de travail de la boîte aux lettres de l’utilisateur connecté

Demande

Réponse

Exemple 4 : Obtenir spécifiquement les paramètres d’objectif utilisateur de la boîte aux lettres de l’utilisateur connecté

Demande

Réponse

Commentaires

Ressources supplémentaires