Office.SpamReportingEventCompletedOptions interface

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade especifica a ID do painel de tarefas que é aberto após o processamento da mensagem.

commandId?: string;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.15

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante:

• Para saber como implementar a commandId propriedade em seu suplemento de relatório de spam, consulte Abrir um painel de tarefas após relatar uma mensagem.

• O commandId valor deve corresponder à ID do painel de tarefas especificada no manifesto do seu suplemento. No manifesto unificado do Microsoft 365, a ID é especificada na propriedade "id" do objeto "extensions.ribbons.tabs.groups.controls" que representa o painel de tarefas. Em um manifesto id somente de suplemento, a ID é especificada no atributo do elemento Control que representa o painel de tarefas.

• Se você configurar a commandIdevent.completed opção na chamada, uma caixa de diálogo de pós-processamento não será mostrada para o usuário, mesmo que a showPostProcessingDialog opção seja especificada na chamada.

• Para garantir que o painel de tarefas do seu complemento de relatório de spam seja aberto após uma mensagem ser relatada, você deve definir a moveItemTo opção de chamada para Office.MailboxEnums.MoveSpamItemTo.NoMove.event.completed

• Se você implementar um painel de tarefas para ser aberto depois que uma mensagem relatada for processada, quando a event.completed chamada ocorrer, qualquer painel de tarefas aberto ou fixado será fechado.

• A commandId opção está disponível para visualização no Outlook no Mac a partir da Versão 16.103 (Build 25101816). Para testar essa opção, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as compilações beta do Office.

Exemplos

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade especifica todos os dados JSON passados para o painel de tarefas do suplemento após o processamento da mensagem.

contextData?: any;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.15

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante:

• Para saber como implementar a contextData propriedade em seu suplemento de relatório de spam, consulte Abrir um painel de tarefas após relatar uma mensagem.

• Se você especificar a contextData opção em sua event.completed chamada, também deverá atribuir uma ID do painel de tarefas à commandId opção. Caso contrário, os dados JSON atribuídos serão contextData ignorados.

• Se você configurar as commandId opções and contextData na event.completed chamada, uma caixa de diálogo de pós-processamento não será mostrada para o usuário, mesmo que a showPostProcessingDialog opção seja especificada na chamada.

• Para garantir que o painel de tarefas do seu suplemento de relatório de spam seja aberto e receba dados de contexto após uma mensagem ser relatada, você deve definir a moveItemToevent.completed opção da chamada para Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Se você implementar um painel de tarefas para ser aberto depois que uma mensagem relatada for processada, quando a event.completed chamada ocorrer, qualquer painel de tarefas aberto ou fixado será fechado.

• Para evitar que o painel de tarefas de um suplemento de relatório de spam seja reiniciado se já estiver aberto, implemente um manipulador para o Office.EventType.InitializationContextChanged evento. Em seguida, você pode passar os argumentos de evento para a contextData propriedade.

• Para recuperar o contextData valor da propriedade, você deve chamar Office.context.mailbox.item.getInitializationContextAsync a implementação JavaScript do painel de tarefas. Se você criar uma cadeia de caracteres JSON usando JSON.stringify() e atribuí-la à contextData propriedade, deverá analisar a cadeia de caracteres usando JSON.parse() uma vez que você recuperá-la.

• A contextData opção está disponível para visualização no Outlook no Mac a partir da Versão 16.103 (Build 25101816). Para testar essa opção, ingresse no programa Microsoft 365 Insider e selecione a opção Canal Beta para acessar as compilações beta do Office.

Exemplos

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade especifica a pasta da caixa de correio do Outlook para a qual a mensagem será movida.

folderName?: string;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.14

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante:

• Se a pasta especificada ainda não existir, ela será criada antes que a mensagem seja movida.

• Se a postProcessingAction propriedade estiver definida como moveToCustomFolder, ela folderName deverá ser especificada. Caso contrário, a mensagem relatada será movida para a pasta Lixo Eletrônico de Email da caixa de correio. Se postProcessingAction estiver definido como outra ação que não moveToCustomFolderseja , a folderName propriedade será ignorada.

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.14

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante:

