Outlook Add-In-API-Anforderungssatz 1.14

Die Outlook-Add-In-API-Teilmenge der Office JavaScript-API enthält Objekte, Methoden, Eigenschaften und Ereignisse, die Sie in einem Outlook-Add-In verwenden können.

Hinweis

Diese Dokumentation bezieht sich auf einen anderen Anforderungssatz als den aktuellen.

Neuigkeiten in Version 1.14

Postfachanforderungssatz 1.14 enthält alle Features des Anforderungssatzes 1.13. Zusätzlich wurden die folgenden Funktionen implementiert.

  • Die integrierte Spam-Berichtfunktion wurde hinzugefügt.
  • Es wurde eine Methode zum Abrufen der Base64-Kodierung einer Nachricht hinzugefügt.
  • Es wurde eine Methode zum Abrufen der URL der JavaScript-Laufzeit eines Add-Ins hinzugefügt.
  • Unterstützung zum Anpassen des Schaltflächentexts und zum Konfigurieren eines Aufgabenbereichs für die Option "Nicht senden " eines Smart Alerts-Dialogfelds hinzugefügt.
  • Unterstützung hinzugefügt, um die Option für den Sendemodus eines Smart Alerts-Add-Ins zur Laufzeit außer Kraft zu setzen.
  • Mitglieder hinzugefügt, um zusätzliche Eigenschaften einer Nachricht im Verfassungsmodus abzurufen.
  • Es wurde eine Methode zum Schließen einer aktuellen Nachricht hinzugefügt, die verfasst wurde, mit der Option, nicht gespeicherte Änderungen zu verwerfen.
  • Zusätzliche E-Mail-Elementeigenschaften für die Mehrfachauswahl von Elementen hinzugefügt.
  • Unterstützung zur Identifizierung des aktuellen Office-Designs eines Outlook-Clients wurde hinzugefügt.
  • Unterstützung zum Abrufen und Festlegen der Vertraulichkeitsstufe eines Termins hinzugefügt.

API-Liste

In der folgenden Tabelle sind die APIs aufgeführt, die im Postfach-Anforderungssatz 1.14 eingeführt wurden. Die API-Referenzdokumentation für alle APIs, die vom Postfachanforderungssatz 1.14 oder früher unterstützt werden, finden Sie unter Outlook-APIs.

Klasse Felder Beschreibung
AppointmentCompose Vertraulichkeit Ruft die Vertraulichkeitsstufe eines Termins ab oder legt sie fest.
AppointmentRead Vertraulichkeit Stellt den Vertraulichkeitswert des Termins bereit.
MailboxEvent completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions) Gibt an, dass das Add-In für ereignisbasierte, Spam-Berichterstellung oder Entschlüsselung die Verarbeitung eines Ereignisses abgeschlossen hat.
MessageCompose closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Schließt die aktuelle neue Nachricht, die verfasst wird.
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Schließt die aktuelle Nachricht mit der Option, nicht gespeicherte Änderungen zu verwerfen.
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
inReplyTo Ruft die Internetnachrichten-ID der ursprünglichen Nachricht ab, auf die von der aktuellen Nachricht geantwortet wird.
MessageRead getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.
AppointmentSensitivityType Vertraulich Behandeln Sie den Artikel vertraulich.
Standard Der Artikel benötigt keine besondere Behandlung.
Personal Behandeln Sie das Element als persönlich.
Privat Behandeln Sie das Element als privat.
MoveSpamItemTo CustomFolder Gibt an, dass eine gemeldete Nachricht in einen benutzerdefinierten Ordner im Postfach verschoben wird.
DeletedItemsFolder Gibt an, dass eine gemeldete Nachricht in den Ordner "Gelöschte Elemente" des Postfachs verschoben wird.
JunkFolder Gibt an, dass eine gemeldete Nachricht in den Ordner "Junk-E-Mail" des Postfachs verschoben wird.
NoMove Gibt an, dass eine gemeldete Nachricht in ihrem aktuellen Ordner im Postfach verbleibt.
SendModeOverride PromptUser Stellt die Option "Trotzdem senden " in einem intelligenten Benachrichtigungsdialogfeld bereit, wenn das E-Mail-Element die Bedingungen des ereignisbasierten Add-Ins nicht erfüllt.
OfficeThemeChangedEventArgs officeTheme Ruft das aktualisierte Office-Design ab.
type Ruft den Typ des Ereignisses ab.
SelectedItemDetails conversationId Der Bezeichner der Nachrichtenkonversation, die die aktuell ausgewählte Nachricht enthält.
hasAttachment Gibt zurück true , wenn die aktuell ausgewählte Nachricht eine Anlage enthält.
internetMessageId Der Internetnachrichten-Bezeichner der aktuell ausgewählten Nachricht.
Sensitivity getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) Ruft die Vertraulichkeitsstufe eines Termins ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) Ruft die Vertraulichkeitsstufe eines Termins ab.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt die Vertraulichkeitsstufe eines Termins fest.
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt die Vertraulichkeitsstufe eines Termins fest.
SmartAlertsEventCompletedOptions cancelLabel Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen,
Befehls-ID Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen,
contextData Wenn Sie die abgeschlossene Methode zum
sendModeOverride Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren
SpamReportingEventArgs freeText Der Text, den der Benutzer im Vorverarbeitungsdialog eines Spam-Berichts-Add-Ins bereitgestellt hat.
options Gibt für jede Berichtsoption zurück true , die der Benutzer im Vorverarbeitungsdialogfeld eines Add-Ins für die Spamberichterstattung ausgewählt hat.
type Der Typ des ausgelösten Ereignisses.
SpamReportingEventCompletedOptions folderName Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat,
moveItemTo Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat,
onErrorDeleteItem Wenn diese Einstellung auf festgelegt ist true, löscht eine gemeldete Nachricht, wenn während der Verarbeitung der Nachricht ein Fehler auftritt.
postProcessingAction Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat,
showPostProcessingDialog Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat,

Ereignisse

In der folgenden Tabelle sind die in Anforderungssatz 1.14 eingeführten Ereignisse aufgeführt. Eine Liste aller unterstützten Ereignisse, die mit der addHandlerAsync and-Methode removeHandlerAsync behandelt werden können, finden Sie unter Office.EventType.

Ereignis Beschreibung Object
OfficeThemeChanged Das Office-Design hat sich in Outlook geändert. Postfach
SpamReporting Es wird eine unerwünschte Nachricht gemeldet. Element

Hinweis

Informationen zu Ereignissen, die in einem ereignisbasierten Aktivierungs-Add-In unterstützt werden, finden Sie unter Aktivieren von Add-Ins mit Ereignissen.

Manifestupdates

In der folgenden Tabelle sind die Manifestupdates aufgeführt, die im Postfach-Anforderungssatz 1.14 eingeführt wurden. Weitere Informationen über die Typen von Office-Add-In-Manifesten finden Sie unter Office-Add-In-Manifest.

Feature Einheitliches Manifest für Microsoft 365 Manifest nur für Add-Ins Beschreibung
Berichterstellung für Spam "extensions.ribbons.contexts" Array, das "spamReportingOverride" ReportPhishingCommandSurface Aktiviert ein Spambericht-Add-In in einem auffälligen Abschnitt des Outlook-Menübands.
Berichterstellung für Spam "extensions.ribbons.spamPreProcessingDialog" ReportPhishingCustomization Konfiguriert die Menübandschaltfläche und das Dialogfeld "Vorverarbeitung" eines Add-Ins zur Spam-Meldung.

Siehe auch