Office.SpamReportingEventCompletedOptions interface

Quando utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta propriedade especifica o ID do painel de tarefas que é aberto após o processamento da mensagem.

commandId?: string;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.15 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Importante:

• Para saber como implementar a commandId propriedade no seu suplemento spam-reporting, consulte Abrir um painel de tarefas depois de comunicar uma mensagem.

• O commandId valor tem de corresponder ao ID do painel de tarefas especificado no manifesto do seu suplemento. No manifesto unificado do Microsoft 365, o ID é especificado na propriedade "id" do objeto "extensions.ribbons.tabs.groups.controls" que representa o painel de tarefas. Num manifesto apenas de suplemento, o ID é especificado no id atributo do elemento Controlo que representa o painel de tarefas.

• Se configurar a opção commandId na event.completed chamada, uma caixa de diálogo pós-processamento não é apresentada ao utilizador, mesmo que a opção showPostProcessingDialog seja especificada na chamada.

• Para garantir que o painel de tarefas do suplemento spam-reporting é aberto depois de uma mensagem ser comunicada, tem de definir a opção moveItemTo da event.completed chamada como Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Se implementar um painel de tarefas para abrir depois de uma mensagem reportada ser processada, quando a event.completed chamada ocorre, qualquer painel de tarefas aberto ou afixado é fechado.

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 utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta propriedade especifica quaisquer dados JSON transmitidos para o painel de tarefas do suplemento após o processamento da mensagem.

contextData?: any;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.15 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Importante:

• Para saber como implementar a contextData propriedade no seu suplemento spam-reporting, consulte Abrir um painel de tarefas depois de comunicar uma mensagem.

• Se especificar a opção contextData na sua event.completed chamada, também tem de atribuir um ID do painel de tarefas à opção commandId . Caso contrário, os dados JSON atribuídos a contextData são ignorados.

• Se configurar as commandId opções e contextData na event.completed chamada, uma caixa de diálogo pós-processamento não é apresentada ao utilizador, mesmo que a opção showPostProcessingDialog seja especificada na chamada.

• Para garantir que o painel de tarefas do suplemento spam-reporting é aberto e recebe dados de contexto após a comunicação de uma mensagem, tem de definir a opção moveItemTo da event.completed chamada como Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Se implementar um painel de tarefas para abrir depois de uma mensagem reportada ser processada, quando a event.completed chamada ocorre, qualquer painel de tarefas aberto ou afixado é fechado.

• Para impedir que o painel de tarefas de um suplemento spam-reporting seja reiniciado se já estiver aberto, implemente um processador para o Office.EventType.InitializationContextChanged evento. Em seguida, pode transmitir os argumentos do evento para a contextData propriedade .

• Para obter o valor da contextData propriedade, tem de chamar Office.context.mailbox.item.getInitializationContextAsync na implementação JavaScript do painel de tarefas. Se criar uma cadeia JSON com JSON.stringify() e atribuí-la à contextData propriedade, tem de analisar a cadeia com JSON.parse() uma vez obtê-la.

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 utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta 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 API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Importante:

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

• Se a postProcessingAction propriedade estiver definida como moveToCustomFolder, a folderName propriedade tem de ser especificada. Caso contrário, a mensagem comunicada é movida para a pasta Email de Lixo da caixa de correio. Se postProcessingAction estiver definida para outra ação diferente de moveToCustomFolder, a folderName propriedade é ignorada.

Quando utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Importante:

• Só pode utilizar esta propriedade num suplemento de relatórios de spam no Outlook na Web, no Windows (novo e clássico (a partir da Versão 2308, Compilação 16724.10000)) e no Mac. Se estiver a utilizar uma compilação anterior do Outlook clássico no Windows que suporte a funcionalidade de relatórios de spam integrada, utilize a postProcessingAction propriedade .

• Se a propriedade estiver definida como Office.MailboxEnums.MoveSpamItemTo.CustomFolder, tem de 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 irá predefinir Office.MailboxEnums.MoveSpamItemTo.JunkFolder e mover a mensagem comunicada para a pasta Email de Lixo.

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

Quando definida como true, elimina uma mensagem comunicada se ocorrer um erro enquanto a mensagem é processada. Se esta propriedade estiver definida como false ou não for especificada no método concluído, a mensagem comunicada permanece na pasta da caixa de correio atual.

onErrorDeleteItem?: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Quando utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio. Estão disponíveis as seguintes ações pós-processamento.

• delete - Move a mensagem comunicada para a pasta Itens Eliminados da caixa de correio.

• moveToCustomFolder - Move a mensagem comunicada para uma pasta especificada. Tem de especificar o nome da pasta na folderName propriedade .

• moveToSpamFolder- Move a mensagem comunicada para a pasta Email de Lixo da caixa de correio.

• noMove - Deixa a mensagem comunicada na pasta atual.

postProcessingAction?: string;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da Mensagem

Importante:

• No Outlook no Windows, só pode utilizar esta propriedade em compilações anteriores que suportem a funcionalidade de relatórios de spam integrada. Se estiver na Versão 2308 (Compilação 16724.10000) ou posterior, utilize a moveItemTo propriedade.

• Esta propriedade não é suportada no Outlook na Web, no Mac ou no novo Outlook no Windows. Em alternativa, utilize a moveItemTo propriedade .

• Se a propriedade estiver definida como moveToCustomFolder, tem de 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 irá predefinir moveToSpamFolder e mover a mensagem comunicada para a pasta Email de Lixo.

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 utiliza o método concluído para sinalizar que uma mensagem comunicada terminou o processamento, esta propriedade indica se é apresentada uma caixa de diálogo pós-processamento ao utilizador. O objeto JSON atribuído a esta propriedade tem de conter um título e uma descrição. Se esta propriedade não for especificada, uma caixa de diálogo não será apresentada ao utilizador assim que a mensagem comunicada for processada.

showPostProcessingDialog?: object;

Valor da propriedade

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da Mensagem

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