Outlook-Add-In-API-Anforderungssatz 1.8

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 1.8

Postfachanforderungssatz 1.8 enthält alle Funktionen von Anforderungssatz 1.7. Zusätzlich wurden die folgenden Funktionen implementiert.

  • Es wurden Methoden hinzugefügt, um den Inhalt einer Anlage oder alle Anlagen eines Elements im Erstellungsmodus abzurufen. Weitere Informationen finden Sie unter Verwalten der Anlagen eines Elements in einem Formular zum Verfassen in Outlook.
  • Es wurde eine Methode hinzugefügt, um eine Datei mit einer Base64-codierten Zeichenfolge als Anlage hinzuzufügen.
  • Eigenschaften und Methoden zum Verwalten von Kategorien für Elemente und für die Master-Kategorieliste des Postfachs hinzugefügt.
  • Unterstützung für Stellvertretungszugriffsszenarien hinzugefügt, einschließlich einer Methode zum Abrufen freigegebener Eigenschaften und eines manifest-Elements zum Aktivieren von Add-Ins in freigegebenen Ordnern.
  • Es wurde ein Objekt hinzugefügt, um die Gruppe von Standorten für einen Termin zu verwalten. Weitere Informationen finden Sie unter Abrufen oder Festlegen des Speicherorts beim Erstellen eines Termins in Outlook.
  • Es wurde ein Objekt zum Abrufen und Festlegen benutzerdefinierter Internetheader für ein Nachrichtenelement im Erstellungsmodus hinzugefügt.
  • Es wurde eine Methode hinzugefügt, mit der alle Internetheader für ein Nachrichtenelement im Lesemodus abgerufen werden können.
  • Es wurde eine Methode hinzugefügt, mit der Sie die Initialisierungsdaten abrufen können, wenn das Add-In durch eine Handlungsnachricht aktiviert wird.
  • Es wurde eine Methode hinzugefügt, um die ID eines gespeicherten Termins oder Nachrichtenelements abzurufen.
  • Dem Aufruf wurde ein optionaler options Parameter hinzugefügt, event.completed um die Ausführung eines Ereignisses abzubrechen.
  • Ereignisse hinzugefügt, die auftreten, wenn eine Anlage hinzugefügt oder entfernt und der Terminort geändert wird.

API-Liste

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

