Office.MailboxEvent interface

Paket:

outlook

Das MailboxEvent -Objekt wird als Argument an den Ereignishandler eines Add-Ins übergeben, das die ereignisbasierte Aktivierung implementiert, einschließlich intelligenter Warnungen oder der integrierten Spamberichterstattungsfunktion. Es ermöglicht dem Add-In, dem Outlook-Client zu signalisieren, dass die Verarbeitung eines Ereignisses abgeschlossen wurde.

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Die Unterstützung für das integrierte Spam-Reporting-Feature wurde in Mailbox 1.14 eingeführt.

Methoden

completed(options)

Gibt an, dass das ereignisbasierte Add-In oder das Add-In für die Spamberichterstattung die Verarbeitung eines Ereignisses abgeschlossen hat.

Details zur Methode

completed(options)

Gibt an, dass das ereignisbasierte Add-In oder das Add-In für die Spamberichterstattung die Verarbeitung eines Ereignisses abgeschlossen hat.

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

Parameter

options

Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions

Optional. Ein -Objekt, das das Verhalten eines ereignisbasierten Add-Ins oder eines Add-Ins zur Spamberichterstattung angibt, wenn es die Verarbeitung eines Ereignisses abgeschlossen hat.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

• Die Unterstützung für die integrierte Spamberichterstattungsfunktion wurde in Mailbox 1.14 eingeführt.

• Die Unterstützung zum Zuweisen eines SmartAlertsEventCompletedOptions Objekts zum options Parameter wurde in Mailbox 1.12 eingeführt.

Beispiele

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