Office.LoadedMessageCompose interface

Paket:

outlook

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt eine Nachricht im Verfassenmodus dar, die derzeit geladen ist. Ein LoadedMessageCompose -Objekt wird zurückgegeben, wenn Office.context.mailbox.loadItemByIdAsync für eine Nachricht im Verfassenmodus aufgerufen wird.

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Ermitteln Sie beim Implementieren des Mehrfachauswahlfeatures für Elemente, ob Sie bereits über Office.context.mailbox.getSelectedItemsAsync den Aufruf auf die erforderlichen Eigenschaften des ausgewählten Elements zugreifen können. Wenn möglich, müssen Sie nicht aufrufen loadItemByIdAsync.

• Es kann jeweils nur ein E-Mail-Element geladen werden. Wenn Sie implementieren loadItemByIdAsync, müssen Sie aufrufen unloadAsync , nachdem das Element verarbeitet wurde. Dies muss vor dem Aufrufen loadItemByIdAsync eines anderen Elements erfolgen.

Eigenschaften

bcc	Ruft die Empfänger in der Zeile Bcc (blind carbon copy) einer Nachricht ab.
body	Ruft den Text und das Format des Elements ab.
categories	Ruft ein -Objekt ab, das Methoden zum Verwalten der Elementkategorien bereitstellt.
cc	Ruft Empfänger in der Cc-Zeile (Carbon Copy) einer Nachricht ab.
conversationId	Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist. Sie können für diese Eigenschaft eine ganze Zahl abrufen, wenn Ihre Mail-App in Formularen zum Lesen oder Antworten in Formularen zum Verfassen aktiviert wird. Wenn der Benutzer den Betreff der Antwortnachricht ändert, ändert sich beim Versenden die Konversations-ID für die entsprechende Nachricht, und der Wert, den Sie vorher bezogen haben, trifft nicht länger zu. Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null.
delayDeliveryTime	Ruft das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht ab.
from	Ruft die E-Mail-Adresse des Absenders einer Nachricht ab.
inReplyTo	Ruft die Nachrichten-ID der ursprünglichen Nachricht ab, auf die von der aktuellen Nachricht geantwortet wird.
internetHeaders	Ruft die benutzerdefinierten Internetheader einer Nachricht ab. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetheadern für eine Nachricht in einem Outlook-Add-In.
itemType	Ruft den Typ des Elements ab, das eine Instanz darstellt. Die itemType Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob das Elementobjekt instance eine Nachricht oder ein Termin ist.
notificationMessages	Ruft die Benachrichtigungsmeldungen des Elements ab.
sensitivityLabel	Ruft die Vertraulichkeitsbezeichnung einer Nachricht ab.
seriesId	Ruft die ID der Reihe ab, zu der ein instance gehört. In Outlook im Web und unter Windows (neu und klassisch) gibt die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört.
subject	Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird. Die subject -Eigenschaft ruft den gesamten Betreff des Elements ab, wie er vom E-Mail-Server gesendet wird.
to	Ruft die Empfänger in der Zeile An einer Nachricht ab. Bietet Zugriff auf die Empfänger in der Zeile An einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Methoden

