Règles d’activation des compléments contextuels Outlook
Outlook active certains types de complément si le message ou le rendez-vous que l’utilisateur lit ou compose respecte les règles d’activation du complément. Cela est vrai pour tous les compléments qui utilisent le schéma de manifeste 1.1. L’utilisateur peut choisir le complément à partir de l’interface utilisateur Outlook afin de le démarrer pour l’élément actuel.
Importante
Les compléments Outlook contextuels basés sur des entités seront mis hors service au deuxième trimestre 2024. Le travail de mise hors service de cette fonctionnalité commencera en mai et se poursuivra jusqu’à la fin du mois de juin. Après juin, les compléments contextuels ne seront plus en mesure de détecter les entités dans les éléments de courrier pour effectuer des tâches sur ces derniers. Les API suivantes seront également mises hors service.
- Office.context.mailbox.item.getEntities()
- Office.context.mailbox.item.getEntitiesByType(entityType)
- Office.context.mailbox.item.getFilteredEntitiesByName(name)
- Office.context.mailbox.item.getSelectedEntities()
Pour réduire les interruptions potentielles, les éléments suivants seront toujours pris en charge une fois les compléments contextuels basés sur des entités mis hors service.
- Une autre implémentation du bouton Rejoindre , qui est activé par les compléments de réunion en ligne, est en cours de développement. Une fois la prise en charge des compléments contextuels basés sur des entités terminée, les compléments de réunion en ligne passent automatiquement à l’implémentation alternative pour activer le bouton Rejoindre . Pendant la transition vers cette implémentation, le bouton Rejoindre peut ne pas être visible lors de l’utilisation d’un complément de réunion en ligne. Pour contourner ce problème, vous devez sélectionner le lien de réunion dans le corps de l’invitation à la réunion pour participer directement à la réunion.
- Les règles d’expression régulière continueront d’être prises en charge une fois les compléments contextuels basés sur des entités mis hors service. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, voir Utiliser des règles d’activation d’expression régulière pour afficher un complément Outlook.
Pour plus d’informations, consultez Retrait des compléments Outlook contextuels basés sur des entités.
Spécifier des règles d’activation dans un manifeste
Remarque
Les fonctionnalités du complément Outlook qui dépendent de règles d’activation ne sont pas prises en charge lorsque le complément utilise un manifeste unifié pour Microsoft 365.
Pour qu’Outlook active un complément pour des conditions spécifiques, spécifiez des règles d’activation dans le manifeste du complément à l’aide de l’un des éléments suivants Rule .
- Élément de règle (MailApp complexType) : spécifie une règle individuelle.
- Élément de règle (RuleCollection complexType) : combine plusieurs règles à l’aide d’opérations logiques.
Remarque
L’élément Rule que vous utilisez pour spécifier une règle individuelle est de type complexe Règle abstraite. Chacun des types de règles suivants étend ce type complexe abstrait Rule . Ainsi, quand vous spécifiez une règle individuelle dans un manifeste, vous devez utiliser l’attribut xsi:type pour définir plus précisément l’un des types de règle suivants.
Par exemple, la règle suivante définit une règle ItemIs .
<Rule xsi:type="ItemIs" ItemType="Message" />
L’attribut FormType s’applique aux règles d’activation dans le manifeste v1.1, mais n’est pas défini dans VersionOverrides la version 1.0. Il ne peut donc pas être utilisé lorsque ItemIs est utilisé dans le VersionOverrides nœud.
Le tableau suivant répertorie les types de règle disponibles. Vous trouverez plus d’informations dans le tableau et dans les articles indiqués sous Créer des compléments Outlook pour des formulaires de lecture.
| Nom de la règle | Formulaires applicables | Description |
|---|---|---|
| ItemIs | Lecture, composition | Vérifie si l’élément actuel est du type spécifié (message ou rendez-vous). Peut également vérifier la classe de l’élément et le type de formulaire, ainsi qu’éventuellement la classe de message de l’élément. |
| ItemHasAttachment | Lecture | Vérifie si l’élément sélectionné contient une pièce jointe. |
| ItemHasKnownEntity | Lecture | Vérifie si l’élément sélectionné contient une ou plusieurs entités reconnues. Plus d’informations : Mettre en correspondance des chaînes dans un élément Outlook en tant qu’entités connues. |
| ItemHasRegularExpressionMatch | Lecture | Vérifie si l’adresse électronique de l’expéditeur, l’objet et/ou le corps de l’élément sélectionné contient une correspondance avec une expression régulière.Plus d’informations : Utiliser des règles d’activation d’expression régulière pour afficher un complément Outlook. |
| RuleCollection | Lecture, composition | Associe un ensemble de règles pour vous permettre de former des règles plus complexes. |
Règle ItemIs
Le ItemIs type complexe définit une règle qui prend la true valeur si l’élément actuel correspond au type d’élément, et éventuellement la classe de message d’élément si elle est indiquée dans la règle.
Spécifiez l’un des types d’éléments suivants dans l’attribut ItemType d’une ItemIs règle. Vous pouvez spécifier plusieurs ItemIs règles dans un manifeste. L’élément ItemType simpleType définit les types d’élément Outlook qui prennent en charge les compléments Outlook.
| Value | Description |
|---|---|
| Rendez-vous | Spécifie un élément dans le calendrier Outlook. Par exemple, un élément de réunion auquel une réponse a été donnée et auquel un organisateur et des participants sont associés, ou un rendez-vous auquel n’est associé aucun organisateur ou participant et qui constitue un simple élément de calendrier. Cela correspond à la classe de message IPM.Appointment dans Outlook. |
| Message | Spécifie l’un des éléments suivants reçus dans la boîte de réception.
|
L’attribut FormType est utilisé pour spécifier le mode (lecture ou composition) dans lequel le complément doit s’activer.
Remarque
L’attribut ItemIs FormType est défini dans le schéma v1.1 et versions ultérieures, mais pas dans la VersionOverrides version 1.0. N’incluez pas l’attribut FormType lors de la définition des commandes de complément.
Une fois qu’un complément est activé, vous pouvez utiliser la propriété mailbox.item pour obtenir l’élément actuellement sélectionné dans Outlook, et la propriété item.itemType pour obtenir le type de l’élément actuel.
Vous pouvez éventuellement utiliser l’attribut ItemClass pour spécifier la classe de message de l’élément et l’attribut IncludeSubClasses pour spécifier si la règle doit être true lorsque l’élément est une sous-classe de la classe spécifiée.
Pour plus d’informations sur les classes de message, reportez-vous à la rubrique Types d’éléments et classes de messages.
L’exemple suivant est une ItemIs règle qui permet aux utilisateurs de voir le complément dans la barre de compléments Outlook lorsque l’utilisateur lit un message.
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
L’exemple suivant est une ItemIs règle qui permet aux utilisateurs de voir le complément dans la barre de complément Outlook lorsque l’utilisateur lit un message ou un rendez-vous.
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
<Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Read" />
</Rule>
Règle ItemHasAttachment
Le ItemHasAttachment type complexe définit une règle qui vérifie si l’élément sélectionné contient une pièce jointe.
<Rule xsi:type="ItemHasAttachment" />
Règle ItemHasKnownEntity
Avant qu’un élément ne soit mis à la disposition d’un complément, le serveur l’examine pour déterminer si l’objet ou le corps contient du texte susceptible de correspondre à l’une des entités connues. Si l’une de ces entités est trouvée, elle est placée dans une collection d’entités connues auxquelles vous accédez à l’aide de la getEntities méthode ou getEntitiesByType de cet élément.
Vous pouvez spécifier une règle à l’aide ItemHasKnownEntity de qui affiche votre complément lorsqu’une entité du type spécifié est présente dans l’élément. Vous pouvez spécifier les entités connues suivantes dans l’attribut EntityType d’une ItemHasKnownEntity règle.
- Address
- Contact
- EmailAddress
- MeetingSuggestion
- PhoneNumber
- TaskSuggestion
- URL
Vous pouvez éventuellement inclure une expression régulière dans l’attribut RegularExpression afin que votre complément s’affiche uniquement lorsqu’une entité qui correspond à l’expression régulière présente. Pour obtenir des correspondances aux expressions régulières spécifiées dans ItemHasKnownEntity les règles, vous pouvez utiliser la getRegExMatches méthode ou getFilteredEntitiesByName pour l’élément Outlook actuellement sélectionné.
L’exemple suivant montre une collection d’éléments Rule qui affichent le complément quand l’une des entités connues spécifiées est présente dans le message.
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemHasKnownEntity" EntityType="Address" />
<Rule xsi:type="ItemHasKnownEntity" EntityType="MeetingSuggestion" />
<Rule xsi:type="ItemHasKnownEntity" EntityType="TaskSuggestion" />
</Rule>
L’exemple suivant montre une ItemHasKnownEntity règle avec un RegularExpression attribut qui active le complément lorsqu’une URL contenant le mot « contoso » est présente dans un message.
<Rule xsi:type="ItemHasKnownEntity" EntityType="Url" RegularExpression="contoso" />
Pour plus d’informations sur les entités dans les règles d’activation, voir Mettre en correspondance des chaînes dans un élément Outlook en tant qu’entités connues.
Règle ItemHasRegularExpressionMatch
Le ItemHasRegularExpressionMatch type complexe définit une règle qui utilise une expression régulière pour faire correspondre le contenu de la propriété spécifiée d’un élément. Si le texte correspondant à l’expression régulière est trouvé dans la propriété spécifiée de l’élément, Outlook active la barre de compléments et affiche le complément. Vous pouvez utiliser la getRegExMatches méthode ou getRegExMatchesByName de l’objet qui représente l’élément actuellement sélectionné pour obtenir des correspondances pour l’expression régulière spécifiée.
L’exemple suivant montre un ItemHasRegularExpressionMatch qui active le complément lorsque le corps de l’élément sélectionné contient « pomme », « banane » ou « noix de coco », en ignorant la casse.
<Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
Pour plus d’informations sur l’utilisation de la ItemHasRegularExpressionMatch règle, voir Utiliser des règles d’activation d’expression régulière pour afficher un complément Outlook.
Règle RuleCollection
Le RuleCollection type complexe combine plusieurs règles en une seule règle. Vous pouvez spécifier si les règles de la collection doivent être combinées avec un OR logique ou un AND logique à l’aide de l’attribut Mode .
Quand un ET logique est spécifié, un élément doit correspondre à toutes les règles spécifiées dans le regroupement pour permettre l’affichage du complément. Lorsqu’un OR logique est spécifié, un élément qui correspond à l’une des règles spécifiées dans la collection affiche le complément.
Vous pouvez combiner des RuleCollection règles pour former des règles complexes. L’exemple suivant illustre l’activation du complément lorsque l’utilisateur affiche un élément de rendez-vous ou de message et que l’objet ou le corps de l’élément contient une adresse.
<Rule xsi:type="RuleCollection" Mode="And">
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
<Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Read"/>
</Rule>
<Rule xsi:type="ItemHasKnownEntity" EntityType="Address" />
</Rule>
L’exemple suivant illustre l’activation du complément lorsque l’utilisateur compose un message ou affiche un rendez-vous, et que l’objet ou le corps du rendez-vous contient une adresse.
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Edit" />
<Rule xsi:type="RuleCollection" Mode="And">
<Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Read" />
<Rule xsi:type="ItemHasKnownEntity" EntityType="Address" />
</Rule>
</Rule>
Limites pour les règles et les expressions régulières
Pour fournir une expérience satisfaisante avec les compléments Outlook, vous devez vous conformer aux directives d’activation et d’utilisation des API. Le tableau suivant présente les limites générales pour les expressions régulières et les règles, mais il existe des règles spécifiques pour différentes applications. Pour plus d’informations, voir Limites d’activation et d’API JavaScript des compléments Outlook et Résoudre les problèmes d’activation des compléments Outlook.
| Élément de complément | Conseils | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Taille de manifeste | Inférieur à 256 Ko. | |||||||||
| Règles | Pas plus de 15 règles. | |||||||||
| ItemHasKnownEntity | Outlook sur Windows et sur Mac applique la règle sur les 1 premiers Mo du corps, et non sur le reste du corps. | |||||||||
| Expressions régulières | Pour les règles ItemHasKnownEntity ou ItemHasRegularExpressionMatch pour toutes les applications Outlook :
|
Voir aussi
- Créer des compléments Outlook pour les formulaires de composition
- Limites pour l’activation et l’API JavaScript pour les compléments Outlook
- Utiliser des règles d’activation d’expression régulière pour afficher un complément Outlook
- Mettre en correspondance des chaînes dans un élément Outlook en tant qu’entités connues
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour