Outlook Add-In-API-Anforderungssatz 1.15

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.15

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

API-Liste

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

Klasse Felder Beschreibung
AppointmentCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Sendet den Termin, der verfasst wird.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Sendet den Termin, der verfasst wird.
InitializationContextChangedEventArgs initializationContextData Stellt die Daten dar, die über eine umsetzbare Nachricht, eine Benachrichtigungsmeldung, ein Dialogfeld "Intelligente Warnungen" oder ein integriertes Dialogfeld "Umsetzbare" an den Aufgabenbereich eines Add-Ins übergeben werden sollen.
type Stellt den Typ des Ereignisses dar.
LoadedMessageCompose bcc Ruft die Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht ab.
Text Ruft den Text und das Format des Elements ab.
Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
cc Ruft Empfänger in der Cc-Zeile (Durchschlag) einer Nachricht ab.
conversationId Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist.
delayDeliveryTime Ruft das Datum und die Uhrzeit der verspäteten Zustellung einer Nachricht ab.
Von Ruft die E-Mail-Adresse des Absenders einer Nachricht ab.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Ruft die Anlagen des Elements als Array ab.
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) Ruft die Anlagen des Elements als Array ab.
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void) Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an.
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an.
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.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
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.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft asynchron die ID eines gespeicherten Elements ab.
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft asynchron die Exchange-Webdienste-ID (Exchange-Webdienste, EWS) ab
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.
inReplyTo Ruft die Nachrichten-ID der ursprünglichen Nachricht ab, auf die die aktuelle Nachricht antwortet.
internetHeaders Ruft die benutzerdefinierten Internetheader einer Nachricht ab.
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) Ruft ab, ob die Clientsignatur aktiviert ist.
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) Ruft ab, ob die Clientsignatur aktiviert ist.
itemType Ruft den Typ des Elements ab, das eine Instanz darstellt.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
notificationMessages Ruft die Benachrichtigungsmeldungen des Elements ab.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Speichert die aktuelle Nachricht asynchron als Entwurf.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult-Zeichenfolge<>) => void) Speichert die aktuelle Nachricht asynchron als Entwurf.
sensitivityLabel Ruft die Vertraulichkeitsbezeichnung einer Nachricht ab.
seriesId Ruft die ID der Serie ab, zu der eine Instance gehört.
Betreff Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird.
to Ruft die Empfänger in der Zeile "An" einer Nachricht ab.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
LoadedMessageRead attachments Ruft die Anlagen des Elements als Array ab.
Text Ruft den Text und das Format des Elements ab.
Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
cc Ruft Empfänger in der Cc-Zeile (Durchschlag) einer Nachricht ab.
conversationId Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist.
dateTimeCreated Ruft das Datum und die Uhrzeit der Erstellung eines Elements ab.
dateTimeModified Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.
displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des
displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des
displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
end Ruft das Datum und die Uhrzeit ab, zu dem/der der Termin enden soll.
Von Ruft die E-Mail-Adresse des Absenders einer Nachricht ab.
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) Ruft alle Internetheader für die Nachricht als Zeichenfolge ab.
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Ruft alle Internetheader für die Nachricht als Zeichenfolge ab.
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.
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
getRegExMatches() Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind.
getRegExMatchesByName(name: string) Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer XML-Anwendungsmanifestdatei definiert ist.
getSelectedRegExMatches() Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind.
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.
internetMessageId Ruft den Internetnachrichtenbezeichner einer Nachricht ab.
itemClass Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
itemId Ruft die ID des Exchange-Webdienste-Elements ab
itemType Ruft den Typ des Elements ab, das eine Instanz darstellt.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
location Ruft den Speicherort einer Besprechungsanfrage ab.
normalizedSubject Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt werden (einschließlich RE: und FWD:).
notificationMessages Ruft die Benachrichtigungsmeldungen des Elements ab.
Wiederholung Ruft das Serienmuster eines Termins ab.
sender Ruft die E-Mail-Adresse des Absenders einer E-Mail-Nachricht ab.
seriesId Ruft die ID der Serie ab, zu der eine Instance gehört.
start Ruft das Datum und die Uhrzeit ab, zu der der Termin beginnen soll.
Betreff Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird.
to Ruft die Empfänger in der Zeile "An" einer Nachricht ab.
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
Postfach loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Lädt ein einzelnes E-Mail-Element anhand seiner Exchange-Webdienste (EWS)-ID.
loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose | LoadedMessageRead>) => void) Lädt ein einzelnes E-Mail-Element anhand seiner Exchange-Webdienste (EWS)-ID.
MessageCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Sendet die zu verfassende Nachricht.
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Sendet die zu verfassende Nachricht.
AttachmentType Base64-Datenbank Bei der Anlage handelt es sich um eine Base64-codierte Datei.
ReplyFormAttachment Base64-Datei Die Base64-codierte Zeichenfolge der anzufügenden Datei.
SmartAlertsEventCompletedOptions errorMessageMarkdown Wenn Sie die abgeschlossene Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren
SpamReportingEventCompletedOptions Befehls-ID Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat,
contextData 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.15 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
InitializationContextChanged Der Aufgabenbereich eines Add-Ins wurde über eine zu Aktionen erfordernde Nachricht, InsightMessage eine Benachrichtigung, ein Dialogfeld für intelligente Warnungen oder ein integriertes Dialogfeld für die Spam-Berichterstellung geöffnet. 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 Postfachanforderungssatz 1.15 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.spamPreProcessingDialog.spamReportingOptions.type" ReportingOptions Unterstützung für Optionsfelder im Vorverarbeitungsdialog eines integrierten Spam-Reporting-Add-Ins hinzugefügt.
Berichterstellung für Spam "extensions.ribbons.spamPreProcessingDialog.spamNeverShowAgainOption" PreProcessingDialog Unterstützung für das Kontrollkästchen "Diese Nachricht nicht mehr anzeigen" im Vorverarbeitungsdialog eines integrierten Add-Ins zur Spamberichterstattung wurde hinzugefügt.

Siehe auch

  • Last updated on