Reglas de activación para complementos contextuales de Outlook
Outlook activa algunos tipos de complemento si el mensaje o la cita que lee o redacta el usuario cumple las reglas de activación de los mismos. Esto se aplica a todos los complementos que utilizan el esquema de manifiesto 1.1. A continuación, el usuario puede elegir el complemento de la interfaz de usuario de Outlook para que se inicie con el elemento actual.
Importante
Los complementos contextuales de Outlook basados en entidades se retirarán en el segundo trimestre de 2024. El trabajo para retirar esta característica comenzará en mayo y continuará hasta finales de junio. Después de junio, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. También se retirarán las siguientes API.
- Office.context.mailbox.item.getEntities()
- Office.context.mailbox.item.getEntitiesByType(entityType)
- Office.context.mailbox.item.getFilteredEntitiesByName(name)
- Office.context.mailbox.item.getSelectedEntities()
Para ayudar a minimizar las posibles interrupciones, se seguirá admitiendo lo siguiente después de que se retiren los complementos contextuales basados en entidades.
- Se está desarrollando una implementación alternativa del botón Unirse a la reunión , que se activa mediante complementos de reunión en línea. Una vez finalizada la compatibilidad con complementos contextuales basados en entidades, los complementos de reunión en línea pasarán automáticamente a la implementación alternativa para activar el botón Unirse a la reunión .
- Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook.
Para obtener más información, vea Retirada de complementos contextuales de Outlook basados en entidades.
Especificar las reglas de activación en un manifiesto
Nota:
Las características de complemento de Outlook que dependen de las reglas de activación no se admiten cuando el complemento usa un manifiesto unificado para Microsoft 365.
Para que Outlook active un complemento para condiciones específicas, especifique las reglas de activación en el manifiesto del complemento mediante uno de los siguientes Rule elementos.
- Elemento Rule (MailApp complexType): especifica una regla individual.
- Elemento Rule (RuleCollection complexType): combina varias reglas con operaciones lógicas.
Nota:
El Rule elemento que se usa para especificar una regla individual es del tipo complejo rule abstracto. Cada uno de los siguientes tipos de reglas extiende este tipo complejo abstracto Rule . Si especifica una regla individual en un manifiesto, debe usar el atributo xsi:type para definir uno de los tipos siguientes de reglas.
Por ejemplo, la siguiente regla define una regla ItemIs .
<Rule xsi:type="ItemIs" ItemType="Message" />
El FormType atributo se aplica a las reglas de activación del manifiesto v1.1, pero no está definido en VersionOverrides v1.0. Por lo tanto, no se puede usar cuando se usa ItemIs en el VersionOverrides nodo.
En la tabla siguiente se muestran los tipos de reglas disponibles. Puede obtener más información en la tabla y en los artículos especificados en Crear complementos de Outlook para formularios de lectura.
| Nombre de la regla | Formularios correspondientes | Descripción |
|---|---|---|
| ItemIs | Lectura, Redacción | Comprueba si el elemento actual es del tipo especificado (mensaje o cita). También puede comprobar la clase del elemento y tipo de formulario, y opcionalmente la clase de mensaje del elemento. |
| ItemHasAttachment | Lectura | Comprueba si el elemento seleccionado contiene datos adjuntos. |
| ItemHasKnownEntity | Lectura | Comprueba si el elemento seleccionado contiene una o más entidades conocidas. Más información: Coincidencia de cadenas en un elemento de Outlook como entidades conocidas. |
| ItemHasRegularExpressionMatch | Lectura | Comprueba si la dirección de correo del remitente, el asunto o el cuerpo del elemento seleccionado contienen algún resultado con una expresión regular.Más información: Usar las reglas de activación de las expresiones regulares para mostrar un complemento de Outlook. |
| RuleCollection | Lectura, Redacción | Combina un conjunto de reglas de forma que se puedan formar reglas más complejas. |
Regla ItemIs
El ItemIs tipo complejo define una regla que se evalúa como true si el elemento actual coincide con el tipo de elemento y, opcionalmente, la clase de mensaje de elemento si se indica en la regla.
Especifique uno de los siguientes tipos de elementos en el ItemType atributo de una ItemIs regla. Puede especificar más de una ItemIs regla en un manifiesto. El elemento simpleType de ItemType define los tipos de elementos de Outlook compatibles con complementos de Outlook.
| Value | Descripción |
|---|---|
| Appointment | Especifica un elemento en un calendario de Outlook. Esto incluye un elemento de reunión al que se ha respondido y tiene un organizador y asistentes o una cita que no tiene un organizador ni asistentes y es simplemente un elemento del calendario. Corresponde a la clase de mensaje IPM.Appointment en Outlook. |
| Message | Especifica uno de los siguientes elementos recibidos normalmente en la Bandeja de entrada.
|
El FormType atributo se usa para especificar el modo (lectura o redacción) en el que se debe activar el complemento.
Nota:
El atributo ItemIs FormType se define en el esquema v1.1 y versiones posteriores, pero no en VersionOverrides la versión 1.0. No incluya el FormType atributo al definir comandos de complemento.
Una vez activado un complemento, se puede usar la propiedad mailbox.item para obtener el elemento seleccionado actualmente en Outlook y la propiedad item.itemType para obtener el tipo del elemento actual.
Opcionalmente, puede usar el ItemClass atributo para especificar la clase de mensaje del elemento y el IncludeSubClasses atributo para especificar si la regla debe ser true cuando el elemento es una subclase de la clase especificada.
Para más información sobre las clases de mensajes, vea Tipos de elementos y clases de mensajes.
El ejemplo siguiente es una ItemIs regla que permite a los usuarios ver el complemento en la barra de complementos de Outlook cuando el usuario lee un mensaje.
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
El ejemplo siguiente es una ItemIs regla que permite a los usuarios ver el complemento en la barra de complementos de Outlook cuando el usuario lee un mensaje o una cita.
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
<Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Read" />
</Rule>
Regla ItemHasAttachment
El ItemHasAttachment tipo complejo define una regla que comprueba si el elemento seleccionado contiene datos adjuntos.
<Rule xsi:type="ItemHasAttachment" />
Regla ItemHasKnownEntity
Antes de que un elemento esté disponible para un complemento, el servidor lo examina para determinar si el asunto y el cuerpo contienen texto que pueda ser una de las entidades conocidas. Si se encuentra alguna de estas entidades, se coloca en una colección de entidades conocidas a las que tiene acceso mediante el getEntities método o getEntitiesByType de ese elemento.
Puede especificar una regla mediante el uso ItemHasKnownEntity de que muestra el complemento cuando una entidad del tipo especificado está presente en el elemento. Puede especificar las siguientes entidades conocidas en el EntityType atributo de una ItemHasKnownEntity regla.
- Address
- Contact
- EmailAddress
- MeetingSuggestion
- PhoneNumber
- TaskSuggestion
- URL
Opcionalmente, puede incluir una expresión regular en el atributo para que el RegularExpression complemento solo se muestre cuando una entidad que coincida con la expresión regular presente. Para obtener coincidencias con expresiones regulares especificadas en ItemHasKnownEntity las reglas, puede usar el getRegExMatches método o getFilteredEntitiesByName para el elemento de Outlook seleccionado actualmente.
En el ejemplo siguiente se muestra una colección de Rule elementos que muestran el complemento cuando una de las entidades conocidas especificadas está presente en el mensaje.
<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>
En el ejemplo siguiente se muestra una ItemHasKnownEntity regla con un RegularExpression atributo que activa el complemento cuando una dirección URL que contiene la palabra "contoso" está presente en un mensaje.
<Rule xsi:type="ItemHasKnownEntity" EntityType="Url" RegularExpression="contoso" />
Para obtener más información sobre las entidades de las reglas de activación, vea Coincidencia de cadenas en un elemento de Outlook como entidades conocidas.
Regla ItemHasRegularExpressionMatch
El ItemHasRegularExpressionMatch tipo complejo define una regla que usa una expresión regular para coincidir con el contenido de la propiedad especificada de un elemento. Si el texto que coincide con la expresión regular se encuentra en la propiedad especificada, Outlook activa la barra de complementos y muestra el complemento. Puede usar el getRegExMatches método o getRegExMatchesByName del objeto que representa el elemento seleccionado actualmente para obtener coincidencias para la expresión regular especificada.
En el ejemplo siguiente se muestra un ItemHasRegularExpressionMatch objeto que activa el complemento cuando el cuerpo del elemento seleccionado contiene "apple", "banana" o "coconut", omitiendo mayúsculas y minúsculas.
<Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
Para obtener más información sobre el uso de la ItemHasRegularExpressionMatch regla, vea Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook.
Regla RuleCollection
El RuleCollection tipo complejo combina varias reglas en una sola regla. Puede especificar si las reglas de la colección deben combinarse con un OR lógico o un AND lógico mediante el Mode atributo .
Cuando se especifica el operador lógico AND, un elemento debe satisfacer todas las reglas seleccionadas en la colección para mostrar el complemento. Cuando se especifica un or lógico, un elemento que coincide con cualquiera de las reglas especificadas en la colección muestra el complemento.
Puede combinar RuleCollection reglas para formar reglas complejas. El ejemplo siguiente activa el complemento cuando una cita o mensaje contiene una dirección.
<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>
El siguiente ejemplo activa el complemento cuando el usuario está redactando un mensaje o cuando está viendo una cita y el asunto o el cuerpo de la cita contiene una dirección.
<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>
Límites de reglas y expresiones regulares
Para proporcionar una experiencia satisfactoria con los complementos de Outlook, debe cumplir las instrucciones de uso de API y activación. En la tabla siguiente se muestran los límites generales de las expresiones regulares y las reglas, pero hay reglas específicas para diferentes aplicaciones. Para obtener más información, consulte Límites de activación y API de JavaScript para complementos de Outlook y Solucionar problemas relacionados con la activación de los complementos de Outlook.
| Elemento de complemento | Instrucciones | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Tamaño del manifiesto | No más de 256 KB. | |||||||||
| Reglas | No más de 15 reglas. | |||||||||
| ItemHasKnownEntity | Outlook en Windows y en Mac aplica la regla en los primeros 1 MB del cuerpo y no en el resto del cuerpo. | |||||||||
| Expresiones regulares | Para las reglas ItemHasKnownEntity o ItemHasRegularExpressionMatch para todas las aplicaciones de Outlook:
|
Vea también
- Crear complementos de Outlook para formularios de redacción
- Límites para la activación y API de JavaScript para complementos de Outlook
- Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook
- Coincidencia de cadenas en un elemento de Outlook como entidades conocidas
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de