Definir automaticamente o assunto de uma nova mensagem ou compromisso

Artigo
09/01/2024

Precisa de adicionar uma exclusão de responsabilidade necessária a todas as suas mensagens? Com um suplemento baseado em eventos, o conteúdo é adicionado automaticamente a novas mensagens ou compromissos. Os seus utilizadores podem concentrar-se na escrita, em vez da conformidade.

As secções seguintes ensinam-no a desenvolver um suplemento que processa os OnNewMessageCompose eventos e OnNewAppointmentOrganizer . No final destas instruções, terá um suplemento que define automaticamente o assunto das novas mensagens e compromissos que estão a ser criados.

Observação

Os OnNewMessageCompose eventos e OnNewAppointmentOrganizer foram introduzidos no conjunto de requisitos 1.10. Para verificar se o seu cliente do Outlook suporta estes eventos, veja Conjuntos de requisitos suportados pelos servidores Exchange e clientes do Outlook.

Configurar seu ambiente

Conclua o guia de introdução do Outlook , que cria um projeto de suplemento com o gerador Yeoman para Suplementos do Office.

Configurar o manifesto

Para configurar o manifesto, selecione o separador para o tipo de manifesto que está a utilizar.

Manifesto unificado para o Microsoft 365
Manifesto apenas de suplemento

Abra o ficheiro manifest.json .
Adicione o seguinte objeto à matriz "extensions.runtimes". Observe o seguinte sobre esta marcação:
- A "minVersion" do conjunto de requisitos da Caixa de Correio está configurada para "1.10", uma vez que esta é a versão mais baixa do conjunto de requisitos que suporta os OnNewMessageCompose eventos e OnNewAppointmentOrganizer .
- O "ID" do runtime está definido como o nome descritivo "autorun_runtime".
- A propriedade "code" tem uma propriedade "page" subordinada que está definida como um ficheiro HTML e uma propriedade "script" subordinada que está definida como um ficheiro JavaScript. Irá criar ou editar estes ficheiros em passos posteriores. O Office utiliza um destes valores consoante a plataforma.
  - O Office no Windows executa os processadores de eventos num runtime apenas javaScript, que carrega diretamente um ficheiro JavaScript.
  - O Office no Mac e na Web e o novo Outlook no Windows executam os processadores num runtime do browser, que carrega um ficheiro HTML. Esse ficheiro, por sua vez, contém uma <script> etiqueta que carrega o ficheiro JavaScript.
  Para obter mais informações, consulte Runtimes nos Suplementos do Office.
- A propriedade "lifetime" está definida como "short", o que significa que o runtime é iniciado quando um dos eventos é acionado e é encerrado quando o processador é concluído. (Em determinados casos raros, o runtime é encerrado antes de o processador ser concluído. Consulte Runtimes nos Suplementos do Office.)
- Existem dois tipos de "ações" que podem ser executados no runtime. Irá criar funções para corresponder a estas ações num passo posterior.
```
 {
    "requirements": {
        "capabilities": [
            {
                "name": "Mailbox",
                "minVersion": "1.10"
            }
        ]
    },
    "id": "autorun_runtime",
    "type": "general",
    "code": {
        "page": "https://localhost:3000/commands.html",
        "script": "https://localhost:3000/launchevent.js"
    },
    "lifetime": "short",
    "actions": [
        {
            "id": "onNewMessageComposeHandler",
            "type": "executeFunction",
            "displayName": "onNewMessageComposeHandler"
        },
        {
            "id": "onNewAppointmentComposeHandler",
            "type": "executeFunction",
            "displayName": "onNewAppointmentComposeHandler"
        }
    ]
}
```
Adicione a seguinte matriz "autoRunEvents" como uma propriedade do objeto na matriz "extensions".
```
"autoRunEvents": [

]
```

Adicione o seguinte objeto à matriz "autoRunEvents". A propriedade "eventos" mapeia processadores para eventos, conforme descrito na tabela anterior neste artigo. Os nomes do processador têm de corresponder aos utilizados nas propriedades "id" dos objetos na matriz "actions" num passo anterior.

  {
      "requirements": {
          "capabilities": [
              {
                  "name": "Mailbox",
                  "minVersion": "1.10"
              }
          ],
          "scopes": [
              "mail"
          ]
      },
      "events": [
          {
              "type": "newMessageComposeCreated",
              "actionId": "onNewMessageComposeHandler"
          },
          {
              "type": "newAppointmentOrganizerCreated",
              "actionId": "onNewAppointmentComposeHandler"
          }
      ]
  }

Para ativar a ativação baseada em eventos do suplemento, tem de configurar o elemento Runtimes e o VersionOverridesV1_1 ponto de extensão LaunchEvent no nó do manifesto.

