Office.MailboxEvent interface

Paquet:
outlook

L’objet MailboxEvent est transmis en tant qu’argument au gestionnaire d’événements d’un complément qui implémente l’activation basée sur les événements, y compris les alertes intelligentes, la fonctionnalité intégrée de signalement de courrier indésirable ou le déchiffrement. Cela permet au complément d’indiquer au client Outlook qu’il a terminé le traitement d’un événement.

Remarques

Jeu d’API : Boîte aux lettres 1.10

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Rédiger ou Lire

Important:

  • La prise en charge de la fonctionnalité intégrée de signalement du courrier indésirable a été introduite dans la boîte aux lettres 1.14.

  • La prise en charge de la fonction de déchiffrement a été introduite dans la boîte aux lettres 1.16.

  • Pour plus d’informations sur l’objet Event utilisé par le bouton de commande de fonction, le complément à l’envoi, le complément du fournisseur de réunion en ligne et le complément mobile de journalisation des notes, consultez Office.AddinCommands.Event.

Méthodes

completed(options)

Indique que le complément basé sur l’événement, de signalement de courrier indésirable ou de déchiffrement a terminé de traiter un événement.

Détails de la méthode

completed(options)

Indique que le complément basé sur l’événement, de signalement de courrier indésirable ou de déchiffrement a terminé de traiter un événement.

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

Paramètres

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions | Office.MessageDecryptEventCompletedOptions

Facultatif. Objet qui spécifie le comportement d’un complément basé sur un événement, de déclaration de courrier indésirable ou de déchiffrement lorsqu’il termine de traiter un événement.

Retours

void

Remarques

Jeu d’API : Boîte aux lettres 1.10

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Rédiger ou Lire

Important:

  • La prise en charge de la fonctionnalité intégrée de signalement du courrier indésirable a été introduite dans la boîte aux lettres 1.14.

  • La prise en charge de l’affectation d’un SmartAlertsEventCompletedOptions objet au paramètre a été introduite dans la options boîte aux lettres 1.12.

  • La prise en charge de la fonction de déchiffrement a été introduite dans la boîte aux lettres 1.16.

Exemples

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