Freigeben über


Office.MessageCompose interface

Der Nachrichtenerstellungsmodus von Office.context.mailbox.item.

Wichtig: Dies ist ein internes Outlook-Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als Modus behandeln Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite Objektmodell .

Übergeordnete Schnittstellen:

Extends

Eigenschaften

bcc

Ruft ein -Objekt ab, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht bereitstellt.

Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

body

Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.

categories

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

Wichtig: In Outlook im Web können Sie die API nicht verwenden, um Kategorien für eine Nachricht im Verfassenmodus zu verwalten.

cc

Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die cc-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Cc-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

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. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die conversationId-Eigenschaft einen Wert zurück.

delayDeliveryTime

Ruft das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht ab oder legt diese fest.

Die delayDeliveryTime -Eigenschaft gibt ein DelayDeliveryTime -Objekt zurück, das Methoden zum Verwalten des Zustellungsdatums und der Uhrzeit der Nachricht bereitstellt.

from

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

Die from -Eigenschaft gibt ein From -Objekt zurück, das eine Methode zum Abrufen des from-Werts bereitstellt.

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 oder legt diese fest.

Die internetHeaders -Eigenschaft gibt ein InternetHeaders -Objekt zurück, das Methoden zum Verwalten der Internetheader für die Nachricht bereitstellt.

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 die Elementobjektinstanz eine Nachricht oder ein Termin ist.

notificationMessages

Ruft die Benachrichtigungen für ein Element ab.

sensitivityLabel

Ruft das -Objekt ab, um die Vertraulichkeitsbezeichnung einer Nachricht abzurufen oder festzulegen.

seriesId

Ruft die ID der Reihe ab, zu der eine -Instanz gehört.

In Outlook im Web und auf Desktopclients gibt die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört. Unter iOS und Android gibt die seriesId jedoch die REST-ID des übergeordneten Elements zurück.

Hinweis: Der von der seriesId -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die seriesId Eigenschaft ist nicht mit den Outlook-IDs identisch, 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, Reihenelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , bei denen es sich nicht um Besprechungsanfragen handelt.

sessionData

Verwaltet die SessionData eines Elements im Verfassenmodus.

Wichtig: Das gesamte SessionData-Objekt ist auf 50.000 Zeichen pro Add-In beschränkt.

subject

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.

Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.

Die subject-Eigenschaft gibt ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

to

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.

Die to-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der An-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

Methoden