Nos suplementos baseados em eventos, o Outlook clássico no Windows utiliza um ficheiro JavaScript, enquanto Outlook na Web e na nova IU do Mac e o novo Outlook no Windows utilizam um ficheiro HTML que pode referenciar o mesmo ficheiro JavaScript. Tem de fornecer referências a ambos os ficheiros no Resources nó do manifesto, uma vez que a plataforma do Outlook determina, em última análise, se deve utilizar HTML ou JavaScript com base no cliente do Outlook. Como tal, para configurar o processamento de eventos, forneça a localização do HTML no elemento Runtime> e, em< seguida, no elemento Override subordinado, forneça a localização do ficheiro JavaScript indicado ou referenciado pelo HTML.

No editor de código, abra o projeto de início rápido.
Abra o ficheiro manifest.xml localizado na raiz do projeto.
Selecione todo <o nó VersionOverrides> (incluindo etiquetas abertas e fechadas) e substitua-o pelo XML seguinte e, em seguida, guarde as alterações.

<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
    <Requirements>
      <bt:Sets DefaultMinVersion="1.10">
        <bt:Set Name="Mailbox" />
      </bt:Sets>
    </Requirements>
    <Hosts>
      <Host xsi:type="MailHost">
        <!-- Event-based activation happens in a lightweight runtime.-->
        <Runtimes>
          <!-- HTML file including reference to or inline JavaScript event handlers.
               This is used by Outlook on the web and on the new Mac UI, and new Outlook on Windows. -->
          <Runtime resid="WebViewRuntime.Url">
            <!-- JavaScript file containing event handlers. This is used by classic Outlook on Windows. -->
            <Override type="javascript" resid="JSRuntime.Url"/>
          </Runtime>
        </Runtimes>
        <DesktopFormFactor>
          <FunctionFile resid="Commands.Url" />
          <ExtensionPoint xsi:type="MessageReadCommandSurface">
            <OfficeTab id="TabDefault">
              <Group id="msgReadGroup">
                <Label resid="GroupLabel" />
                <Control xsi:type="Button" id="msgReadOpenPaneButton">
                  <Label resid="TaskpaneButton.Label" />
                  <Supertip>
                    <Title resid="TaskpaneButton.Label" />
                    <Description resid="TaskpaneButton.Tooltip" />
                  </Supertip>
                  <Icon>
                    <bt:Image size="16" resid="Icon.16x16" />
                    <bt:Image size="32" resid="Icon.32x32" />
                    <bt:Image size="80" resid="Icon.80x80" />
                  </Icon>
                  <Action xsi:type="ShowTaskpane">
                    <SourceLocation resid="Taskpane.Url" />
                  </Action>
                </Control>
                <Control xsi:type="Button" id="ActionButton">
                  <Label resid="ActionButton.Label"/>
                  <Supertip>
                    <Title resid="ActionButton.Label"/>
                    <Description resid="ActionButton.Tooltip"/>
                  </Supertip>
                  <Icon>
                    <bt:Image size="16" resid="Icon.16x16"/>
                    <bt:Image size="32" resid="Icon.32x32"/>
                    <bt:Image size="80" resid="Icon.80x80"/>
                  </Icon>
                  <Action xsi:type="ExecuteFunction">
                    <FunctionName>action</FunctionName>
                  </Action>
                </Control>
              </Group>
            </OfficeTab>
          </ExtensionPoint>

          <!-- Can configure other command surface extension points for add-in command support. -->

          <!-- Enable launching the add-in on the included events. -->
          <ExtensionPoint xsi:type="LaunchEvent">
            <LaunchEvents>
              <LaunchEvent Type="OnNewMessageCompose" FunctionName="onNewMessageComposeHandler"/>
              <LaunchEvent Type="OnNewAppointmentOrganizer" FunctionName="onNewAppointmentComposeHandler"/>
            </LaunchEvents>
            <!-- Identifies the runtime to be used (also referenced by the Runtime element). -->
            <SourceLocation resid="WebViewRuntime.Url"/>
          </ExtensionPoint>
        </DesktopFormFactor>
      </Host>
    </Hosts>
    <Resources>
      <bt:Images>
        <bt:Image id="Icon.16x16" DefaultValue="https://localhost:3000/assets/icon-16.png"/>
        <bt:Image id="Icon.32x32" DefaultValue="https://localhost:3000/assets/icon-32.png"/>
        <bt:Image id="Icon.80x80" DefaultValue="https://localhost:3000/assets/icon-80.png"/>
      </bt:Images>
      <bt:Urls>
        <bt:Url id="Commands.Url" DefaultValue="https://localhost:3000/commands.html" />
        <bt:Url id="Taskpane.Url" DefaultValue="https://localhost:3000/taskpane.html" />
        <bt:Url id="WebViewRuntime.Url" DefaultValue="https://localhost:3000/commands.html" />
        <!-- Entry needed for classic Outlook on Windows. -->
        <bt:Url id="JSRuntime.Url" DefaultValue="https://localhost:3000/launchevent.js" />
      </bt:Urls>
      <bt:ShortStrings>
        <bt:String id="GroupLabel" DefaultValue="Contoso Add-in"/>
        <bt:String id="TaskpaneButton.Label" DefaultValue="Show Taskpane"/>
        <bt:String id="ActionButton.Label" DefaultValue="Perform an action"/>
      </bt:ShortStrings>
      <bt:LongStrings>
        <bt:String id="TaskpaneButton.Tooltip" DefaultValue="Opens a pane displaying all available properties."/>
        <bt:String id="ActionButton.Tooltip" DefaultValue="Perform an action when clicked."/>
      </bt:LongStrings>
    </Resources>
  </VersionOverrides>
