Office.MailboxEvent interface

  • Referência
Pacote:
outlook

O MailboxEvent objeto é transmitido como um argumento para o processador de eventos de um suplemento que implementa a ativação baseada em eventos, incluindo Alertas Inteligentes ou a funcionalidade integrada de relatórios de spam. Permite ao suplemento significar ao cliente do Outlook que concluiu o processamento de um evento.

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compor ou Ler

Importante: o suporte para a funcionalidade integrada de relatórios de spam foi introduzido na Caixa de Correio 1.14.

Métodos

completed(options)

Indica que o suplemento baseado em eventos ou de relatórios de spam concluiu o processamento de um evento.

Detalhes do método

completed(options)

Indica que o suplemento baseado em eventos ou de relatórios de spam concluiu o processamento de um evento.

completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;

Parâmetros

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions

Opcional. Um objeto que especifica o comportamento de um suplemento baseado em eventos ou de relatórios de spam quando conclui o processamento de um evento.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.10 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compor ou Ler

Importante:

  • O suporte para a funcionalidade integrada de relatórios de spam foi introduzido na Caixa de Correio 1.14.

  • O suporte para atribuir um SmartAlertsEventCompletedOptions objeto ao options parâmetro foi introduzido na Caixa de Correio 1.12.

Exemplos

// The following example sets the subject when a new message is composed.
function onNewMessageComposeHandler(event) {
    const subject = "Set by an event-based add-in!";
    Office.context.mailbox.item.subject.setAsync(
        subject,
        {
            asyncContext: event,
        },
        (asyncResult) => {
            const event = asyncResult.asyncContext;
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                console.error("Failed to set subject: " + asyncResult.error.message);
                event.completed();
                return;
            }

            // Signal to the Outlook client that the event has been processed.
            console.log("Successfully set the subject.");
            event.completed();
        }
    );
}