Ativar o suplemento do Outlook sem o Painel de Leitura habilitado ou sem uma mensagem selecionada

Com uma configuração de manifesto simples, você pode criar suplementos do Outlook para a superfície de Leitura de Mensagens que ativam um painel de tarefas sem o Painel de Leitura habilitado ou uma mensagem selecionada pela primeira vez na caixa de correio. Esse recurso é chamado de "sem contexto de item". Siga o passo a passo para saber mais e desbloquear recursos adicionais para o seu suplemento. Por exemplo, você pode permitir que os usuários acessem conteúdo de diferentes fontes de dados, como o OneDrive ou um sistema de gerenciamento de relacionamento com o cliente (CRM), diretamente do cliente Outlook.

Observação

O suporte para esse recurso foi introduzido no conjunto de requisitos 1.13. Confira, clientes e plataformas que oferecem suporte a esse conjunto de requisitos.

Embora o Outlook na Web e o novo Outlook no Windows tenham suporte para o requisito 1.13, um suplemento não será ativado se o Painel de Leitura estiver oculto ou uma mensagem não estiver selecionada. Para obter mais informações, consulte Suporte a recursos no Outlook na Web e novo Outlook no Windows.

Configurar seu ambiente

Conclua o Início Rápido do Outlook , no qual você cria um suplemento do Outlook com o gerador Yeoman para Suplementos do Office.

Para ativar esse recurso em um projeto de suplemento preexistente, consulte Configurar o manifesto.

Configurar o manifesto

As etapas para configurar o manifesto variam dependendo do tipo de manifesto que seu suplemento usa.

Observação

Não há suporte para suplementos que usam o manifesto unificado para Microsoft 365 no Outlook no Mac. Estamos trabalhando duro para fornecer esse apoio. Enquanto isso, se sua base de clientes incluir usuários no Mac, você precisará criar uma versão do suplemento que use o manifesto somente do suplemento e dê suporte a ambos. Para obter mais informações, consulte Suporte para suplementos com o manifesto unificado para Microsoft 365.

  1. No editor de código de sua preferência, abra o projeto de início rápido do Outlook que você criou.

  2. Abra o arquivo manifest.json localizado na raiz do projeto.

  3. No primeiro objeto da matriz, faça o "extensions.runtimes" seguinte:

    1. Altere o "requirements.capabilities.minVersion" para "1.13".
    2. Adicione uma "supportsNoItemContext" propriedade ao objeto na "actions" matriz e defina seu valor como true.
    3. Adicione uma "multiselect" propriedade ao mesmo objeto e defina-a como true.
    4. Altere a "pinnable" propriedade no mesmo objeto para true.

    Quando terminar, deve ser semelhante ao seguinte.

    "runtimes": [
    {
        "requirements": {
            "capabilities": [
                {
                    "name": "Mailbox",
                    "minVersion": "1.13"
                }
            ]
        },
        "id": "TaskPaneRuntime",
        "type": "general",
        "code": {
            "page": "https://localhost:3000/taskpane.html"
        },
        "lifetime": "short",
        "actions": [
            {
                "id": "TaskPaneRuntimeShow",
                "type": "openPage",
                "view": "dashboard",
                "pinnable": true,
                "supportsNoItemContext": true,
                "multiselect": true
            }
        ]
    }
]

  4. Exclua o segundo objeto na "extensions.runtimes" matriz, cujo "id" é "CommandsRuntime".

  5. A "extensions.ribbons.tabs.groups.controls" matriz tem dois objetos. Exclua a segunda, cujo "id" é "ActionButton".