</VersionOverrides>

Dica

Para saber mais sobre runtimes em suplementos, consulte Runtimes nos Suplementos do Office.
Para saber mais sobre manifestos para suplementos do Outlook, consulte Manifestos de suplementos do Office.

Implementar o processamento de eventos

A partir do mesmo projeto de início rápido, crie uma nova pasta com o nome launchevent no diretório ./src .
Na pasta ./src/launchevent , crie um novo ficheiro com o nome launchevent.js.

Abra o ficheiro ./src/launchevent/launchevent.js no editor de código e adicione o seguinte código JavaScript.

/*
* Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
* See LICENSE in the project root for license information.
*/

function onNewMessageComposeHandler(event) {
  setSubject(event);
}
function onNewAppointmentComposeHandler(event) {
  setSubject(event);
}
function setSubject(event) {
  Office.context.mailbox.item.subject.setAsync(
    "Set by an event-based add-in!",
    {
      "asyncContext": event
    },
    function (asyncResult) {
      // Handle success or error.
      if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
        console.error("Failed to set subject: " + JSON.stringify(asyncResult.error));
      }

      // Call event.completed() to signal to the Outlook client that the add-in has completed processing the event.
      asyncResult.asyncContext.completed();
    });
}

// IMPORTANT: To ensure your add-in is supported in the Outlook client on Windows, remember to map the event handler name specified in the manifest to its JavaScript counterpart.
if (Office.context.platform === Office.PlatformType.PC || Office.context.platform == null) {
  Office.actions.associate("onNewMessageComposeHandler", onNewMessageComposeHandler);
  Office.actions.associate("onNewAppointmentComposeHandler", onNewAppointmentComposeHandler);
}

Salve suas alterações.

Observação

Existem algumas limitações que tem de ter em conta ao desenvolver um suplemento baseado em eventos para o Outlook clássico no Windows. Para saber mais, veja Event-based activation behavior and limitations (Comportamento e limitações da ativação baseada em eventos).

Atualizar o ficheiro HTML dos comandos

Na pasta ./src/commands , abra commands.html.
Imediatamente antes da etiqueta principal de fecho (</head>), adicione uma entrada de script para incluir o código JavaScript de processamento de eventos.
```
<script type="text/javascript" src="../launchevent/launchevent.js"></script>
```
Salve suas alterações.

Atualizar as configurações webpack config

Abra o ficheiro webpack.config.js encontrado no diretório de raiz do projeto e conclua os seguintes passos.

Localize a plugins matriz no config objeto e adicione este novo objeto no início da matriz.

new CopyWebpackPlugin({
  patterns: [
    {
      from: "./src/launchevent/launchevent.js",
      to: "launchevent.js",
    },
  ],
}),

Salve suas alterações.

Experimente

Execute os seguintes comandos no diretório de raiz do projeto. Quando executa npm starto , o servidor Web local será iniciado (se ainda não estiver em execução) e o suplemento será sideloaded.
```
npm run build
```
```
npm start
```
Observação

Se o suplemento não tiver sido carregado automaticamente em sideload, siga as instruções em Sideload Suplementos do Outlook para testar para fazer sideload manualmente do suplemento no Outlook.
No Outlook na Web ou no novo Outlook no Windows, crie uma nova mensagem.
No Outlook na nova IU do Mac, crie uma nova mensagem.
No Outlook clássico no Windows, crie uma nova mensagem.
Quando quiser parar o servidor Web local e desinstalar o suplemento, siga as instruções aplicáveis:
- Para parar o servidor, execute o seguinte comando. Se tiver utilizado npm start, o seguinte comando também deve desinstalar o suplemento.
```
npm stop
```
- Se tiver carregado manualmente o suplemento em sideload, consulte Remover um suplemento sideloaded.

Próximas etapas

Para saber mais sobre a ativação baseada em eventos e outros eventos que pode implementar no seu suplemento, consulte Configurar o suplemento do Outlook para ativação baseada em eventos.

Compartilhar via