• Você só pode usar essa propriedade em um suplemento de relatório de spam no Outlook na Web, no Windows (novo e clássico (a partir da versão 2308, Build 16724.10000)) e no Mac. Se você estiver usando uma compilação anterior do Outlook clássico no Windows que dê suporte ao recurso integrado de relatório de spam, use a postProcessingAction propriedade.

• Se a propriedade estiver definida como Office.MailboxEnums.MoveSpamItemTo.CustomFolder, você deverá especificar o nome da pasta para a qual a mensagem será movida na folderName propriedade da event.completed chamada. Caso contrário, a moveItemTo propriedade usará como padrão Office.MailboxEnums.MoveSpamItemTo.JunkFolder e moverá a mensagem relatada para a pasta Lixo Eletrônico Email.

• Se você configurar as commandId opções e contextData na event.completed chamada para abrir um painel de tarefas depois que um usuário selecionar a opção Relatório na caixa de diálogo de pré-processamento, você deverá definir a moveItemTo opção como Office.MailboxEnums.MoveSpamItemTo.NoMove. Caso contrário, o painel de tarefas não será aberto.

Quando definido como true, exclui uma mensagem relatada se ocorrer um erro enquanto a mensagem é processada. Se essa propriedade estiver definida como false ou não for especificada no método concluído, a mensagem relatada permanecerá em sua pasta de caixa de correio atual.

onErrorDeleteItem?: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.14

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio. As seguintes ações de pós-processamento estão disponíveis.

• delete - Move a mensagem relatada para a pasta Itens Excluídos da caixa de correio.

• moveToCustomFolder - Move a mensagem relatada para uma pasta especificada. Você deve especificar o nome da pasta na folderName propriedade.

• moveToSpamFolder- Move a mensagem relatada para a pasta Lixo Eletrônico de Email da caixa de correio.

• noMove - Deixa a mensagem relatada em sua pasta atual.

postProcessingAction?: string;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.14

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante:

• No Outlook no Windows, você só pode usar essa propriedade em compilações anteriores que dão suporte ao recurso integrado de relatório de spam. Se você estiver na versão 2308 (build 16724.10000) ou posterior, use a moveItemTo propriedade.

• Esta propriedade não é compatível com o Outlook na Web, no Mac ou no novo Outlook no Windows. Em vez disso, use a moveItemTo propriedade.

• Se a propriedade estiver definida como moveToCustomFolder, você deverá especificar o nome da pasta para a qual a mensagem será movida na folderName propriedade da event.completed chamada. Caso contrário, a postProcessingAction propriedade usará como padrão moveToSpamFolder e moverá a mensagem relatada para a pasta Lixo Eletrônico Email.

Exemplos

// The following example handles a SpamReporting event to process a reported spam or phishing message.
function onSpamReport(event) {
    // Gets the Base64-encoded EML format of a reported message.
    Office.context.mailbox.item.getAsFileAsync({ asyncContext: event }, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(`Error encountered during message processing: ${asyncResult.error.message}`);
            return;
        }

        // Run additional processing operations here.

        /**
         * Signals that the spam-reporting event has completed processing.
         * It then moves the reported message to the Junk Email folder of the mailbox and shows a
         * post-processing dialog to the user.
         */
        const event = asyncResult.asyncContext;
        event.completed({
            postProcessingAction: "moveToSpamFolder",
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

Quando você usa o método concluído para sinalizar que uma mensagem relatada concluiu o processamento, essa propriedade indica se uma caixa de diálogo de pós-processamento é exibida para o usuário. O objeto JSON atribuído a esta propriedade deve conter um título e uma descrição. Se essa propriedade não for especificada, uma caixa de diálogo não será mostrada para o usuário depois que a mensagem relatada for processada.

showPostProcessingDialog?: object;

Valor da propriedade

Comentários

Conjunto de APIs: Caixa de Correio 1.14

Nível mínimo de permissão (Outlook):ler item

Modo do Outlook aplicável: Leitura de Mensagem

Importante: se você configurar as commandId opções e contextData na event.completed chamada para abrir um painel de tarefas depois que um usuário selecionar a opção Relatório na caixa de diálogo de pré-processamento, uma caixa de diálogo de pós-processamento não será mostrada para o usuário. Esse comportamento se aplica mesmo se for showPostProcessingDialog especificado na event.completed chamada.