Configurar o painel de tarefas

  1. No projeto, navegue até a pasta do painel de tarefas e abra taskpane.html.

  2. Substitua todo o <body> elemento pela seguinte marcação.

    <body class="ms-font-m ms-welcome ms-Fabric">
    <header class="ms-welcome__header ms-bgColor-neutralLighter">
        <img width="90" height="90" src="../../assets/logo-filled.png" alt="logo" title="Add-in logo" />
        <h1 class="ms-font-su">Activate your add-in without enabling the Reading Pane or selecting a message</h1>
    </header>
    <section id="sideload-msg" class="ms-welcome__main">
        <h2 class="ms-font-xl">Please <a target="_blank" href="https://learn.microsoft.com/office/dev/add-ins/testing/test-debug-office-add-ins#sideload-an-office-add-in-for-testing">sideload</a> your add-in to see app body.</h2>
    </section>
    <main id="app-body" class="ms-welcome__main" style="display: none;">
        <ul class="ms-List ms-welcome__features">
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--CheckList ms-font-xl"></i>
                <span class="ms-font-m">Item multi-select is automatically enabled when the <b>SupportsNoItemContext</b> manifest element is set to <code>true</code>. You can test this by selecting multiple messages in Outlook, then choosing <b>Show Taskpane</b> from the ribbon.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Pin ms-font-xl"></i>
                <span class="ms-font-m">Support to pin the task pane is also automatically enabled. You can test this by selecting the <b>pin</b> icon from the top right corner of the task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--DockRight ms-font-xl"></i>
                <span class="ms-font-m">This feature can only be implemented with a task pane.</span>
            </li>
            <li class="ms-ListItem">
                <i class="ms-Icon ms-Icon--Design ms-font-xl"></i>
                <span class="ms-font-m">Implement your scenario using this feature today! For example, enable your users to access content from different data sources, such as OneDrive or your customer relationship management (CRM) system, without first selecting a message.</span>
            </li>
        </ul>
    </main>
</body>

  3. Salve suas alterações.

Atualizar o arquivo JavaScript do painel de tarefas

  1. Na pasta do painel de tarefas , abra taskpane.js.

  2. Navegue até a Office.onReady função e substitua seu conteúdo pelo código a seguir.

    if (info.host === Office.HostType.Outlook) {
    document.getElementById("sideload-msg").style.display = "none";
    document.getElementById("app-body").style.display = "flex";
}

  3. Salve suas alterações.

Experimente

  1. Em um terminal, execute o código a seguir no diretório raiz do seu projeto. Isso inicia o servidor Web local e faz o sideload do suplemento.

    npm start

    Observação

    • Quando você usa o gerador Yeoman pela primeira vez para desenvolver um suplemento do Office, seu navegador padrão abre uma janela onde você será solicitado a entrar em sua conta do Microsoft 365. Se uma janela de entrada não for exibida e você encontrar um erro de sideload ou tempo limite de logon, execute atk auth login m365 antes de executar npm start novamente.

    • Se o suplemento não foi carregado automaticamente, siga as instruções em Fazer sideload de suplementos do Outlook para testar o sideload manual do suplemento no Outlook.

  2. Navegue até sua caixa de entrada e siga um destes procedimentos:

    • Desative o Painel de Leitura. Para obter orientação, consulte a seção "Ativar, desativar ou mover o Painel de Leitura" de Usar e configurar o Painel de Leitura para visualizar mensagens.
    • Desmarque uma mensagem, se aplicável. Para desmarcar uma mensagem, mantenha pressionada a tecla Ctrl e selecione a mensagem.

  3. Selecione Mostrar Painel de Tarefas na faixa de opções.

  4. Explore e teste as sugestões listadas no painel de tarefas.

  5. Quando você 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 você usou npm start, o comando a seguir também deve desinstalar o suplemento.

      npm stop

    • Se você carregou manualmente o suplemento, consulte Remover um suplemento com sideload.

Suporte para os recursos do painel de tarefas fixável e seleção múltipla de itens

Habilitar o suporte para nenhum contexto de item no manifesto habilita automaticamente o suporte para recursos de painel de tarefas fixáveis e seleção múltipla de itens, mesmo que esses recursos não estejam explicitamente configurados no manifesto.

Suporte a recursos no Outlook na Web e no novo Outlook no Windows

No Outlook na Web e no novo Outlook no Windows, os suplementos que não implementam nenhum contexto de item não são ativados quando o Painel de Leitura está oculto ou quando uma mensagem não está selecionada. Isso ocorre porque os comandos de suplemento no Outlook na Web não aparecem na faixa de opções. Para ativar um suplemento na superfície de Leitura de Mensagens, primeiro você deve selecionar uma mensagem e, em seguida, selecionar o comando do suplemento na barra de ações da mensagem.

Como habilitar nenhum contexto de item habilita automaticamente o recurso de seleção múltipla de item, você poderá ativar seu suplemento no Outlook na Web e no novo Outlook no Windows em vários itens de email.

Confira também

  • Last updated on