Compartilhar via

Office.SpamReportingEventCompletedOptions interface

  • Referência
Pacote:
outlook

Especifica o comportamento de um suplemento integrado de relatórios de spam depois de concluir o processamento de um evento SpamReporting .

Comentários

[ Conjunto de API: Caixa de Correio 1.14 ]

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

Modo Outlook aplicável: Leitura da 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 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.
moveItemTo

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

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

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

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.

Detalhes da propriedade

folderName

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

string

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.

moveItemTo

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

Office.MailboxEnums.MoveSpamItemTo

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.

onErrorDeleteItem

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

boolean

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

postProcessingAction

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

string

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.",
            },
        });
    });
}

showPostProcessingDialog

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

object

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