getAttachmentContentAsync(attachmentId, options, callback)	Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück. Die getAttachmentContentAsync -Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und dann in derselben Sitzung diesen Bezeichner verwenden, um die Anlage abzurufen. In Outlook im Web und dem neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
getAttachmentContentAsync(attachmentId, callback)	Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück. Die getAttachmentContentAsync -Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und dann in derselben Sitzung diesen Bezeichner verwenden, um die Anlage abzurufen. In Outlook im Web und dem neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
getAttachmentsAsync(options, callback)	Ruft die Anlagen des Elements als Array ab.
getAttachmentsAsync(callback)	Ruft die Anlagen des Elements als Array ab.
getComposeTypeAsync(options, callback)	Gibt den Typ des Verfassens von Nachrichten und dessen Koersionstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Koersionstyp kann HTML oder Nur-Text sein.
getComposeTypeAsync(callback)	Gibt den Typ des Verfassens von Nachrichten und dessen Koersionstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Koersionstyp kann HTML oder Nur-Text sein.
getConversationIndexAsync(options, callback)	Ruft die Base64-codierte Position der aktuellen Nachricht in einem Konversationsthread ab.
getConversationIndexAsync(callback)	Ruft die Base64-codierte Position der aktuellen Nachricht in einem Konversationsthread ab.
getInitializationContextAsync(options, callback)	Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.
getInitializationContextAsync(callback)	Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.
getItemClassAsync(options, callback)	Ruft die Exchange-Webdienst-Elementklasse der ausgewählten Nachricht ab.
getItemClassAsync(callback)	Ruft die Exchange-Webdienst-Elementklasse der ausgewählten Nachricht ab.
getItemIdAsync(options, callback)	Ruft asynchron den EWS-Elementbezeichner (Exchange Web Services) eines gespeicherten Elements ab. Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück.
getItemIdAsync(callback)	Ruft die ID eines gespeicherten Elements asynchron ab. Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück. Hinweis: Wenn Ihr Add-In ein Element im Verfassenmodus aufruft getItemIdAsync (z. B. um eine itemId für ews oder die REST-API zu verwenden), beachten Sie, dass es einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird, wenn sich Outlook im Zwischenspeichermodus befindet. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.
getSharedPropertiesAsync(options, callback)	Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab. Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.
getSharedPropertiesAsync(callback)	Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab. Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.
isClientSignatureEnabledAsync(options, callback)	Ruft ab, ob die Clientsignatur aktiviert ist. In Outlook unter Windows (klassisch) gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, wenn die Signatur für die VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.
isClientSignatureEnabledAsync(callback)	Ruft ab, ob die Clientsignatur aktiviert ist. In Outlook unter Windows (klassisch) gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, wenn die Signatur für die VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.
loadCustomPropertiesAsync(callback, userContext)	Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element. Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte. Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen.
saveAsync(options, callback)	Speichert die aktuelle Nachricht asynchron als Entwurf.
saveAsync(callback)	Speichert die aktuelle Nachricht asynchron als Entwurf.
unloadAsync(options, callback)	Wenn mehrere E-Mail-Elemente ausgewählt sind, schließt das aktuell geladene Element, sodass ein weiteres ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
unloadAsync(callback)	Wenn mehrere E-Mail-Elemente ausgewählt sind, schließt das aktuell geladene Element, sodass ein weiteres ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

Details zur Eigenschaft

bcc

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Empfänger in der Zeile Bcc (blind carbon copy) einer Nachricht ab.

bcc: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Nur die getAsync -Methode des Recipients-Objekts wird unterstützt.

• Je nach Outlook-Client und -Plattform gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie erhalten können. Weitere Informationen finden Sie unter Recipients-Objekt .

body

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft den Text und das Format des Elements ab.

body: Body;

Eigenschaftswert

Office.Body

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Nur die getAsync Methoden und getTypeAsync des Body-Objekts werden unterstützt.

categories

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft ein -Objekt ab, das Methoden zum Verwalten der Elementkategorien bereitstellt.

categories: Categories;

Eigenschaftswert

Office.Categories

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

cc

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft Empfänger in der Cc-Zeile (Carbon Copy) einer Nachricht ab.

cc: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Nur die getAsync -Methode des Recipients-Objekts wird unterstützt.

• Je nach Outlook-Client und -Plattform gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie erhalten können. Weitere Informationen finden Sie unter Recipients-Objekt .

conversationId

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist.

Sie können für diese Eigenschaft eine ganze Zahl abrufen, wenn Ihre Mail-App in Formularen zum Lesen oder Antworten in Formularen zum Verfassen aktiviert wird. Wenn der Benutzer den Betreff der Antwortnachricht ändert, ändert sich beim Versenden die Konversations-ID für die entsprechende Nachricht, und der Wert, den Sie vorher bezogen haben, trifft nicht länger zu.

Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null.

conversationId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

delayDeliveryTime

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht ab.

delayDeliveryTime: DelayDeliveryTime;

Eigenschaftswert

Office.DelayDeliveryTime

Hinweise

