Paramètres de l'application persistant dans EWS dans ExchangePersistent application settings in EWS in Exchange

Découvrez les différentes options que votre API managée EWS ou votre application EWS peut utiliser pour créer des paramètres d’application personnalisés persistants dans Exchange.Learn about the different options that your EWS Managed API or EWS application can use to create persistent custom application settings in Exchange.

Le moyen le plus simple de maintenir la synchronisation des configurations clientes personnalisées pour une boîte aux lettres, ou des dossiers et des éléments d’une boîte aux lettres, est de stocker les paramètres d’application sur un serveur Exchange.The easiest way to keep custom client configurations in sync for a mailbox, or folders and items in a mailbox, is to store application settings on an Exchange server. Vous pouvez vous assurer que ces paramètres sont conservés pour une boîte aux lettres à l’aide de l’une des méthodes suivantes :You can ensure that those settings persist for a mailbox by using one of the following:

  • Objets de configuration utilisateurUser configuration objects

  • Propriétés étenduesExtended properties

  • Éléments personnalisésCustom items

Quelles sont les options permettant de créer des paramètres d’application permanente ?What are my options for creating persistent application settings?

Les objets de configuration utilisateur constituent votre meilleure option de stockage des paramètres de configuration de vos applications clientes EWS.User configuration objects are your best option for storing configuration settings for your EWS client applications. Vous pouvez également utiliser des propriétés d’extension ou des éléments personnalisés, ou une combinaison des trois.You can also use extend properties or custom items, or a combination of all three. Choisissez votre option en fonction de l’étendue de vos paramètres et indiquez si vos paramètres doivent être disponibles pour d’autres applications.Choose your option based on the scope of your settings and whether your settings need to be available to other applications.

Tableau 1. Options recommandées pour la création de paramètres d’application persistante en fonction de l’étendueTable 1. Recommended options for creating persistent application settings based on scope

Définition de l’étendueSetting scope Utiliser...Use… Accessible parAccessed by
OptionItem
Une propriété étendue sur un élément existant.An extended property on an existing item.
N’importe quelle application EWS.Any EWS application. Seuls les clients EWS qui connaissent l’identificateur de propriété peuvent accéder à une propriété étendue.Only EWS clients that know the property identifier can access an extended property.
FolderFolder
Un objet de configuration utilisateur sur le dossier cible.A user configuration object on the target folder. Il s’agit d’un moyen efficace pour enregistrer les paramètres d’affichage d’un dossier.This is a good way to save view settings for a folder.
N’importe quelle application EWS.Any EWS application.
Boîte aux lettresMailbox
Un objet de configuration utilisateur dans le dossier msgrootfolder par défaut.A user configuration object on the default msgrootfolder folder.
N’importe quelle application EWS.Any EWS application.

Objets de configuration utilisateurUser configuration objects

Les objets de configuration utilisateur sont des éléments spéciaux qui sont associés à des dossiers dans une boîte aux lettres.User configuration objects are special items that are associated with folders in a mailbox. Les objets de configuration utilisateur, également appelés éléments associés aux dossiers, sont généralement la meilleure option pour conserver les paramètres d’application, en particulier si les informations de configuration sont associées à un dossier ou à une boîte aux lettres.User configuration objects, also known as folder associated items, are typically the best option for persisting application settings, especially if the configuration information is associated with a folder or a mailbox. Elles ne sont généralement pas exposées aux utilisateurs finaux.They typically are not surfaced to end users. Étant donné qu’ils peuvent stocker en mode natif des flux de données et des dictionnaires de données, ils sont idéaux pour stocker des informations de configuration.Because they can natively store data streams and data dictionaries, they are ideal for storing configuration information. La meilleure façon d’utiliser des objets de configuration utilisateur est de stocker un ensemble de configurations dans un document XML, puis d’enregistrer ces informations dans l’une des propriétés du flux de configuration de l’utilisateur.The best way to use user configuration objects is to store a set of configurations in an XML document and then save that information in one of the user configuration stream properties.