addFileAttachmentAsync(uri, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

addFileAttachmentAsync(uri, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

addHandlerAsync(eventType, handler, options, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addHandlerAsync(eventType, handler, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

addItemAttachmentAsync(itemId, attachmentName, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

close()

Schließt das aktuelle Element, das gerade verfasst wird.

Das Verhalten der close-Methode hängt vom aktuellen Status des verfassten Elements ab. Wenn das Element nicht gespeicherte Änderungen aufweist, fordert der Client den Benutzer auf, die Aktion zu speichern, zu verwerfen oder zu schließen.

Im Outlook-Desktopclient hat die close Methode keine Auswirkungen auf eine Antwort im Lesebereich.

closeAsync(options, callback)

Schließt die aktuelle Nachricht, die mit der Option zum Verwerfen nicht gespeicherter Änderungen erstellt wird. Bei der zusammengestellten Nachricht kann es sich um eine neue Nachricht, eine Antwort oder einen vorhandenen Entwurf handelt.

closeAsync(callback)

Schließt die aktuelle neue Nachricht, die erstellt wird.

Das Verhalten einer neuen Nachricht, die erstellt wird, hängt davon ab, ob die Nachricht nicht gespeicherte Änderungen enthält. Wenn keine Änderungen vorgenommen wurden, wird die Nachricht ohne ein Dialogfeld zum Speichern geschlossen. Wenn die Nachricht hingegen nicht gespeicherte Änderungen enthält, wird ein Dialogfeld zum Speichern angezeigt, in dem der Benutzer aufgefordert wird, einen Entwurf zu speichern, Änderungen zu verwerfen oder den Vorgang abzubrechen.

disableClientSignatureAsync(options, callback)

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

  • In Outlook im Web ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der -Methode deaktiviert.

  • In Outlook unter Windows und auf Mac ist die Signatur unter den Abschnitten Neue Nachrichten und Antworten/Weiterleitungen des sendenden Kontos auf (keine) festgelegt.

  • In Outlook für Android und unter iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

disableClientSignatureAsync(callback)

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

  • In Outlook im Web ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der -Methode deaktiviert.

  • In Outlook unter Windows und auf Mac ist die Signatur unter den Abschnitten Neue Nachrichten und Antworten/Weiterleitungen des sendenden Kontos auf (keine) festgelegt.

  • In Outlook für Android und unter iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

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 auf mobilen Geräten 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 auf mobilen Geräten 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 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 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 im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.

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 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 im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.

getSelectedDataAsync(coercionType, options, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.

getSelectedDataAsync(coercionType, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.

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.

Bei Rich-Clients für Windows und Mac sollte der API-Aufruf zurückgeben true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. Für Outlook im Web sollte der API-Aufruf zurückgeben true , wenn die Signatur für Verfassentypen newMail, replyoder forwardaktiviert ist. Wenn die Einstellungen in Mac- oder Windows-Rich-Clients auf "(none)" festgelegt oder in Outlook im Web deaktiviert sind, sollte der API-Aufruf zurückgeben false.

isClientSignatureEnabledAsync(callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

Bei Rich-Clients für Windows und Mac sollte der API-Aufruf zurückgeben true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. Für Outlook im Web sollte der API-Aufruf zurückgeben true , wenn die Signatur für Verfassentypen newMail, replyoder forwardaktiviert ist. Wenn die Einstellungen in Mac- oder Windows-Rich-Clients auf "(none)" festgelegt oder in Outlook im Web deaktiviert sind, sollte der API-Aufruf zurückgeben false.

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, festzulegen, zu speichern und zu entfernen.

removeAttachmentAsync(attachmentId, options, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten 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.

removeAttachmentAsync(attachmentId, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten 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.

removeHandlerAsync(eventType, options, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

removeHandlerAsync(eventType, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

saveAsync(options, callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

saveAsync(callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

setSelectedDataAsync(data, options, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

Details zur Eigenschaft

bcc

Ruft ein -Objekt ab, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht bereitstellt.

Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten möglicherweise Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

bcc: Recipients;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

Office.context.mailbox.item.bcc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.bcc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.bcc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfBccRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-bcc-message-compose.yaml

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailBcc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

body

Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.

body: Body;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of the result parameter passed to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

categories

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

Wichtig: In Outlook im Web können Sie die API nicht verwenden, um Kategorien für eine Nachricht im Verfassenmodus zu verwalten.

categories: Categories;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      console.log("Categories assigned to this item:");
      console.log(JSON.stringify(categories));
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.

Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const masterCategories = asyncResult.value;
    if (masterCategories && masterCategories.length > 0) {
      // Grab the first category from the master list.
      const categoryToAdd = [masterCategories[0].displayName];
      Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
        } else {
          console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const categories = asyncResult.value;
    if (categories && categories.length > 0) {
      // Grab the first category assigned to this item.
      const categoryToRemove = [categories[0].displayName];
      Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
          console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
        } else {
          console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
        }
      });
    } else {
      console.log("There are no categories assigned to this item.");
    }
  } else {
    console.error(asyncResult.error);
  }
});

cc

Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die cc-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Cc-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

cc: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

Office.context.mailbox.item.cc.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.cc.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.cc.getAsync(callback);

function callback(asyncResult) {
    const arrayOfCcRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-cc-message-compose.yaml

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailCc")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

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. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die conversationId-Eigenschaft einen Wert zurück.

conversationId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-id-message.yaml

console.log(`Conversation ID: ${Office.context.mailbox.item.conversationId}`);

delayDeliveryTime

Ruft das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht ab oder legt diese fest.

Die delayDeliveryTime -Eigenschaft gibt ein DelayDeliveryTime -Objekt zurück, das Methoden zum Verwalten des Zustellungsdatums und der Uhrzeit der Nachricht bereitstellt.

delayDeliveryTime: DelayDeliveryTime;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.13 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/delay-message-delivery.yaml

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

from

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

Die from -Eigenschaft gibt ein From -Objekt zurück, das eine Methode zum Abrufen des from-Werts bereitstellt.

from: From;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig: Diese Eigenschaft wird in Outlook unter Android und iOS unterstützt. Ein Beispielszenario finden Sie unter Implementieren der ereignisbasierten Aktivierung in mobilen Outlook-Add-Ins.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-from-message-compose.yaml

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

inReplyTo

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: Verfassen von Nachrichten

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-in-reply-to.yaml

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

internetHeaders

Ruft die benutzerdefinierten Internetheader einer Nachricht ab oder legt diese fest.

Die internetHeaders -Eigenschaft gibt ein InternetHeaders -Objekt zurück, das Methoden zum Verwalten der Internetheader für die Nachricht bereitstellt.

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

internetHeaders: InternetHeaders;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig: Die Internetheader-API wird in Outlook unter Android und unter iOS ab Version 4.2405.0 unterstützt. Weitere Informationen zu features, die in Outlook auf mobilen Geräten unterstützt werden, finden Sie unter Outlook JavaScript-APIs, die in Outlook auf mobilen Geräten unterstützt werden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/70-mime-headers/manage-custom-internet-headers-message-compose.yaml

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

itemType

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

Die itemType -Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob die Elementobjektinstanz eine Nachricht oder ein Termin ist.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

notificationMessages

Ruft die Benachrichtigungen für ein Element ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

sensitivityLabel

Ruft das -Objekt ab, um die Vertraulichkeitsbezeichnung einer Nachricht abzurufen oder festzulegen.

sensitivityLabel: SensitivityLabel;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

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

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

seriesId

Ruft die ID der Reihe ab, zu der eine -Instanz gehört.

In Outlook im Web und auf Desktopclients gibt die seriesId EWS-ID (Exchange Web Services) des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört. Unter iOS und Android gibt die seriesId jedoch die REST-ID des übergeordneten Elements zurück.

Hinweis: Der von der seriesId -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die seriesId Eigenschaft ist nicht mit den Outlook-IDs identisch, 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, Reihenelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , bei denen es sich nicht um Besprechungsanfragen handelt.

seriesId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-series-id.yaml

const seriesId = Office.context.mailbox.item.seriesId;

if (seriesId === undefined) {
  console.log("This is a message that's not a meeting request.");
} else if (seriesId === null) {
  console.log("This is a single appointment, a parent series, or a meeting request for a series or single meeting.");
} else {
  console.log("This is an instance belonging to series with ID " + seriesId);
}

sessionData

Verwaltet die SessionData eines Elements im Verfassenmodus.

Wichtig: Das gesamte SessionData-Objekt ist auf 50.000 Zeichen pro Add-In beschränkt.

sessionData: SessionData;

Eigenschaftswert

Hinweise

[ API-Satz: Postfach 1.11 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

subject

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.

Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.

Die subject-Eigenschaft gibt ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

subject: Subject;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

to

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.

Die to-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der An-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

to: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

Office.context.mailbox.item.to.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.to.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.to.getAsync(callback);

function callback(asyncResult) {
    const arrayOfToRecipients = asyncResult.value;
}
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-to-message-compose.yaml

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailTo")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Details zur Methode

addFileAttachmentAsync(uri, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

uri

string

Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline: Wenn true, gibt an, dass die Anlage inline im Nachrichtentext angezeigt wird und nicht in der Anlagenliste angezeigt werden soll.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • AttachmentSizeExceeded: Die Anlage ist größer als zulässig.

  • FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wichtig: In den letzten Builds von Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

uri

string

Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • AttachmentSizeExceeded: Die Anlage ist größer als zulässig.

  • FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

addFileAttachmentFromBase64Async(base64File, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

base64File

string

Der Base64-codierte Inhalt eines Bilds oder einer Datei, die einer E-Mail oder einem Ereignis hinzugefügt werden soll. Die maximale Länge der codierten Zeichenfolge beträgt 27.892.122 Zeichen (ca. 25 MB).

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline: Wenn true, gibt an, dass die Anlage inline im Nachrichtentext angezeigt wird und nicht in der Anlagenliste angezeigt werden soll.

callback

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

Optional. Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig:

  • Das Hinzufügen einer Base64-Inlinedatei zu einer Nachricht im Verfassenmodus wird in Outlook unter Android und iOS unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

  • Wenn Sie eine Daten-URL-API (z. B. ) verwenden, readAsDataURLmüssen Sie das Daten-URL-Präfix entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn beispielsweise die vollständige Zeichenfolge durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

  • Wenn Sie ein Base64-Inlinebild zum Textkörper einer Nachricht oder eines Termins hinzufügen, der gerade zusammengestellt wird, müssen Sie zuerst den aktuellen Elementtext mithilfe der Office.context.mailbox.item.body.getAsync-Methode abrufen, bevor Sie das Bild mithilfe von addFileAttachmentFromBase64Asynceinfügen. Andernfalls wird das Bild nicht im Text gerendert, nachdem es eingefügt wurde. Weitere Anleitungen finden Sie unter Anfügen einer Datei.

Fehler:

  • AttachmentSizeExceeded: Die Anlage ist größer als zulässig.

  • FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

...

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

addFileAttachmentFromBase64Async(base64File, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async -Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie an das Element im Erstellformular an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value -Objekt zurück.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

base64File

string

Der Base64-codierte Inhalt eines Bilds oder einer Datei, die einer E-Mail oder einem Ereignis hinzugefügt werden soll. Die maximale Länge der codierten Zeichenfolge beträgt 27.892.122 Zeichen (ca. 25 MB).

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

callback

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

Optional. Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hochladen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig:

  • Das Hinzufügen einer Base64-Inlinedatei zu einer Nachricht im Verfassenmodus wird in Outlook unter Android und iOS unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

  • Wenn Sie eine Daten-URL-API (z. B. ) verwenden, readAsDataURLmüssen Sie das Daten-URL-Präfix entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn beispielsweise die vollständige Zeichenfolge durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

  • Wenn Sie ein Base64-Inlinebild zum Textkörper einer Nachricht oder eines Termins hinzufügen, der gerade zusammengestellt wird, müssen Sie zuerst den aktuellen Elementtext mithilfe der Office.context.mailbox.item.body.getAsync-Methode abrufen, bevor Sie das Bild mithilfe von addFileAttachmentFromBase64Asynceinfügen. Andernfalls wird das Bild nicht im Text gerendert, nachdem es eingefügt wurde. Weitere Anleitungen finden Sie unter Anfügen einer Datei.

Fehler:

  • AttachmentSizeExceeded: Die Anlage ist größer als zulässig.

  • FileTypeNotSupported: Die Anlage verfügt über eine Erweiterung, die nicht zulässig ist.

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

addHandlerAsync(eventType, handler, options, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addHandlerAsync(eventType: Office.EventType | string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler

any

Die Funktion, die das Ereignis behandeln soll. Die Funktion muss einen einzigen Parameter akzeptieren (ein Objektliteral). Die type -Eigenschaft für den -Parameter entspricht dem parameter, der eventType an addHandlerAsyncübergeben wird.

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<void>) => 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.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

function myHandlerFunction(eventarg) {
    if (eventarg.attachmentStatus === Office.MailboxEnums.AttachmentStatus.Added) {
        const attachment = eventarg.attachmentDetails;
        console.log("Event Fired and Attachment Added!");
        getAttachmentContentAsync(attachment.id, options, callback);
    }
}

Office.context.mailbox.item.addHandlerAsync(Office.EventType.AttachmentsChanged, myHandlerFunction, myCallback);

addHandlerAsync(eventType, handler, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

addHandlerAsync(eventType: Office.EventType | string, handler: any, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler

any

Die Funktion, die das Ereignis behandeln soll. Die Funktion muss einen einzigen Parameter akzeptieren (ein Objektliteral). Die type -Eigenschaft für den -Parameter entspricht dem parameter, der eventType an addHandlerAsyncübergeben wird.

callback

(asyncResult: Office.AsyncResult<void>) => 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.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

itemId

any

Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Zustandsinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office Add-In in Outlook im Web ausgeführt wird, kann die Methode addItemAttachmentAsync Elemente an andere Elemente anfügen als an das Element, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

itemId

any

Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • NumberOfAttachmentsExceeded: Die Nachricht oder der Termin weist zu viele Anlagen auf.

close()

Schließt das aktuelle Element, das gerade verfasst wird.

Das Verhalten der close-Methode hängt vom aktuellen Status des verfassten Elements ab. Wenn das Element nicht gespeicherte Änderungen aufweist, fordert der Client den Benutzer auf, die Aktion zu speichern, zu verwerfen oder zu schließen.

Im Outlook-Desktopclient hat die close Methode keine Auswirkungen auf eine Antwort im Lesebereich.

close(): void;

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: eingeschränkt

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig: Wenn das Element in Outlook im Web ein Termin ist und zuvor mit saveAsyncgespeichert wurde, wird der Benutzer aufgefordert, zu speichern, zu verwerfen oder abzubrechen, auch wenn seit dem letzten Speichern des Elements keine Änderungen vorgenommen wurden.

Tipp: Verwenden Sie die closeAsync-Methode anstelle der close -Methode, wenn Ihr Add-In Folgendes ausführen soll:

  • Eine zusammengestellte Nachricht wird automatisch verworfen, ohne den Benutzer mit dem Dialogfeld "Speichern" aufzufordern.

  • Bestimmen Sie, wann ein Benutzer das Dialogfeld zum Speichern eines Elements für eine Nachricht abbricht, die gerade erstellt wird.

  • Schließen Sie eine Antwort im Lesebereich oder einen vorhandenen Entwurf eines Outlook-Desktopclients.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

closeAsync(options, callback)

Schließt die aktuelle Nachricht, die mit der Option zum Verwerfen nicht gespeicherter Änderungen erstellt wird. Bei der zusammengestellten Nachricht kann es sich um eine neue Nachricht, eine Antwort oder einen vorhandenen Entwurf handelt.

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

options

Office.AsyncContextOptions & { discardItem: boolean }

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. discardItem: Wenn true, wird die aktuelle Nachricht geschlossen, und nicht gespeicherte Änderungen werden verworfen. Wenn der Parameter nicht deklariert oder auf falsefestgelegt ist, wird ein Dialogfeld zum Speichern angezeigt, in dem der Benutzer aufgefordert wird, einen Entwurf zu speichern, Änderungen zu verwerfen oder den Vorgang abzubrechen. Dieses Verhalten tritt bei neuen Nachrichten und Antworten auf, die im Lesebereich angezeigt werden. Wenn Sie eine Antwort im Lesebereich oder einen vorhandenen Entwurf schließen möchten, müssen Sie auf truefestlegendiscardItem. Andernfalls gibt der Aufruf einen Fehler zurück. Weitere Informationen zu dem Fehler finden Sie im Abschnitt "Hinweise".

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: Postfach 1.14 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • The operation was cancelled by the user: Der Benutzer wählt Abbrechen aus dem Speicherdialogfeld aus, und die discardItem Eigenschaft ist nicht definiert oder auf falsefestgelegt.

  • The operation is not supported: Die closeAsync -Methode versucht, eine Antwort im Lesebereich oder einem vorhandenen Entwurf zu schließen, und die discardItem -Eigenschaft ist nicht definiert oder auf falsefestgelegt.

closeAsync(callback)

Schließt die aktuelle neue Nachricht, die erstellt wird.

Das Verhalten einer neuen Nachricht, die erstellt wird, hängt davon ab, ob die Nachricht nicht gespeicherte Änderungen enthält. Wenn keine Änderungen vorgenommen wurden, wird die Nachricht ohne ein Dialogfeld zum Speichern geschlossen. Wenn die Nachricht hingegen nicht gespeicherte Änderungen enthält, wird ein Dialogfeld zum Speichern angezeigt, in dem der Benutzer aufgefordert wird, einen Entwurf zu speichern, Änderungen zu verwerfen oder den Vorgang abzubrechen.

closeAsync(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: Postfach 1.14 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • The operation was cancelled by the user: Der Benutzer wählt im Dialogfeld "Speichern" abbrechen aus.

  • The operation is not supported: Die closeAsync -Methode versucht, eine Antwort im Lesebereich oder einen vorhandenen Entwurf zu schließen.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close-async.yaml

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

disableClientSignatureAsync(options, callback)

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

  • In Outlook im Web ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der -Methode deaktiviert.

  • In Outlook unter Windows und auf Mac ist die Signatur unter den Abschnitten Neue Nachrichten und Antworten/Weiterleitungen des sendenden Kontos auf (keine) festgelegt.

  • In Outlook für Android und unter iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => 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<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: Postfach 1.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig: Diese Methode wird ab Version 4.2352.0 in Outlook unter Android und unter iOS in Message Compose unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

disableClientSignatureAsync(callback)

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

  • In Outlook im Web ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der -Methode deaktiviert.

  • In Outlook unter Windows und auf Mac ist die Signatur unter den Abschnitten Neue Nachrichten und Antworten/Weiterleitungen des sendenden Kontos auf (keine) festgelegt.

  • In Outlook für Android und unter iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

disableClientSignatureAsync(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: Postfach 1.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig: Diese Methode wird ab Version 4.2352.0 in Outlook unter Android und unter iOS in Message Compose unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

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 auf mobilen Geräten 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: Verfassen von Nachrichten

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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/get-attachment-content.yaml

// Gets the attachments of the current message or appointment in compose mode.
const options = { asyncContext: { currentItem: item } };
// The getAttachmentsAsync call can only be used in compose mode.
item.getAttachmentsAsync(options, callback);

function callback(result) {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

  for (let i = 0; i < result.value.length; i++) {
    // Log the attachment type and its contents to the console.
    result.asyncContext.currentItem.getAttachmentContentAsync(result.value[i].id, handleAttachmentsCallback);
  }
}

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 auf mobilen Geräten 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: Verfassen von Nachrichten

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)

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: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

getAttachmentsAsync(callback)

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: Verfassen von Nachrichten

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(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: Verfassen von Nachrichten

Wichtig: Diese Methode wird in Outlook unter Android und unter iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

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.

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: Verfassen von Nachrichten

Wichtig: Diese Methode wird in Outlook unter Android und unter iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

getConversationIndexAsync(options, callback)

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: Verfassen von Nachrichten

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)

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: Verfassen von Nachrichten

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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-conversation-index.yaml

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

getInitializationContextAsync(options, callback)

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: Verfassen von Nachrichten

Beispiele

// Get the initialization context (if present).
Office.context.mailbox.item.getInitializationContextAsync((asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        if (asyncResult.value.length > 0) {
            // The value is a string, parse to an object.
            const context = JSON.parse(asyncResult.value);
            // Do something with context.
        } else {
            // Empty context, treat as no context.
        }
    } else {
        // Handle the error.
    }
});

getInitializationContextAsync(callback)

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: Verfassen von Nachrichten

getItemClassAsync(options, callback)

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: Verfassen von Nachrichten

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Elementklasse Beschreibung
IPM.Note Neue Nachrichten und Nachrichtenantworten
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)

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: Verfassen von Nachrichten

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Elementklasse Beschreibung
IPM.Note Neue Nachrichten und Nachrichtenantworten
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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-class-async.yaml

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current message.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current message: " + asyncResult.value);
});

getItemIdAsync(options, 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 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 im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird nicht itemId erkannt, und bei verwendung wird ein Fehler zurückgegeben.

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.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

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

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 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 im Zwischenspeichermodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. 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: Verfassen von Nachrichten

Fehler:

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/item-id-compose.yaml

Office.context.mailbox.item.getItemIdAsync(function (result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
        console.error(`getItemIdAsync failed with message: ${result.error.message}`);
    } else {
        console.log(result.value);
    }
});

getSelectedDataAsync(coercionType, options, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

coercionType

Office.CoercionType | string

Fordert ein Format für die Daten an. Wenn Text, gibt die Methode den Nur-Text als Zeichenfolge zurück und entfernt alle vorhandenen HTML-Tags. Gibt Htmldie Methode den markierten Text zurück, unabhängig davon, ob es sich um Klartext oder HTML handelt.

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.

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Get selected data.
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
};

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log("Selected text in " + prop + ": " + text);
}

getSelectedDataAsync(coercionType, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl vorhanden ist, sich aber der Cursor im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die Quelleigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, die entweder body oder subjectist.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

coercionType

Office.CoercionType | string

Fordert ein Format für die Daten an. Wenn Text, gibt die Methode den Nur-Text als Zeichenfolge zurück und entfernt alle vorhandenen HTML-Tags. Gibt Htmldie Methode den markierten Text zurück, unabhängig davon, ob es sich um Klartext oder HTML handelt.

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.

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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(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: Verfassen von Nachrichten

Hinweis: Diese Methode wird in Outlook unter iOS oder Android nicht unterstützt.

Wichtig: Im Nachrichtenerstellungsmodus wird diese API in Outlook im Web oder unter Windows 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on a message from a shared folder.");
  return;
}

Office.context.mailbox.getCallbackTokenAsync({ isRest: true }, function(result) {
  if (result.status === Office.AsyncResultStatus.Succeeded && result.value !== "") {
    Office.context.mailbox.item.getSharedPropertiesAsync(
      {
        // Pass auth token along.
        asyncContext: result.value
      },
      function(result2) {
        let sharedProperties = result2.value;
        let delegatePermissions = sharedProperties.delegatePermissions;

        // Determine if user has the appropriate permission to do the operation.
        if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Read) != 0) {
          const ewsId = Office.context.mailbox.item.itemId;
          const restId = Office.context.mailbox.convertToRestId(ewsId, Office.MailboxEnums.RestVersion.v2_0);
          let rest_url =
            sharedProperties.targetRestUrl + "/v2.0/users/" + sharedProperties.targetMailbox + "/messages/" + restId;

          $.ajax({
            url: rest_url,
            dataType: "json",
            headers: { Authorization: "Bearer " + result2.asyncContext }
          })
            .done(function(response) {
              console.log(response);
            })
            .fail(function(error) {
              console.error(error);
            });
        }
      }
    );
  }
});

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.

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: Verfassen von Nachrichten

Hinweis: Diese Methode wird in Outlook unter iOS oder Android nicht unterstützt.

Wichtig: Im Nachrichtenerstellungsmodus wird diese API in Outlook im Web oder unter Windows 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/65-delegates-and-shared-folders/get-shared-properties.yaml

if (!Office.context.mailbox.item.getSharedPropertiesAsync) {
  console.error("Try this sample on an item from a shared folder.");
  return;
}

Office.context.mailbox.item.getSharedPropertiesAsync(function(result) {
  console.log(result.value);
});

isClientSignatureEnabledAsync(options, callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

Bei Rich-Clients für Windows und Mac sollte der API-Aufruf zurückgeben true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. Für Outlook im Web sollte der API-Aufruf zurückgeben true , wenn die Signatur für Verfassentypen newMail, replyoder forwardaktiviert ist. Wenn die Einstellungen in Mac- oder Windows-Rich-Clients auf "(none)" festgelegt oder in Outlook im Web deaktiviert sind, sollte der API-Aufruf zurückgeben false.

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: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/work-with-client-signatures.yaml

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

isClientSignatureEnabledAsync(callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

Bei Rich-Clients für Windows und Mac sollte der API-Aufruf zurückgeben true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. Für Outlook im Web sollte der API-Aufruf zurückgeben true , wenn die Signatur für Verfassentypen newMail, replyoder forwardaktiviert ist. Wenn die Einstellungen in Mac- oder Windows-Rich-Clients auf "(none)" festgelegt oder in Outlook im Web deaktiviert sind, sollte der API-Aufruf zurückgeben false.

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: Verfassen von Nachrichten

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, festzulegen, zu speichern und zu entfernen.

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: Verfassen von Nachrichten

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten 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.

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

Parameter

attachmentId

string

Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.

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<void>) => void

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig*: Die removeAttachmentAsync -Methode entfernt keine Inlineanlagen aus einem E-Mail-Element. Um eine Inlineanlage zu entfernen, rufen Sie zuerst den Text des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus ihrem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

  • InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web und auf mobilen Geräten 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.

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

Parameter

attachmentId

string

Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge von attachmentId beträgt 200 Zeichen in Outlook im Web und unter Windows.

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Wichtig*: Die removeAttachmentAsync -Methode entfernt keine Inlineanlagen aus einem E-Mail-Element. Um eine Inlineanlage zu entfernen, rufen Sie zuerst den Text des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus ihrem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

  • InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.

removeHandlerAsync(eventType, options, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

removeHandlerAsync(eventType: Office.EventType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

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<void>) => 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.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

removeHandlerAsync(eventType, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Hinweis: Ereignisse sind nur bei der Implementierung des Aufgabenbereichs verfügbar.

Unterstützte Ereignisse finden Sie im Abschnitt Item-Objektmodellereignisse.

removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

callback

(asyncResult: Office.AsyncResult<void>) => 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.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

saveAsync(options, callback)

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 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: Verfassen von Nachrichten

Wichtig:

  • In Outlook im Web oder Outlook im Onlinemodus 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.

  • 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 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)

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 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: Verfassen von Nachrichten

Wichtig:

  • In Outlook im Web oder Outlook im Onlinemodus 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.

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

Beispiele

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: Bei Text wird die aktuelle Formatvorlage in Outlook im Web und auf Desktopclients angewendet. Wenn das Feld ein HTML-Editor ist, werden nur die Textdaten eingefügt, selbst wenn es sich bei den Daten um HTML-Daten handelt. Wenn HTML und das Feld HTML unterstützen (der Betreff nicht), wird die aktuelle Formatvorlage in Outlook im Web und die Standardformatvorlage in Outlook auf Desktopclients angewendet. Ist das Feld ein Textfeld, wird ein Fehler des Typs InvalidDataFormat zurückgegeben. Wenn coercionType nicht festgelegt wird, hängt das Ergebnis vom Feld ab: Wenn das Feld HTML ist, wird HTML verwendet. Wenn das Feld Text ist, wird Nur-Text verwendet.

callback

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

Optional. 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.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });
Office.context.mailbox.item.setSelectedDataAsync("Hello World!");
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/set-selected-data.yaml

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.

callback

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

Optional. 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.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Verfassen von Nachrichten

Fehler:

  • InvalidAttachmentId: Der Anlagenbezeichner ist nicht vorhanden.