Vue d’ensemble des propriétés étendues Outlook

  • Article

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Attention

Les tâches Outlook sont déconseillées et ne retournent plus de données le 10 août 2022. Mettez à jour les applications existantes qui utilisent cette fonctionnalité avec les tâches Outlook.

Les propriétés étendues permettent de stocker des données personnalisées et servent spécifiquement de mécanisme de secours pour que les applications accèdent aux données personnalisées pour les propriétés MAPI Outlook lorsque ces propriétés ne sont pas déjà exposées dans l’API Microsoft Graph metadata_. Vous pouvez utiliser les propriétés étendues de l’API REST pour stocker ou obtenir ces données personnalisées dans les ressources utilisateur suivantes :

Ou, dans les ressources de groupe Microsoft 365 suivantes:

Utiliser des propriétés étendues ou des extensions d’ouverture ?

Dans les scénarios les plus courants, vous devez être en mesure d’utiliser des extensions ouvertes (représentées par openTypeExtension, anciennement appelées extensions de données Office 365) pour stocker et accéder aux données personnalisées pour les instances de ressources dans la boîte aux lettres d’un utilisateur. Utilisez des propriétés étendues uniquement si vous avez besoin d’accéder à des données personnalisées pour les propriétés MAPI Outlook qui ne sont pas déjà exposées dans les métadonnées de l’API Microsoft Graph.

Types de propriétés étendues

Que vous envisagiez de stocker une ou plusieurs valeurs (du même type) dans une propriété étendue, vous pouvez créer une propriété étendue sous la forme d’un objet singleValueLegacyExtendedProperty ou multiValueLegacyExtendedProperty.

Chacun de ces types identifie la propriété par son ID et stocke les données dans valeur.

Vous pouvez utiliser id pour obtenir une instance de ressource spécifique avec cette propriété étendue, ou filtrer une propriété étendue à valeur unique pour obtenir toutes les instances dotées de cette propriété.

Note Vous ne pouvez pas utiliser l’API REST pour obtenir toutes les propriétés étendues d’une instance spécifique dans un seul appel.

Formats d’ID

Vous pouvez spécifier ID d’une propriété étendue dans un des trois formats :

  • En tant que propriété nommée, identifiée par le type de propriété étendu, espace de noms et un nom de chaîne.
  • En tant que propriété nommée, identifiée par le type de propriété étendu, espace de noms et un identifiant numérique.
  • Dans un format proptag identifié par le type de propriété étendu et une balise de propriété MAPI.

Les deux tableaux suivants décrivent ces formats comme appliqués aux propriétés étendues à valeur unique et à valeurs multiples. {type} représente le type de la ou des valeurs de la propriété étendue. Les types illustrés dans les exemples sont les suivants : chaîne, nombre entier et tableaux.

Formats d’ID valides pour les propriétés étendues à valeur unique

Format Exemple Description
"{type} {guid} Name {name}" "String {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" Identifie une propriété par l’espace de noms (GUID) auquel il appartient et par un nom de chaîne.
"{type} {guid} Id {id}" "Integer {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8012" Identifie une propriété par l’espace de noms (GUID) auquel il appartient et par son identificateur numérique.
« {type} {proptag} » "String 0x4001" Identifie une propriété prédéfinie par sa balise de propriété.

Formats d’ID valides pour les propriétés étendues à valeurs multiples

Format Exemple Description
"{type} {guid} Name {name}" "StringArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Name TestProperty" Identifie une propriété par l’espace de noms (GUID) et par un nom de chaîne.
"{type} {guid} Id {id}" "IntegerArray {8ECCC264-6880-4EBE-992F-8888D2EEAA1D} Id 0x8013" Identifie une propriété par l’espace de noms (GUID) et par son identificateur numérique.
« {type} {proptag} » "StringArray 0x4002" Identifie une propriété prédéfinie par sa balise de propriété.

Utilisez un des formats de la propriété nommée pour définir une propriété étendue à valeur unique ou plusieurs valeurs en tant que propriété personnalisée. Parmi les deux formats, le premier qui prend un nom de chaîne (nom) est le format par défaut pour la facilité de référence. Les propriétés nommées ont leur identificateurs de propriété dans la plage 0 x 8000-0xfffe.

Utilisez le format proptag pour accéder aux propriétés prédéfinies par MAPI, ou par un client ou un serveur, et qui n’ont pas encore été exposées dans Microsoft Graph. Ces propriétés ont des identificateurs de propriété dans la plage 0x7fff 0 x 0001. N’essayez pas de définir une propriété personnalisée à l’aide du format proptag.

Vous trouverez des informations sur le mappage d’une propriété étendue à une propriété MAPI existante, comme l’identificateur de propriété et le GUID, dans [MS-OXPROPS] Microsoft Corporation, « Liste des propriétés maîtres des protocoles Exchange Server ».

Remarque Lorsque vous avez choisi le format de l’ID, vous devez accéder à cette propriété étendue uniquement par ce format.

Opérations de l’API REST

Opérations d’une propriété étendue à valeur unique :

Opérations d’une propriété étendue à valeurs multiples :