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, la característica integrada de informes de correo no deseado o el descifrado. Permite que el complemento indique al cliente de Outlook que ha terminado de procesar un evento.

Comentarios

Conjunto de API: Buzón 1.10

Nivel mínimo de permisos: Restringido

Modo de Outlook aplicable: Componer o leer

Importante:

  • La compatibilidad con la función integrada de informes de spam se introdujo en el buzón 1.14.

  • La compatibilidad con la característica de descifrado se introdujo en el buzón 1.16.

  • Para obtener información sobre el objeto Event usado por el botón de comando de función, el complemento al enviar, el complemento del proveedor de reuniones en línea y el complemento móvil de registro de notas, consulte Office.AddinCommands.Event.

Métodos

completed(options)

Indica que el complemento de descifrado, notificación 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 descifrado, notificación de correo no deseado o basado en eventos ha completado el procesamiento de un evento.

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

Parámetros

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions | Office.MessageDecryptEventCompletedOptions

Opcional. Objeto que especifica el comportamiento de un complemento de descifrado, notificación de correo no deseado o basado en eventos cuando termina de procesar un evento.

Devoluciones

void

Comentarios

Conjunto de API: Buzón 1.10

Nivel mínimo de permisos: Restringido

Modo de Outlook aplicable: Componer o leer

Importante:

  • La compatibilidad con la función integrada de informes de spam se introdujo en el buzón 1.14.

  • La compatibilidad para asignar un SmartAlertsEventCompletedOptions objeto al parámetro se introdujo en el options buzón 1.12.

  • La compatibilidad con la característica de descifrado se introdujo en el buzón 1.16.

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