Office.MailboxEvent interface
Das MailboxEvent Objekt wird als Argument an den Ereignishandler eines Add-Ins übergeben, der die ereignisbasierte Aktivierung implementiert, einschließlich intelligenter Warnungen, der integrierten Spamberichtsfunktion oder der Entschlüsselung. Dadurch kann das Add-In dem Outlook-Client anzeigen, dass die Verarbeitung eines Ereignisses abgeschlossen ist.
Hinweise
Mindestberechtigungsstufe: Eingeschränkt
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Die Unterstützung für die integrierte Spamberichterstattung wurde mit Postfach 1.14 eingeführt.
Die Unterstützung für das Entschlüsselungsfeature wurde in Postfach 1.16 eingeführt.
Informationen zum Ereignisobjekt, das von der Funktion Befehlsschaltfläche, dem On-Senden-Add-In, dem Onlinebesprechungsanbieter-Add-In und dem mobilen Add-In für die Notizprotokollierung verwendet wird, finden Sie unter Office.AddinCommands.Event.
Methoden
| completed(options) | Gibt an, dass das Add-In für ereignisbasierte, Spam-Berichterstellung oder Entschlüsselung die Verarbeitung eines Ereignisses abgeschlossen hat. |
Details zur Methode
completed(options)
Gibt an, dass das Add-In für ereignisbasierte, Spam-Berichterstellung oder Entschlüsselung die Verarbeitung eines Ereignisses abgeschlossen hat.
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void;Parameter
- options
-
Office.SmartAlertsEventCompletedOptions | Office.SpamReportingEventCompletedOptions | Office.MessageDecryptEventCompletedOptions
Optional. Ein Objekt, das das Verhalten eines ereignisbasierten, Spam-Berichts- oder Entschlüsselungs-Add-Ins angibt, wenn die Verarbeitung eines Ereignisses abgeschlossen ist.
Gibt zurück
void
Hinweise
Mindestberechtigungsstufe: Eingeschränkt
Anwendbarer Outlook-Modus: Compose oder Lesen
Wichtig:
Die Unterstützung für die integrierte Spamberichterstattung wurde mit Postfach 1.14 eingeführt.
Die Unterstützung für die
optionsZuweisung einesSmartAlertsEventCompletedOptionsObjekts zum Parameter wurde in Mailbox 1.12 eingeführt.Die Unterstützung für das Entschlüsselungsfeature wurde in Postfach 1.16 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();
}
);
}