Office.MailboxEvent interface

  • Référence
Paquet:
outlook

L’objet MailboxEvent est passé 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, ou la fonctionnalité intégrée de création de rapports de courrier indésirable. Il permet au complément de signifier au client Outlook qu’il a terminé le traitement d’un événement.

Remarques

[ Ensemble 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 création de rapports de courrier indésirable a été introduite dans la boîte aux lettres 1.14.

Méthodes

completed(options)

Indique que le complément basé sur les événements ou la création de rapports de courrier indésirable a terminé le traitement d’un événement.

Détails de la méthode

completed(options)

Indique que le complément basé sur les événements ou la création de rapports de courrier indésirable a terminé le traitement d’un événement.

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

Paramètres

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions

Optional. Objet qui spécifie le comportement d’un complément basé sur des événements ou de création de rapports de courrier indésirable lorsqu’il termine le traitement d’un événement.

Retours

void

Remarques

[ Ensemble 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 création de rapports de courrier indésirable a été introduite dans Mailbox 1.14.

  • La prise en charge de l’affectation d’un SmartAlertsEventCompletedOptions objet au options paramètre a été introduite dans mailbox 1.12.

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