Share via

Office.SpamReportingEventCompletedOptions interface

  • Referência
Pacote:
outlook

Especifica o comportamento de um suplemento integrado de relatório de spam depois que ele conclui o processamento de um evento spamReporting .

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: Leitura de mensagem

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 a custom mailbox folder named "Reported Messages"
        * and shows a post-processing dialog to the user.
        * If an error occurs while the message is being processed, the `onErrorDeleteItem`
        * property determines whether the message will be deleted.
        */
        const event = asyncResult.asyncContext;
        event.completed({
            moveItemTo: Office.MailboxEnums.MoveSpamItemTo.CustomFolder,
            folderName: "Reported Messages",
            onErrorDeleteItem: true,
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

Propriedades

folderName

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

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

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.
postProcessingAction

Quando você usa o método concluído para sinalizar que uma mensagem relatada terminou o processamento, essa propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio. As seguintes ações 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 Junk Email da caixa de correio.

  • noMove – deixa a mensagem relatada em sua pasta atual.
showPostProcessingDialog

Quando você usa o método concluído para sinalizar que uma mensagem relatada terminou o processamento, essa propriedade indica se uma caixa de diálogo pós-processamento é mostrada ao usuário. O objeto JSON atribuído a essa 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 ao usuário depois que a mensagem relatada for processada.

Detalhes da propriedade

folderName

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

folderName?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

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

Modo 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, a folderName propriedade deverá ser especificada. Caso contrário, a mensagem relatada será movida para a pasta Junk Email da caixa de correio. Se postProcessingAction for definida como outra ação diferente de moveToCustomFolder, a folderName propriedade será ignorada.

moveItemTo

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

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valor da propriedade

Office.MailboxEnums.MoveSpamItemTo

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

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

Modo outlook aplicável: Leitura de mensagem

Importante:

  • Você só pode usar essa propriedade em um suplemento de relatório de spam em Outlook na Web, no Windows (começando na versão 2308 (Build 16724.10000)), no Mac e no novo Outlook no Windows (versão prévia). Se você estiver usando um build anterior no Outlook no Windows que dá suporte ao recurso integrado de relatório de spam, use a postProcessingAction propriedade em vez disso.

  • 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 será padrão para Office.MailboxEnums.MoveSpamItemTo.JunkFolder e moverá a mensagem relatada para a pasta Junk Email.

onErrorDeleteItem

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

boolean

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

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

Modo outlook aplicável: Leitura de mensagem

postProcessingAction

Quando você usa o método concluído para sinalizar que uma mensagem relatada terminou o processamento, essa propriedade especifica se a mensagem é movida para uma pasta diferente na caixa de correio. As seguintes ações 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 Junk Email da caixa de correio.

  • noMove – deixa a mensagem relatada em sua pasta atual.

postProcessingAction?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

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

Modo outlook aplicável: Leitura de mensagem

Importante:

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

  • Essa propriedade não tem suporte no Outlook na Web, no Mac ou no novo Outlook no Windows (versão prévia). 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 será padrão para moveToSpamFolder e moverá a mensagem relatada para a pasta Junk 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.",
            },
        });
    });
}

showPostProcessingDialog

Quando você usa o método concluído para sinalizar que uma mensagem relatada terminou o processamento, essa propriedade indica se uma caixa de diálogo pós-processamento é mostrada ao usuário. O objeto JSON atribuído a essa 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 ao usuário depois que a mensagem relatada for processada.

showPostProcessingDialog?: object;

Valor da propriedade

object

Comentários

[ Conjunto de API: Caixa de correio 1.14 ]

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

Modo outlook aplicável: Leitura de mensagem

Importante: no Outlook na Web ou no novo Outlook no Windows (versão prévia), uma caixa de diálogo pós-processamento não é mostrada depois que o suplemento concluir o processamento de uma mensagem relatada. Isso se aplica mesmo se showPostProcessingDialog estiver configurado. No entanto, dependendo de como você configurou a moveItemTo propriedade na event.completed chamada, uma notificação é mostrada para sinalizar quando a mensagem relatada é excluída ou movida para outra pasta na caixa de correio. Para saber mais, confira a seção "Revisar o comportamento e as limitações do recurso" de Implementar um suplemento integrado de relatório de spam.