Les objets de configuration utilisateur sont accessibles différemment des autres types d’éléments stockés dans une boîte aux lettres.User configuration objects are accessed differently than the other item types stored in a mailbox. Vous pouvez utiliser la méthode de l’API managée de dossier. FindItems ou l’opération EWS FindItem pour rechercher tous les éléments, mais vous devez utiliser l’option de parcours de recherche associée pour rechercher des objets de configuration utilisateur.You can use the Folder.FindItems EWS Managed API method or the FindItem EWS operation to find all items, but you must use the Associated search traversal option to find user configuration objects. Le parcours de recherche associé indique que les résultats de la recherche doivent contenir uniquement des objets de configuration utilisateur.The Associated search traversal indicates that the search results should contain only user configuration objects. EWS inclut un ensemble d’opérations spécifiques aux objets de configuration utilisateur.EWS includes a set of operations that are specific to user configuration objects.

Tableau 1. Opérations EWS et méthodes de l’API managée EWS pour l’utilisation d’objets de configuration utilisateurTable 1. EWS operations and EWS Managed API methods for working with user configuration objects

Afin de...In order to… Utiliser cette opération EWSUse this EWS operation Utiliser cette méthode d’API managée EWSUse this EWS Managed API method
Créer un objet de configuration utilisateurCreate a user configuration object
Opération CreateUserConfigurationCreateUserConfiguration operation
UserConfiguration. SaveUserConfiguration.Save
Obtenir un objet de configuration utilisateurGet a user configuration object
Opération GetUserConfigurationGetUserConfiguration operation
UserConfiguration. bindUserConfiguration.Bind
UserConfiguration. LoadUserConfiguration.Load
Mettre à jour un objet de configuration utilisateurUpdate a user configuration object
Opération UpdateUserConfigurationUpdateUserConfiguration operation
UserConfiguration. UpdateUserConfiguration.Update
Supprimer un objet de configuration utilisateurDelete a user configuration object
Opération DeleteUserConfigurationDeleteUserConfiguration operation
UserConfiguration. DeleteUserConfiguration.Delete

Notes

Les objets de configuration utilisateur créés à l’aide d’EWS ont un préfixe ItemClass qui commence par «IPM. Configuration. ".User configuration objects created by using EWS have an ItemClass prefix that starts with "IPM.Configuration.". Le ItemClass d’un objet de configuration utilisateur est le préfixe de l’objet Configuration utilisateur et le nom de votre objet de configuration utilisateur.The ItemClass of a user configuration object is the user configuration object prefix and your user configuration object name. Vous pouvez utiliser la propriété de l’API managée EWS Item. ItemClass ou l’élément EWS ItemClass pour rechercher les objets de configuration utilisateur que vous avez définis.You can use the Item.ItemClass EWS Managed API property or the ItemClass EWS element to search for user configuration objects that you've defined.

Propriétés étenduesExtended properties

Utilisez les propriétés étendues si vous souhaitez stocker des informations de configuration sur des éléments.Use Extended properties if you want to store configuration information on items. EWS, contrairement à MAPI, ne retourne pas de conteneur de propriétés pour les éléments.EWS, unlike MAPI, does not return a property bag for items. Cela signifie qu’un client EWS doit connaître l’identificateur de propriété étendue afin de trouver et d’accéder à la propriété étendue.This means that an EWS client must know the extended property identifier in order to find and access the extended property. Si vous avez besoin de stocker des informations de configuration sur des éléments autres que des objets de configuration utilisateur, l’utilisation de propriétés étendues pour créer des propriétés personnalisées peut être la solution pour vous.If you need to store configuration information on items other than user configuration objects, using extended properties to create custom properties might be the solution for you. Les propriétés étendues vous permettent d’accéder à des informations et de les stocker sur les propriétés qui ne font pas partie du jeu de propriétés standard d’un élément.Extended properties enable you to access and store information on properties that are not part of the standard property set for an item.

Important

Le schéma de base de données Exchange comporte un nombre fini de propriétés.The Exchange database schema has a finite number of properties. Le nombre maximal d’identificateurs de propriétés pour une base de données Exchange est de 32 767.The maximum number of property identifiers for an Exchange database is 32,767. Si vous utilisez des propriétés étendues pour stocker de nombreux paramètres, nous vous conseillons d’utiliser une seule propriété étendue pour stocker ces paramètres afin de ne pas dépasser ce maximum.If you are using extended properties to store many settings, we suggest that you use a single extended property to store those settings so that you don't exceed this maximum.