[ API-Satz: Postfach 1.13 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Nur die getAsync -Methode des DelayDeliveryTime-Objekts wird unterstützt.

from

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die E-Mail-Adresse des Absenders einer Nachricht ab.

from: From;

Eigenschaftswert

Office.From

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

inReplyTo

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Nachrichten-ID der ursprünglichen Nachricht ab, auf die von der aktuellen Nachricht geantwortet wird.

inReplyTo: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• In Outlook unter Windows wird der inReplyTo Wert für alle Antworten beibehalten, unabhängig von den vom Benutzer vorgenommenen Änderungen, z. B. ändern des Betreffs in einer Antwort.

• Die inReplyTo -Eigenschaft gibt für neue Nachrichten und Besprechungseinladungen zurück null , die von einem Benutzer weitergeleitet werden, der auch der Besprechungsorganisator ist.

internetHeaders

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die benutzerdefinierten Internetheader einer Nachricht ab.

Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetheadern für eine Nachricht in einem Outlook-Add-In.

internetHeaders: InternetHeaders;

Eigenschaftswert

Office.InternetHeaders

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Nur die getAsync -Methode des InternetHeaders-Objekts wird unterstützt.

itemType

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft den Typ des Elements ab, das eine Instanz darstellt.

Die itemType Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob das Elementobjekt instance eine Nachricht oder ein Termin ist.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

notificationMessages

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Benachrichtigungsmeldungen des Elements ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Office.NotificationMessages

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Nur die getAllAsync -Methode des NotificationMessages-Objekts wird unterstützt.

sensitivityLabel

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Vertraulichkeitsbezeichnung einer Nachricht ab.

sensitivityLabel: SensitivityLabel;

Eigenschaftswert

Office.SensitivityLabel

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Um die Vertraulichkeitsbezeichnungsfunktion in Ihrem Add-In verwenden zu können, benötigen Sie ein Microsoft 365 E5-Abonnement.

• Nur die getAsync -Methode des SensitivityLabel-Objekts wird unterstützt.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Verfassenmodus.

seriesId

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die ID der Reihe ab, zu der ein instance gehört.

In Outlook im Web und unter Windows (neu und klassisch) gibt die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört.

seriesId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Der von der seriesId -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die seriesId Eigenschaft ist nicht identisch mit den Outlook-IDs, die von der Outlook-REST-API verwendet werden. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs aus einem Outlook-Add-In.

Die seriesId -Eigenschaft gibt für Elemente zurück null , die keine übergeordneten Elemente haben, z. B. einzelne Termine, Serienelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , die keine Besprechungsanfragen sind.

subject

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird.

Die subject -Eigenschaft ruft den gesamten Betreff des Elements ab, wie er vom E-Mail-Server gesendet wird.

subject: Subject;

Eigenschaftswert

Office.Subject

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Nur die getAsync -Methode des Subject-Objekts wird unterstützt.

to

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Empfänger in der Zeile An einer Nachricht ab. Bietet Zugriff auf die Empfänger in der Zeile An einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

to: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Nur die getAsync -Methode des Recipients-Objekts wird unterstützt.

• Je nach Outlook-Client und -Plattform gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie erhalten können. Weitere Informationen finden Sie unter Recipients-Objekt .

Details zur Methode

getAttachmentContentAsync(attachmentId, options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück.

Die getAttachmentContentAsync -Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und dann in derselben Sitzung diesen Bezeichner verwenden, um die Anlage abzurufen. In Outlook im Web und dem neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parameter

attachmentId

string

Der Bezeichner der Anlage, die Sie abrufen möchten.

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Fehler:

• AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Zu den nicht unterstützten Typen gehören eingebettete Bilder im Rich-Text-Format oder andere Elementanlagetypen als E-Mail- oder Kalenderelemente (z. B. kontakt- oder aufgabenelement).

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getAttachmentContentAsync(attachmentId, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent -Objekt zurück.

Die getAttachmentContentAsync -Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und dann in derselben Sitzung diesen Bezeichner verwenden, um die Anlage abzurufen. In Outlook im Web und dem neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

Parameter

attachmentId

string

Der Bezeichner der Anlage, die Sie abrufen möchten.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Fehler:

• AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Zu den nicht unterstützten Typen gehören eingebettete Bilder im Rich-Text-Format oder andere Elementanlagetypen als E-Mail- oder Kalenderelemente (z. B. kontakt- oder aufgabenelement).

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getAttachmentsAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getAttachmentsAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getComposeTypeAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt den Typ des Verfassens von Nachrichten und dessen Koersionstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Koersionstyp kann HTML oder Nur-Text sein.

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<any>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg enthält die asyncResult.value -Eigenschaft ein -Objekt mit dem Compose-Typ und dem Koersionstyp des Elements.

Gibt zurück

void

Ein -Objekt mit ComposeType - und CoercionType -Enumerationswerten für das Nachrichtenelement.

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getComposeTypeAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt den Typ des Verfassens von Nachrichten und dessen Koersionstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Koersionstyp kann HTML oder Nur-Text sein.

getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<any>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg enthält die asyncResult.value -Eigenschaft ein -Objekt mit dem Compose-Typ und dem Koersionstyp des Elements.

Gibt zurück

void

Ein -Objekt mit ComposeType - und CoercionType -Enumerationswerten für das Nachrichtenelement.

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getConversationIndexAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Konversationsthread ab.

getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die Base64-codierte Position der aktuellen Nachricht in einer Unterhaltung wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Tipp: Sie können den Unterhaltungsindex verwenden, um eine Nachricht in einem Unterhaltungsthread zu suchen. Verwenden Sie dann seinen Inhalt, um Kontext für die aktuelle Nachricht bereitzustellen, die zusammengestellt wird.

getConversationIndexAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Konversationsthread ab.

getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die Base64-codierte Position der aktuellen Nachricht in einer Unterhaltung wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Tipp: Sie können den Unterhaltungsindex verwenden, um eine Nachricht in einem Unterhaltungsthread zu suchen. Verwenden Sie dann seinen Inhalt, um Kontext für die aktuelle Nachricht bereitzustellen, die zusammengestellt wird.

getInitializationContextAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg werden die Initialisierungskontextdaten als Zeichenfolge (oder eine leere Zeichenfolge, wenn kein Initialisierungskontext vorhanden ist) in der asyncResult.value -Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getInitializationContextAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Nachricht mit Aktionen aktiviert wird.

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg werden die Initialisierungskontextdaten als Zeichenfolge (oder eine leere Zeichenfolge, wenn kein Initialisierungskontext vorhanden ist) in der asyncResult.value -Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

getItemClassAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Exchange-Webdienst-Elementklasse der ausgewählten Nachricht ab.

getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die Nachrichtenklasse wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Elementklasse	Beschreibung
IPM.Note	Neue Nachrichten und Nachrichtenantworten
IPM. Note.SMIME	Verschlüsselte Nachrichten, die auch signiert werden können
IPM. Note.SMIME.MultipartSigned	Unverschlüsselt signierte Nachrichten
IPM.Schedule.Meeting.Request	Besprechungsanfragen
IPM.Schedule.Meeting.Canceled	Besprechungsabsagen
IPM.Schedule.Meeting.Resp.Neg	Antworten zur Ablehnung von Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Pos	Antworten zur Zusage zu Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Tent	Antworten zur Zusagen von Besprechungsanfragen unter Vorbehalt

getItemClassAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Exchange-Webdienst-Elementklasse der ausgewählten Nachricht ab.

getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die Nachrichtenklasse wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Elementklasse	Beschreibung
IPM.Note	Neue Nachrichten und Nachrichtenantworten
IPM. Note.SMIME	Verschlüsselte Nachrichten, die auch signiert werden können
IPM. Note.SMIME.MultipartSigned	Unverschlüsselt signierte Nachrichten
IPM.Schedule.Meeting.Request	Besprechungsanfragen
IPM.Schedule.Meeting.Canceled	Besprechungsabsagen
IPM.Schedule.Meeting.Resp.Neg	Antworten zur Ablehnung von Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Pos	Antworten zur Zusage zu Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Tent	Antworten zur Zusagen von Besprechungsanfragen unter Vorbehalt

getItemIdAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft asynchron den EWS-Elementbezeichner (Exchange Web Services) eines gespeicherten Elements ab.

Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück.

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Die EWS-Element-ID des Elements wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Die zurückgegebene Element-ID ist nicht mit der Outlook-Eintrags-ID oder der id identisch, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden.

• Wenn Ihr Add-In für ein Element im Verfassenmodus aufruft getItemIdAsync (z. B. um ein itemId für EWS oder die REST-API zu verwenden), beachten Sie, dass es einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird, wenn sich Outlook im Cachemodus befindet. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

getItemIdAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die ID eines gespeicherten Elements asynchron ab.

Beim Aufruf gibt diese Methode die Element-ID über die Rückruffunktion zurück.

Hinweis: Wenn Ihr Add-In ein Element im Verfassenmodus aufruft getItemIdAsync (z. B. um eine itemId für ews oder die REST-API zu verwenden), beachten Sie, dass es einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird, wenn sich Outlook im Zwischenspeichermodus befindet. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.

getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

getSharedPropertiesAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die asyncResult.value -Eigenschaft stellt die Eigenschaften des freigegebenen Elements bereit.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 für die Unterstützung freigegebener Ordner, Postfach 1.13 für die Unterstützung freigegebener Postfächer ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Im Modus "Message Compose" wird diese API in Outlook im Web oder unter Windows (neu und klassisch) nur unterstützt, wenn die folgenden Bedingungen erfüllt sind.

a. Delegieren des Zugriffs/Freigegebene Ordner

1. Der Postfachbesitzer startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner Entwürfe in einen Ordner, der für den Delegaten freigegeben ist.

3. Der Delegat öffnet den Entwurf aus dem freigegebenen Ordner und setzt dann das Verfassen fort.

b. Freigegebenes Postfach (gilt nur für das klassische Outlook unter Windows)

1. Der Benutzer des freigegebenen Postfachs startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner Entwürfe in einen Ordner im freigegebenen Postfach.

3. Ein anderer Benutzer des freigegebenen Postfachs öffnet den Entwurf aus dem freigegebenen Postfach und setzt dann das Verfassen fort.

Die Nachricht befindet sich jetzt in einem freigegebenen Kontext, und Add-Ins, die diese freigegebenen Szenarien unterstützen, können die freigegebenen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner Gesendete Elemente des Absenders.

getSharedPropertiesAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die asyncResult.value -Eigenschaft stellt die Eigenschaften des freigegebenen Elements bereit.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 für die Unterstützung freigegebener Ordner, Postfach 1.13 für die Unterstützung freigegebener Postfächer ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig: Im Modus "Message Compose" wird diese API in Outlook im Web oder unter Windows (neu und klassisch) nur unterstützt, wenn die folgenden Bedingungen erfüllt sind.

a. Delegieren des Zugriffs/Freigegebene Ordner

1. Der Postfachbesitzer startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner Entwürfe in einen Ordner, der für den Delegaten freigegeben ist.

3. Der Delegat öffnet den Entwurf aus dem freigegebenen Ordner und setzt dann das Verfassen fort.

b. Freigegebenes Postfach (gilt nur für Outlook unter Windows)

1. Der Benutzer des freigegebenen Postfachs startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner Entwürfe in einen Ordner im freigegebenen Postfach.

3. Ein anderer Benutzer des freigegebenen Postfachs öffnet den Entwurf aus dem freigegebenen Postfach und setzt dann das Verfassen fort.

Die Nachricht befindet sich jetzt in einem freigegebenen Kontext, und Add-Ins, die diese freigegebenen Szenarien unterstützen, können die freigegebenen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner Gesendete Elemente des Absenders.

isClientSignatureEnabledAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook unter Windows (klassisch) gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, wenn die Signatur für die VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

isClientSignatureEnabledAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook unter Windows (klassisch) gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, wenn die Signatur für die VerfassentypennewMail , replyoder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) auf "(none)" festgelegt oder in Outlook im Web oder neuem Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<boolean>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

loadCustomPropertiesAsync(callback, userContext)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.

Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte.

Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parameter

callback

(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

userContext

any

Optional. Entwickler können ein beliebiges Objekt bereitstellen, auf das sie in der Callbackfunktion zugreifen möchten. Der Zugriff auf dieses Objekt kann über die asyncResult.asyncContext-Eigenschaft in der Callbackfunktion erfolgen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Weitere Informationen zu benutzerdefinierten Eigenschaften finden Sie unter Abrufen und Festlegen von Add-In-Metadaten für ein Outlook-Add-In.

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachrichten Compose

saveAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Speichert die aktuelle Nachricht asynchron als Entwurf.

saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die EWS-Nachrichten-ID wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• In Outlook im Web, dem neuen Outlook unter Windows oder dem klassischen Outlook unter Windows im Onlinemodus (nicht zwischengespeicherter Modus) wird das Element auf dem Server gespeichert. In Outlook im Cache-Modus wird das Element im lokalen Cache gespeichert.

• Bei der Arbeit mit HTML-formatierten Inhalten ist es wichtig zu beachten, dass der Outlook-Client den Inhalt ändern kann. Dies bedeutet, dass nachfolgende Aufrufe von Methoden wie Body.getAsync, Body.setAsyncund sogar saveAsync möglicherweise nicht zum gleichen Inhalt führen.

• Der zurückgegebene Bezeichner entspricht dem EwS-Elementbezeichner (Exchange Web Services). Die zurückgegebene Element-ID ist nicht mit der Outlook-Eintrags-ID oder der id identisch, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden.

• Wenn Ihr Add-In für ein Element im Verfassenmodus aufruft saveAsync , um eine Element-ID für die Verwendung mit EWS oder der REST-API abzurufen, beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, gibt die Verwendung der Element-ID einen Fehler zurück.

• In Outlook im Web und dem neuen Outlook unter Windows variiert das Postfachkonto, in dem ein Entwurf gespeichert wird, wenn saveAsync für eine Nachricht aufgerufen wird, die von einem freigegebenen Postfachkonto gesendet wird. Wenn der Absender eine neue Nachricht aus seinem persönlichen Postfach erstellt und im Feld Von das freigegebene Postfach auswählt, saveAsync speichert den Entwurf im Ordner Entwürfe des persönlichen Postfachs des Benutzers. Wenn der Absender das freigegebene Postfachkonto auf einer separaten Browserregisterkarte öffnet (z. B. über die Option Ein anderes Postfach öffnen ), und dort eine neue Nachricht erstellt, saveAsync speichert den Entwurf im Ordner Entwürfe des freigegebenen Postfachs .

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

saveAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Speichert die aktuelle Nachricht asynchron als Entwurf.

saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => void

Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. Die EWS-Nachrichten-ID wird in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• In Outlook im Web, dem neuen Outlook unter Windows oder dem klassischen Outlook unter Windows im Onlinemodus (nicht zwischengespeicherter Modus) wird das Element auf dem Server gespeichert. In Outlook im Cache-Modus wird das Element im lokalen Cache gespeichert.

• Bei der Arbeit mit HTML-formatierten Inhalten ist es wichtig zu beachten, dass der Outlook-Client den Inhalt ändern kann. Dies bedeutet, dass nachfolgende Aufrufe von Methoden wie Body.getAsync, Body.setAsyncund sogar saveAsync möglicherweise nicht zum gleichen Inhalt führen.

• Der zurückgegebene Bezeichner entspricht dem EwS-Elementbezeichner (Exchange Web Services). Die zurückgegebene Element-ID ist nicht mit der Outlook-Eintrags-ID oder der id identisch, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden.

• Wenn Ihr Add-In für ein Element im Verfassenmodus aufruft saveAsync , um eine Element-ID für die Verwendung mit EWS oder der REST-API abzurufen, beachten Sie, dass es im Zwischenspeichermodus einige Zeit dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird. Bis das Element synchronisiert ist, gibt die Verwendung der Element-ID einen Fehler zurück.

• In Outlook im Web und dem neuen Outlook unter Windows variiert das Postfachkonto, in dem ein Entwurf gespeichert wird, wenn saveAsync für eine Nachricht aufgerufen wird, die von einem freigegebenen Postfachkonto gesendet wird. Wenn der Absender eine neue Nachricht aus seinem persönlichen Postfach erstellt und im Feld Von das freigegebene Postfach auswählt, saveAsync speichert den Entwurf im Ordner Entwürfe des persönlichen Postfachs des Benutzers. Wenn der Absender das freigegebene Postfachkonto auf einer separaten Browserregisterkarte öffnet (z. B. über die Option Ein anderes Postfach öffnen ), und dort eine neue Nachricht erstellt, saveAsync speichert den Entwurf im Ordner Entwürfe des freigegebenen Postfachs .

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

unloadAsync(options, callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Wenn mehrere E-Mail-Elemente ausgewählt sind, schließt das aktuell geladene Element, sodass ein weiteres ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das die asyncContext -Eigenschaft enthält. Weisen Sie der -Eigenschaft jedes Objekt zu, auf das asyncContext Sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Weitere Informationen zum Verarbeiten mehrerer ausgewählter Nachrichten finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

• Wenn ein ausgewähltes E-Mail-Element mit loadItemByIdAsyncgeladen wird, müssen unloadAsync Sie nach der Verarbeitung aufrufen. Dies muss vor dem Aufrufen loadItemByIdAsync eines anderen ausgewählten Elements erfolgen.

unloadAsync(callback)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Wenn mehrere E-Mail-Elemente ausgewählt sind, schließt das aktuell geladene Element, sodass ein weiteres ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfachvorschau ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

• Weitere Informationen zum Verarbeiten mehrerer ausgewählter Nachrichten finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

• Wenn ein ausgewähltes E-Mail-Element mit loadItemByIdAsyncgeladen wird, müssen unloadAsync Sie nach der Verarbeitung aufrufen. Dies muss vor dem Aufrufen loadItemByIdAsync eines anderen ausgewählten Elements erfolgen.