Compartir a través de

Office.MailboxEvent interface

Paquete:
outlook

El MailboxEvent objeto se pasa como argumento al controlador de eventos de un complemento que implementa la activación basada en eventos, incluidas las alertas inteligentes o la característica integrada de informes de correo no deseado. Permite que el complemento signifique al cliente de Outlook que ha completado el procesamiento de un evento.

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Compose o lectura

Importante:

Métodos

completed(options)

Indica que el complemento de informes de correo no deseado o basado en eventos ha completado el procesamiento de un evento.

Detalles del método

completed(options)

Indica que el complemento de informes de correo no deseado o basado en eventos ha completado el procesamiento de un evento.

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

Parámetros

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions

Opcional. Objeto que especifica el comportamiento de un complemento de informes de correo no deseado o basado en eventos cuando finaliza el procesamiento de un evento.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.10 ]

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Compose o lectura

Importante:

  • La compatibilidad con la característica integrada de informes de correo no deseado se introdujo en el buzón 1.14.

  • La compatibilidad para asignar un SmartAlertsEventCompletedOptions objeto al options parámetro se introdujo en mailbox 1.12.

Ejemplos

// 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();
        }
    );
}