Office.AddinCommands.EventCompletedOptions interface

  • Référence
Paquet:
office

Spécifie le comportement d’un complément d’envoi dans Outlook lorsqu’il termine le traitement d’un ItemSend événement.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Composer

Propriétés

allowEvent

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément d’envoi qui gère l’événement peut définir allowEventfalse sur ItemSend pour annuler l’envoi d’un message.

Détails de la propriété

allowEvent

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement géré doit poursuivre l’exécution ou être annulé. Par exemple, un complément d’envoi qui gère l’événement peut définir allowEventfalse sur ItemSend pour annuler l’envoi d’un message.

allowEvent?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 ]

Niveau d’autorisation minimal (Outlook) : restreint

Mode Outlook applicable : Composer

Exemples

// In this example, the checkMessage function was registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    const outgoingMsg = Office.context.mailbox.item;

    // Check if subject contains "BLOCK".
    outgoingMsg.subject.getAsync(function (result) {
        // Subject is in `result.value`.
        // If search term "BLOCK" is found, don't send the message.
        const notFound = -1;
        const allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({ allowEvent: allowEvent });
    });
}