Regras de ativação para suplementos contextuais do Outlook
O Outlook ativa alguns tipos de suplementos se a mensagem ou o compromisso que o usuário está lendo ou redigindo satisfaz as regras de ativação do suplemento. Isso é verdadeiro para todos os suplementos que usam o esquema de manifesto 1.1. O usuário pode escolher o suplemento na interface de usuário do Outlook para iniciá-lo em relação ao item atual.
Importante
Os suplementos contextuais do Outlook baseados em entidade serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse recurso começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As APIs a seguir também serão retiradas.
- Office.context.mailbox.item.getEntities()
- Office.context.mailbox.item.getEntitiesByType(entityType)
- Office.context.mailbox.item.getFilteredEntitiesByName(name)
- Office.context.mailbox.item.getSelectedEntities()
Para ajudar a minimizar possíveis interrupções, o seguinte ainda será suportado depois que os suplementos contextuais baseados em entidade forem retirados.
- Uma implementação alternativa do botão Ingressar Reunião , que é ativado por suplementos de reunião online, está sendo desenvolvida. Depois que o suporte para suplementos contextuais baseados em entidade terminar, os suplementos de reunião online farão a transição automática para a implementação alternativa para ativar o botão Ingressar Reunião .
- As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook.
Para obter mais informações, consulte Aposentadoria de suplementos contextuais do Outlook baseados em entidade.
Especificar regras de ativação em um manifesto
Observação
Recursos de suplemento do Outlook que dependem de regras de ativação não têm suporte quando o suplemento usa um manifesto unificado para o Microsoft 365 (versão prévia).
Para que o Outlook ative um suplemento para condições específicas, especifique as regras de ativação no manifesto de suplemento usando um dos seguintes Rule elementos.
- Elemento Rule (MailApp complexType) - especifica uma regra individual.
- Elemento Rule (RuleCollection complexType) - combina várias regras usando operações lógicas.
Observação
O Rule elemento que você usa para especificar uma regra individual é do tipo complexo regra abstrato. Cada um dos seguintes tipos de regras estende esse tipo complexo abstrato Rule . Portanto, ao especificar uma regra individual em um manifesto, é preciso usar o atributo xsi:type para definir um dos tipos de regra a seguir.
Por exemplo, a regra a seguir define uma regra ItemIs .
<Rule xsi:type="ItemIs" ItemType="Message" />
O FormType atributo se aplica às regras de ativação no manifesto v1.1, mas não é definido em VersionOverrides v1.0. Portanto, ele não pode ser usado quando ItemIs é usado no VersionOverrides nó.
A tabela a seguir lista os tipos de regra disponíveis. Veja mais informações após a tabela e nos artigos especificados em Criar suplementos do Outlook para formulários de leitura.
| Nome da regra | Formulários aplicáveis | Descrição |
|---|---|---|
| ItemIs | Ler, Redigir | Verifica se o item atual é do tipo especificado (compromisso ou mensagem). Pode também verificar a classe do item e o tipo de formulário e, opcionalmente, a classe de mensagem do item. |
| ItemHasAttachment | Leitura | Verifica se o item selecionado contém um anexo. |
| ItemHasKnownEntity | Leitura | Verifica se o item selecionado contém uma ou mais entidades conhecidas. Mais informações: Corresponder cadeias de caracteres em um item do Outlook como entidades conhecidas. |
| ItemHasRegularExpressionMatch | Leitura | Verifica se o endereço de email do remetente, o assunto e/ou o corpo do item selecionado contêm uma correspondência para uma expressão regular. Mais informações: Usar regras de ativação de expressões regulares para mostrar um suplemento do Outlook. |
| RuleCollection | Ler, Redigir | Combina uma coleção de regras para que você forme regras mais complexas. |
Regra ItemIs
O ItemIs tipo complexo define uma regra que avalia se o item atual corresponde ao true tipo de item e, opcionalmente, a classe de mensagem de item se for declarada na regra.
Especifique um dos seguintes tipos de item no ItemType atributo de uma ItemIs regra. Você pode especificar mais de uma ItemIs regra em um manifesto. O tipo simples ItemType define os tipos de itens do Outlook que dão suporte aos suplementos do Outlook.
| Valor | Descrição |
|---|---|
| Compromisso | Especifica um item em um calendário do Outlook. Isso inclui um item de reunião que foi respondido e tem um organizador e participantes, ou um compromisso que não tem um organizador ou participante e é simplesmente um item no calendário. Isso corresponde ao IPM. Classe de mensagem de compromisso no Outlook. |
| Mensagem | Especifica um dos seguintes itens recebidos na caixa de entrada normalmente.
|
O FormType atributo é usado para especificar o modo (leitura ou composição) no qual o suplemento deve ser ativado.
Observação
O atributo ItemIs FormType é definido no esquema v1.1 e posterior, mas não em VersionOverrides v1.0. Não inclua o FormType atributo ao definir comandos de suplemento.
Depois que um suplemento é ativado, você pode usar a propriedade mailbox.item para obter o item selecionado atualmente no Outlook e a propriedade item.itemType para obter o tipo do item atual.
Opcionalmente, você pode usar o ItemClass atributo para especificar a classe de mensagem do item e o IncludeSubClasses atributo para especificar se a regra deve ser true quando o item é uma subclasse da classe especificada.
Para saber mais sobre classes de mensagens, confira Tipos de item e classes de mensagens.
O exemplo a seguir é uma ItemIs regra que permite que os usuários vejam o suplemento na barra de suplementos do Outlook quando o usuário estiver lendo uma mensagem.
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
O exemplo a seguir é uma ItemIs regra que permite que os usuários vejam o suplemento na barra de suplementos do Outlook quando o usuário estiver lendo uma mensagem ou compromisso.
<Rule xsi:type="RuleCollection" Mode="Or">
<Rule xsi:type="ItemIs" ItemType="Message" FormType="Read" />
<Rule xsi:type="ItemIs" ItemType="Appointment" FormType="Read" />
</Rule>
Regra ItemHasAttachment
O ItemHasAttachment tipo complexo define uma regra que verifica se o item selecionado contém um anexo.
<Rule xsi:type="ItemHasAttachment" />
Regra ItemHasKnownEntity
Antes de um item ser disponibilizado para um suplemento, o servidor o examina para determinar se o assunto e o corpo contêm texto que provavelmente é uma das entidades conhecidas. Se alguma dessas entidades for encontrada, ela será colocada em uma coleção de entidades conhecidas que você acessa usando o getEntities método ou getEntitiesByType desse item.
Você pode especificar uma regra usando ItemHasKnownEntity que mostra seu suplemento quando uma entidade do tipo especificado está presente no item. Você pode especificar as entidades conhecidas a seguir no EntityType atributo de uma ItemHasKnownEntity regra.
- Endereço
- Contato
- EmailAddress
- MeetingSuggestion
- PhoneNumber
- TaskSuggestion
- URL
Opcionalmente, você pode incluir uma expressão regular no atributo para que seu RegularExpression suplemento seja mostrado somente quando uma entidade que corresponde à expressão regular no presente. Para obter correspondências com expressões regulares especificadas em ItemHasKnownEntity regras, você pode usar o getRegExMatches método ou getFilteredEntitiesByName para o item do Outlook selecionado no momento.
O exemplo a seguir mostra uma coleção de Rule elementos que mostram o suplemento quando uma das entidades conhecidas especificadas está presente na mensagem.
<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>
O exemplo a seguir mostra uma ItemHasKnownEntity regra com um RegularExpression atributo que ativa o suplemento quando uma URL que contém a palavra "contoso" está presente em uma mensagem.
<Rule xsi:type="ItemHasKnownEntity" EntityType="Url" RegularExpression="contoso" />
Para saber mais sobre entidades nas regras de ativação, confira Corresponder cadeias de caracteres em um item do Outlook como entidades conhecidas.
Regra ItemHasRegularExpressionMatch
O ItemHasRegularExpressionMatch tipo complexo define uma regra que usa uma expressão regular para corresponder ao conteúdo da propriedade especificada de um item. Se o texto que corresponde à expressão regular for encontrado na propriedade especificada do item, o Outlook ativa a barra de suplementos e exibe o suplemento. Você pode usar o getRegExMatches método ou getRegExMatchesByName do objeto que representa o item selecionado no momento para obter correspondências para a expressão regular especificada.
O exemplo a seguir mostra um ItemHasRegularExpressionMatch que ativa o suplemento quando o corpo do item selecionado contém "maçã", "banana" ou "coco", ignorando o caso.
<Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
Para obter mais informações sobre como usar a ItemHasRegularExpressionMatch regra, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook.
Regra RuleCollection
O RuleCollection tipo complexo combina várias regras em uma única regra. Você pode especificar se as regras da coleção devem ser combinadas com um OR lógico ou um AND lógico usando o Mode atributo.
Quando um E lógico é especificado, um item deve corresponder a todas as regras especificadas na coleção para mostrar o suplemento. Quando uma OR lógica é especificada, um item que corresponde a qualquer uma das regras especificadas na coleção mostra o suplemento.
Você pode combinar RuleCollection regras para formar regras complexas. O exemplo a seguir ativa o suplemento quando o usuário está exibindo um compromisso ou um item de mensagem e o assunto ou corpo do item contém um endereço.
<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>
O exemplo a seguir ativa o suplemento quando o usuário está redigindo uma mensagem ou quando o usuário está exibindo um compromisso e o assunto ou corpo do compromisso contém um endereço.
<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 para regras e expressões regulares
Para oferecer uma experiência satisfatória com suplementos do Outlook, você deve seguir as diretrizes de ativação e de uso da API. A tabela a seguir mostra limites gerais para expressões e regras regulares, mas há regras específicas para aplicativos diferentes. Para saber mais, confira Limites de ativação e API JavaScript para suplementos do Outlook e Solucionar problemas de ativação de suplemento do Outlook.
| Elemento do suplemento | Diretrizes | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Tamanho do manifesto | Não pode exceder 256 KB. | |||||||||
| Regras | Máximo de 15 regras. | |||||||||
| ItemHasKnownEntity | O Outlook no Windows e no Mac aplica a regra aos primeiros 1 MB do corpo e não ao restante do corpo. | |||||||||
| Expressões Regulares | Para regras ItemHasKnownEntity ou ItemHasRegularExpressionMatch para todos os aplicativos do Outlook:
|
Confira também
- Criar suplementos do Outlook para formulários de redação
- Limites de ativação e da API do JavaScript API para suplementos do Outlook
- Usar regras de ativação de expressões regulares para mostrar um suplemento do Outlook
- Corresponder cadeias de caracteres em um item do Outlook como entidades conhecidas
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de