Vous pouvez utiliser l' élément. mettre à jour la méthode de l’API managée EWS ou l’opération EWS UpdateItem pour définir les propriétés étendues des objets de configuration de l’utilisateur.You can use the Item.Update EWS Managed API method or the UpdateItem EWS operation to set extended properties on user configuration objects.

Éléments personnalisésCustom items

Des éléments personnalisés peuvent également être utilisés pour stocker des informations.Custom items can also be used to store information. Les propriétés d’élément existantes peuvent être réaffectées pour contenir des informations de configuration.The existing item properties can be repurposed to contain configuration information. Vous pouvez utiliser les propriétés étendues pour définir vos propres propriétés pour votre application.Or, you can use extended properties to define your own properties for you application. L’utilisation d’éléments personnalisés pour stocker la configuration offre les avantages suivants :Using custom items to store configuration provides the following benefits:

  • Elles fonctionnent pour toutes les versions d’Exchange qui prennent en charge EWS.They work for all versions of Exchange that support EWS.

  • Si vous n’utilisez pas de propriétés étendues sur l’élément, le budget des propriétés Exchange n’est pas facturé.If you don't use extended properties on the item, the budget of Exchange properties is not charged.

Où dois-je stocker mes paramètres d’application ?Where should I store my application settings?

Les dossiers de boîte aux lettres et les éléments qu’ils contiennent se trouvent dans le dossier de messages racine.Mailbox folders and the items within them are located in the root message folder. Ce dossier est identifié par la valeur WellKnownFolderName. msgfolderroot dans l’API managée EWS.This folder is identified by the WellKnownFolderName.msgfolderroot value in the EWS Managed API. En termes MAPI, il s’agit de l’équivalent de la sous-arborescence IPM d’une boîte aux lettres.In MAPI terms, this is the equivalent of the IPM subtree of a mailbox. Les objets de configuration utilisateur sont souvent utilisés pour créer des paramètres d’interface utilisateur, afin qu’une application puisse afficher les paramètres d’affichage en fonction du dossier auquel un utilisateur accède.User configuration objects are often used to create UI-based settings, so that an application can render view settings based on the folder that a user is accessing. Les paramètres d’affichage basés sur un dossier sont généralement définis sur un objet de configuration utilisateur associé au dossier.Folder-based view settings are usually set on a user configuration object that is associated with the folder. Toutefois, vous pouvez parfois faire en sorte que vos paramètres soient globaux pour votre application.But sometimes, you might want to make your settings global to your application. Dans ce cas, vous pouvez stocker vos paramètres dans le dossier de messages racine.In this case, you can store your settings in the root message folder.

La plupart des utilisateurs ne prennent pas en charge et n’accèdent généralement pas au dossier racine de la boîte aux lettres.Most users are not aware of and typically don't access the root mailbox folder. Ce dossier est identifié par la valeur WellKnownFolderName. root dans l’API managée EWS.This folder is identified by the WellKnownFolderName.root value in the EWS Managed API. En termes MAPI, il s’agit de l’équivalent de la sous-arborescence non IPM d’une boîte aux lettres.In MAPI terms, this is the equivalent of the non-IPM subtree of a mailbox. Les informations auxquelles les utilisateurs finaux n’accèdent pas directement sont stockées dans le dossier racine de la boîte aux lettres.Information that end users don't access directly is stored in the root mailbox folder. Il se peut que vous vouliez stocker le paramètre de votre application dans ce dossier car les applications clientes n’y accèdent généralement pas.You might want to store your application setting in this folder because client applications do not typically access it.

Différences entre les versionsVersion differences

Les objets de configuration utilisateur sont disponibles dans Exchange Online, Exchange Online dans le cadre d’Office 365 et les versions d’Exchange à partir d’Exchange 2010.User configuration objects are available on Exchange Online, Exchange Online as part of Office 365, and versions of Exchange starting with Exchange 2010.

Voir aussiSee also