Klasse Felder Beschreibung
AppointmentCompose addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
enhancedLocation Ruft die Speicherorte des Termins ab oder legt sie fest.
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.
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.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft asynchron die Exchange-Webdienste-ID (Exchange-Webdienste, EWS) 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.
AppointmentRead Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
enhancedLocation Ruft die Standorte eines Termins 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.
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.
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.
AttachmentContent content Der Inhalt einer Anlage als Zeichenfolge.
format Das Zeichenfolgenformat, das für den Inhalt einer Anlage verwendet werden soll.
AttachmentDetailsCompose attachmentType Ruft einen Wert ab, der den Typ der Anlage angibt.
id Ruft den Bezeichner einer Anlage ab.
isInline Ruft einen Wert ab, der angibt, ob die Anlage als Bild im Textkörper des Elements und nicht in der Liste der Anlagen angezeigt wird.
isServiceAccessible Gibt in Outlook im Web und dem neuen Outlook unter Windows an, ob eine Inlineanlage in einer Nachricht auf den Server hochgeladen und mit einer Exchange-Webdienste-ID (Exchange-Webdienste, EWS) versehen wurde.
name Ruft den Namen der Anlage ab.
size Ruft die Größe der Anlage in Byte ab.
url Ruft die URL der Anlage ab, wenn ihr Typ ist MailboxEnums.AttachmentType.Cloud.
AttachmentsChangedEventArgs attachmentDetails Ruft das Objekt ab, das die Anlage darstellt, die hinzugefügt oder entfernt wurde.
attachmentStatus Gibt an, ob die Anlage zu einem E-Mail-Element hinzugefügt oder daraus entfernt wurde.
type Ruft den Typ des ausgelösten Ereignisses ab.
Kategorien addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt einem Element Kategorien hinzu.
addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt einem Element Kategorien hinzu.
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) Ruft die Kategorien eines Elements ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) Ruft die Kategorien eines Elements ab.
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt Kategorien aus einem Element.
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt Kategorien aus einem Element.
CategoryDetails color Die Farbe der Kategorie.
displayName Der Name der Kategorie.
EnhancedLocation addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.
addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt der Gruppe von Orten, die dem Termin zugeordnet sind, hinzu.
getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) Ruft die mit dem Termin verknüpften Speicherorte ab.
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) Ruft die mit dem Termin verknüpften Speicherorte ab.
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt die Gruppe von Orten, die dem Termin zugeordnet sind.
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt die Gruppe von Orten, die dem Termin zugeordnet sind.
EnhancedLocationsChangedEventArgs enhancedLocations Ruft die Gruppe der erweiterten Standorte ab.
type Ruft den Typ des Ereignisses ab.
InternetHeaders getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Datensatz<string, string>>) => void) Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält.
getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Datensatz<string, string>>) => void) Bei gegebener Matrix von Internetheadernamen gibt diese Methode einen Datensatz zurück, der diese Internetheader und ihre Werte enthält.
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Bei gegebener Matrix von Internetheadernamen entfernt diese Methode die angegebenen Header aus der Internetheaderauflistung.
setAsync(headers: Datensatzzeichenfolge<, Zeichenfolge>, Rückruf?: (asyncResult: Office.AsyncResult<void>) => void) Legt die angegebenen Internetheader auf die angegebenen Werte fest.
setAsync(headers: Datensatzzeichenfolge<, Zeichenfolge>, Optionen: Office.AsyncContextOptions, Rückruf?: (asyncResult: Office.AsyncResult<void>) => void) Legt die angegebenen Internetheader auf die angegebenen Werte fest.
LocationDetails displayName Der Anzeigename des Standorts.
emailAddress Die mit dem Standort verknüpfte E-Mail-Adresse.
locationIdentifier Die des LocationIdentifier Standorts.
LocationIdentifier id Die eindeutige ID des Standorts.
type Der Typ des Standorts.
Postfach masterCategories Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien-Master-Liste bereitstellt, die einem Postfach zugeordnet ist.
MasterCategories addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt Kategorien zur Master-Liste für ein Postfach hinzu.
addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt Kategorien zur Master-Liste für ein Postfach hinzu.
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) Ruft die Master-Liste der Kategorien für ein Postfach ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) Ruft die Master-Liste der Kategorien für ein Postfach ab.
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt Kategorien aus der Master-Liste für ein Postfach.
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt Kategorien aus der Master-Liste für ein Postfach.
MessageCompose addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
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.
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.
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft asynchron die Exchange-Webdienste-ID (Exchange-Webdienste, EWS) 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.
internetHeaders Ruft die benutzerdefinierten Internetheader einer Nachricht ab oder legt sie fest.
MessageRead Kategorien Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
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.
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.
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.
AttachmentContentFormat Base64-Datenbank Der Inhalt der Anlage wird als Base64-codierte Zeichenfolge zurückgegeben.
EML Der Inhalt der Anlage wird als Zeichenfolge zurückgegeben, die eine .eml formatierte Datei darstellt.
ICalendar Der Inhalt der Anlage wird als Zeichenfolge zurückgegeben, die eine Datei im .iCalendar-Format darstellt.
Url Der Inhalt der Anlage wird als Zeichenfolge zurückgegeben, die eine URL darstellt.
AttachmentStatus Hinzugefügt Dem Element wurde eine Anlage hinzugefügt.
Entfernt Eine Anlage wurde von dem Element entfernt.
CategoryColor Keine Standardfarbe oder keine Farbzuordnung
Preset0 Red
Preset1 Orange
Preset10 Steel
Preset11 DarkSteel
Preset12 Gray
Preset13 DarkGray
Preset14 Black
Preset15 DarkRed
Preset16 DarkOrange
Preset17 DarkBrown
Preset18 DarkYellow
Preset19 DarkGreen
Preset2 Brown
Preset20 DarkTeal
Preset21 DarkOlive
Preset22 DarkBlue
Preset23 DarkPurple
Preset24 DarkCranberry
Preset3 Yellow
Preset4 Green
Preset5 Teal
Preset6 Olive
Preset7 Blau
Preset8 Purple
Preset9 Cranberry
DelegatePermissions DeleteAll Die Stellvertretung hat die Berechtigung zum Löschen beliebiger Elemente.
DeleteOwn Die Stellvertretung ist berechtigt, nur die von ihnen erstellten Elemente zu löschen.
Alle bearbeiten Die Stellvertretung hat die Berechtigung zum Bearbeiten von Elementen.
EditOwn Die Stellvertretung ist nur berechtigt, die Elemente zu bearbeiten, die sie selbst erstellt hat.
Lesen Die Stellvertretung verfügt über die Berechtigung zum Lesen von Elementen.
Schreiben Die Stellvertretung verfügt über die Berechtigung zum Erstellen und Schreiben von Elementen.
LocationType Benutzerdefiniert Ein benutzerdefinierter Speicherort.
Raum Ein Konferenzraum oder eine ähnliche Ressource mit einer SMTP-Adresse.
SharedProperties delegatePermissions Die Berechtigungen, die die Stellvertretung für einen freigegebenen Ordner oder der Benutzer für ein freigegebenes Postfach hat.
owner Die E-Mail-Adresse des Besitzers eines freigegebenen Gegenstands.
targetMailbox Der Speicherort des Postfachs des Besitzers für den Zugriff der Stellvertretung.
targetRestUrl Die Basis-URL der REST-API (derzeit https://outlook.office.com/api).

Ereignisse

In der folgenden Tabelle sind die in Anforderungssatz 1.8 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
AnlagenGeänderte Anlagen Einem Element wurde eine Anlage hinzugefügt oder davon entfernt. Element
EnhancedLocationsChanged Der Terminort wurde geändert. Element

Manifestupdates

In der folgenden Tabelle sind die Manifestupdates aufgeführt, die im Postfach-Anforderungssatz 1.8 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
Unterstützung für freigegebene Ordner "authorization.permissions.resourceSpecific.name" auf "Mailbox.SharedFolder" SupportsSharedFolders Definiert, ob das Add-In in Szenarien für freigegebene Ordner verfügbar ist.

Siehe auch