Office.LoadedMessageCompose interface

Paket:
outlook

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

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

  • Ermitteln Sie beim Implementieren der Elementmehrfachauswahlfunktion, ob Sie bereits über den Office.context.mailbox.getSelectedItemsAsync Aufruf auf die erforderlichen Eigenschaften des ausgewählten Elements zugreifen können. Wenn Sie können, müssen Sie nicht anrufen loadItemByIdAsync.

  • Es kann immer nur jeweils ein E-Mail-Element geladen werden. Wenn Sie implementieren loadItemByIdAsync, müssen Sie nach der Verarbeitung des Elements aufrufen unloadAsync . Dies muss vor dem Aufruf loadItemByIdAsync eines anderen Elements erfolgen.

Verwendet von

Beispiele

// Gets the sender's email address of each selected message.
async function getSenderEmailAddress(item) {
    const itemId = item.itemId;
    await new Promise((resolve) => {
        Office.context.mailbox.loadItemByIdAsync(itemId, (result) => {
            if (result.status === Office.AsyncResultStatus.Failed) {
                console.log(result.error.message);
                return;
            }

            const loadedItem = result.value;
            const sender = loadedItem.from.emailAddress;
            console.log(sender);

            // Unload the current message before processing another selected message.
            loadedItem.unloadAsync((asyncResult) => {
                if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                    console.log(asyncResult.error.message);
                    return;
                }

                resolve();
            });
        });
    });
}

Eigenschaften

bcc

Ruft die Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht ab.
body

Ruft den Text und das Format des Elements ab.
categories

Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
cc

Ruft Empfänger in der Cc-Zeile (Durchschlag) einer Nachricht ab.
conversationId

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

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

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

Ruft das Datum und die Uhrzeit der verspäteten Zustellung einer Nachricht ab.
from

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

Ruft die Nachrichten-ID der ursprünglichen Nachricht ab, auf die die aktuelle Nachricht antwortet.
internetHeaders

Ruft die benutzerdefinierten Internetheader einer Nachricht ab.

Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen 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 es sich bei der item-Objekt-instance um eine Nachricht oder einen Termin handelt.
notificationMessages

Ruft die Benachrichtigungsmeldungen des Elements ab.
sensitivityLabel

Ruft die Vertraulichkeitsbezeichnung einer Nachricht ab.
seriesId

Ruft die ID der Serie ab, zu der eine Instance gehört.

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

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

Die subject Eigenschaft ruft den vollständigen Betreff des Elements ab, wie er vom E-Mail-Server gesendet wurde.
to

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

Methoden

getAttachmentContentAsync(attachmentId, options, callback)

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
getAttachmentContentAsync(attachmentId, callback)

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.
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 der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp kann HTML oder Nur-Text sein.
getComposeTypeAsync(callback)

Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp kann HTML oder Nur-Text sein.
getConversationIndexAsync(options, callback)

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.
getConversationIndexAsync(callback)

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.
getInitializationContextAsync(options, callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
getInitializationContextAsync(callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.
getItemClassAsync(options, callback)

Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
getItemClassAsync(callback)

Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
getItemIdAsync(options, callback)

Ruft asynchron die Exchange-Webdienste (Exchange-Webdienste, EWS)-Element-ID eines gespeicherten Elements ab.

Beim Aufrufen gibt diese Methode die Element-ID über die Rückruffunktion zurück.
getItemIdAsync(callback)

Ruft asynchron die ID eines gespeicherten Elements ab.

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

Hinweis: Wenn Ihr Add-In ein Element im Erstellungsmodus aufruft getItemIdAsync (z. B. um ein itemId Kennwort für EWS oder die REST-API zu erhalten), beachten Sie, dass es im Outlook-Cachemodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird es itemId nicht erkannt, und bei seiner Verwendung wird ein Fehler zurückgegeben.
getSharedPropertiesAsync(options, callback)

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

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren freigegebener Ordner und Szenarien für 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 freigegebener Ordner und Szenarien für freigegebene Postfächer in einem Outlook-Add-In.
isClientSignatureEnabledAsync(options, callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

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

Ruft ab, ob die Clientsignatur aktiviert ist.

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

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

Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und pro 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 nicht für das Element verschlüsselt und sollten daher nicht als sicherer Speicher verwendet werden.

Die benutzerdefinierten Eigenschaften werden als CustomProperties-Objekt in der asyncResult.value-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften des E-Mail-Elements abzurufen.
saveAsync(options, callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.
saveAsync(callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.
unloadAsync(options, callback)

Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.
unloadAsync(callback)

Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

Details zur Eigenschaft

bcc

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

bcc: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Je nach Outlook-Client und -Plattform können Beschränkungen hinsichtlich der Anzahl der Empfänger gelten. Weitere Informationen finden Sie unter dem Recipients-Objekt .

body

Ruft den Text und das Format des Elements ab.

body: Body;

Eigenschaftswert

Office.Body

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

categories

Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.

categories: Categories;

Eigenschaftswert

Office.Categories

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

cc

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

cc: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Je nach Outlook-Client und -Plattform können Beschränkungen hinsichtlich der Anzahl der Empfänger gelten. Weitere Informationen finden Sie unter dem 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.

conversationId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

delayDeliveryTime

Ruft das Datum und die Uhrzeit der verspäteten Zustellung einer Nachricht ab.

delayDeliveryTime: DelayDeliveryTime;

Eigenschaftswert

Office.DelayDeliveryTime

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

from

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

from: From;

Eigenschaftswert

Office.From

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

inReplyTo

Ruft die Nachrichten-ID der ursprünglichen Nachricht ab, auf die die aktuelle Nachricht antwortet.

inReplyTo: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Die inReplyTo Eigenschaft wird zurückgegeben null , wenn neue Nachrichten und Besprechungseinladungen von einem Benutzer weitergeleitet werden, der auch der Besprechungsorganisator ist.

internetHeaders

Ruft die benutzerdefinierten Internetheader einer Nachricht ab.

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

internetHeaders: InternetHeaders;

Eigenschaftswert

Office.InternetHeaders

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

itemType

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

Die itemType Eigenschaft gibt einen der Enumerationswerte zurück, der ItemType angibt, ob es sich bei der item-Objekt-instance um eine Nachricht oder einen Termin handelt.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

notificationMessages

Ruft die Benachrichtigungsmeldungen des Elements ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Office.NotificationMessages

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

sensitivityLabel

Ruft die Vertraulichkeitsbezeichnung einer Nachricht ab.

sensitivityLabel: SensitivityLabel;

Eigenschaftswert

Office.SensitivityLabel

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

  • Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5-Abonnement verfügen.

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

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

seriesId

Ruft die ID der Serie ab, zu der eine Instance gehört.

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

seriesId: string;

Eigenschaftswert

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

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

subject

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

Die subject Eigenschaft ruft den vollständigen Betreff des Elements ab, wie er vom E-Mail-Server gesendet wurde.

subject: Subject;

Eigenschaftswert

Office.Subject

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

to

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

to: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Je nach Outlook-Client und -Plattform können Beschränkungen hinsichtlich der Anzahl der Empfänger gelten. Weitere Informationen finden Sie unter dem Recipients-Objekt .

Details zur Methode

getAttachmentContentAsync(attachmentId, options, callback)

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

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

Parameter

attachmentId

string

Der Bezeichner der Anlage, die Sie abrufen möchten. In Outlook im Web und im neuen Outlook unter Windows wird die temporäre Anlagen-ID, die lokal für Inlinebilder generiert wird, die noch nicht auf den Server hochgeladen wurden, für die Dauer der aktuellen Erstellungssitzung unterstützt.

options
Office.AsyncContextOptions

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

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, asyncResultder 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: Message Compose

Wichtig:

  • 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 diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

  • Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows lokal eine temporäre Anlagen-ID zugewiesen, während sie auf den Server hochgeladen werden. Einer temporären Anlagen-ID wird das Präfix vorangestellt.addinId Nachdem die Bilder auf den Server hochgeladen wurden, wird ihnen eine Exchange-Webdienste-ID (EWS) zugewiesen. Die temporäre Anlagen-ID wird nur für die Dauer der aktuellen Verfassen-Sitzung unterstützt. Weitere Informationen zu den Änderungen an der Handhabung von Inlinebildern finden Sie unter Änderungen an Anlagen-IDs für Inlinebilder in Outlook-Add-Ins.

  • In Outlook im Web und dem neuen Outlook unter Windows werden Anlagen nicht unterstützt, getAttachmentContentAsync die mit der Option "Hochladen und Freigeben" hinzugefügt wurden.

  • In Outlook im Web, auf mobilen Geräten und im neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt oder wenn der Benutzer mit dem Verfassen eines Inlineformulars beginnt und das Formular anschließend ausblendet, um in einem separaten Fenster fortzufahren.

Fehler:

  • AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Nicht unterstützte Typen sind eingebettete Bilder im Rich-Text-Format oder andere Element-Anlagentypen als E-Mail oder Kalenderelemente (z. B. Kontakte oder Aufgabenelemente).

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getAttachmentContentAsync(attachmentId, callback)

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

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

Parameter

attachmentId

string

Der Bezeichner der Anlage, die Sie abrufen möchten. In Outlook im Web und im neuen Outlook unter Windows wird die temporäre Anlagen-ID, die lokal für Inlinebilder generiert wird, die noch nicht auf den Server hochgeladen wurden, für die Dauer der aktuellen Erstellungssitzung unterstützt.

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, asyncResultder 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: Message Compose

Wichtig:

  • 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 diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

  • Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows lokal eine temporäre Anlagen-ID zugewiesen, während sie auf den Server hochgeladen werden. Einer temporären Anlagen-ID wird das Präfix vorangestellt.addinId Nachdem die Bilder auf den Server hochgeladen wurden, wird ihnen eine Exchange-Webdienste-ID (EWS) zugewiesen. Die temporäre Anlagen-ID wird nur für die Dauer der aktuellen Verfassen-Sitzung unterstützt. Weitere Informationen zu den Änderungen an der Handhabung von Inlinebildern finden Sie unter Änderungen an Anlagen-IDs für Inlinebilder in Outlook-Add-Ins.

  • In Outlook im Web und dem neuen Outlook unter Windows werden Anlagen nicht unterstützt, getAttachmentContentAsync die mit der Option "Hochladen und Freigeben" hinzugefügt wurden.

  • In Outlook im Web, auf mobilen Geräten und im neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt oder wenn der Benutzer mit dem Verfassen eines Inlineformulars beginnt und das Formular anschließend ausblendet, um in einem separaten Fenster fortzufahren.

Fehler:

  • AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Nicht unterstützte Typen sind eingebettete Bilder im Rich-Text-Format oder andere Element-Anlagentypen als E-Mail oder Kalenderelemente (z. B. Kontakte oder Aufgabenelemente).

  • 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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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. Wenn der Aufruf erfolgreich ist, wird ein Array von AttachmentDetailsCompose Objekten in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

  • Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows lokal eine temporäre Anlagen-ID zugewiesen, während sie auf den Server hochgeladen werden. Einer temporären Anlagen-ID wird das Präfix vorangestellt.addinId Nachdem die Bilder auf den Server hochgeladen wurden, wird ihnen eine Exchange-Webdienste-ID (EWS) zugewiesen. Die temporäre Anlagen-ID wird nur für die Dauer der aktuellen Verfassen-Sitzung unterstützt. Weitere Informationen zu den Änderungen an der Handhabung von Inlinebildern finden Sie unter Änderungen an Anlagen-IDs für Inlinebilder in Outlook-Add-Ins.

  • In Outlook im Web und dem neuen Outlook unter Windows können Benutzer die Option Hochladen und freigeben auswählen, um eine Anlage auf OneDrive hochzuladen und einen Link zur Datei in das E-Mail-Element einzufügen. Da jedoch nur ein Link enthalten ist, getAttachmentsAsync wird diese Anlage nicht zurückgegeben.

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. Wenn der Aufruf erfolgreich ist, wird ein Array von AttachmentDetailsCompose Objekten in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

  • Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows lokal eine temporäre Anlagen-ID zugewiesen, während sie auf den Server hochgeladen werden. Einer temporären Anlagen-ID wird das Präfix vorangestellt.addinId Nachdem die Bilder auf den Server hochgeladen wurden, wird ihnen eine Exchange-Webdienste-ID (EWS) zugewiesen. Die temporäre Anlagen-ID wird nur für die Dauer der aktuellen Verfassen-Sitzung unterstützt. Weitere Informationen zu den Änderungen an der Handhabung von Inlinebildern finden Sie unter Änderungen an Anlagen-IDs für Inlinebilder in Outlook-Add-Ins.

  • In Outlook im Web und dem neuen Outlook unter Windows können Benutzer die Option Hochladen und freigeben auswählen, um eine Anlage auf OneDrive hochzuladen und einen Link zur Datei in das E-Mail-Element einzufügen. Da jedoch nur ein Link enthalten ist, getAttachmentsAsync wird diese Anlage nicht zurückgegeben.

getComposeTypeAsync(options, callback)

Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp 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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

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 Coerciion-Typ des Elements.

Gibt zurück

void

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

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

getComposeTypeAsync(callback)

Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp 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 Coerciion-Typ des Elements.

Gibt zurück

void

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

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

getConversationIndexAsync(options, callback)

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread 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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

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

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder 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: Message Compose

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

getConversationIndexAsync(callback)

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread 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, asyncResultder 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: Message Compose

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

getInitializationContextAsync(options, callback)

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

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

Parameter

options
Office.AsyncContextOptions

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

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 erfolgreicher Ausführung werden die Initialisierungskontextdaten als Zeichenfolge (oder als 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: Message Compose

getInitializationContextAsync(callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht 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 erfolgreicher Ausführung werden die Initialisierungskontextdaten als Zeichenfolge (oder als 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: Message Compose

getItemClassAsync(options, callback)

Ruft die Exchange-Webdienste-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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

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

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder 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: Message Compose

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-Webdienste-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, asyncResultder 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: Message Compose

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

getItemIdAsync(options, callback)

Ruft asynchron die Exchange-Webdienste (Exchange-Webdienste, EWS)-Element-ID eines gespeicherten Elements ab.

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

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

Parameter

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Wenn Ihr Add-In ein Element im Erstellungsmodus aufruft getItemIdAsync (z. B. um ein itemId Element mit EWS oder der REST-API zu erhalten), beachten Sie, dass es im Outlook-Cachemodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird es itemId nicht erkannt, und bei seiner Verwendung wird ein Fehler zurückgegeben.

Fehler:

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

getItemIdAsync(callback)

Ruft asynchron die ID eines gespeicherten Elements ab.

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

Hinweis: Wenn Ihr Add-In ein Element im Erstellungsmodus aufruft getItemIdAsync (z. B. um ein itemId Kennwort für EWS oder die REST-API zu erhalten), beachten Sie, dass es im Outlook-Cachemodus einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird es itemId nicht erkannt, und bei seiner 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: Message Compose

Fehler:

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

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 freigegebener Ordner und Szenarien für 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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

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

Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder 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 Unterstützung für gemeinsam genutzte Ordner, Postfach 1.13 für Unterstützung für gemeinsam genutzte Postfächer

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

a. Zugriff delegieren/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 die Stellvertretung freigegeben wurde.

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

b. Freigegebenes Postfach, das im selben Bereich wie das primäre Postfach des Benutzers geöffnet ist (Web, klassisches Windows) oder das freigegebene Postfach, das nicht zu einem vollständigen Konto heraufgestuft wurde (neues 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 das Verfassen dann fort.

Sobald diese Bedingungen erfüllt sind, wird die Nachricht in einem freigegebenen Kontext verfügbar, und Add-Ins, die diese gemeinsamen Szenarien unterstützen, können die gemeinsamen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner "Gesendete Elemente " des persönlichen Postfachs des Absenders.

Die getSharedPropertiesAsync Methode wird auf den folgenden Plattformen ohne zusätzliche Bedingungen unterstützt.

  • Outlook im Web, wenn das freigegebene Postfach mithilfe der Option "Anderes Postfach öffnen" in einer separaten Registerkarte oder einem separaten Fenster geöffnet wird.

  • Neues Outlook unter Windows, wenn das freigegebene Postfach zu einem vollständigen Konto heraufgestuft wird.

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 freigegebener Ordner und Szenarien für 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, asyncResultder 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 Unterstützung für gemeinsam genutzte Ordner, Postfach 1.13 für Unterstützung für gemeinsam genutzte Postfächer

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

a. Zugriff delegieren/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 die Stellvertretung freigegeben wurde.

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

b. Freigegebenes Postfach, das im selben Bereich wie das primäre Postfach des Benutzers geöffnet ist (Web, klassisches Windows) oder das freigegebene Postfach, das nicht zu einem vollständigen Konto heraufgestuft wurde (neues 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 das Verfassen dann fort.

Sobald diese Bedingungen erfüllt sind, wird die Nachricht in einem freigegebenen Kontext verfügbar, und Add-Ins, die diese gemeinsamen Szenarien unterstützen, können die gemeinsamen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner "Gesendete Elemente " des persönlichen Postfachs des Absenders.

Die getSharedPropertiesAsync Methode wird auf den folgenden Plattformen ohne zusätzliche Bedingungen unterstützt.

  • Outlook im Web, wenn das freigegebene Postfach mithilfe der Option "Anderes Postfach öffnen" in einer separaten Registerkarte oder einem separaten Fenster geöffnet wird.

  • Neues Outlook unter Windows, wenn das freigegebene Postfach zu einem vollständigen Konto heraufgestuft wird.

isClientSignatureEnabledAsync(options, callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

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

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

Parameter

options
Office.AsyncContextOptions

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

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: Message Compose

isClientSignatureEnabledAsync(callback)

Ruft ab, ob die Clientsignatur aktiviert ist.

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

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

Parameter

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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 pro 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 nicht für das Element verschlüsselt und sollten daher nicht als sicherer Speicher verwendet werden.

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

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

Parameter

callback

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

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

userContext

any

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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: asyncContext: Entwickler können jedes Objekt, auf das sie zugreifen möchten, in der Rückruffunktion bereitstellen.

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

  • Der zurückgegebene Bezeichner ist mit dem Bezeichner des Exchange-Webdienstes (Exchange-Webdienste, EWS) identisch. Die zurückgegebene Element-ID ist nicht identisch mit der Outlook-Eintrags-ID oder der ID, die von der Outlook-REST-API verwendet wird. Bevor REST-API-Aufrufe mit diesem Wert durchgeführt werden, sollte er mit Office.context.mailbox.convertToRestIdkonvertiert werden.

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

  • In Outlook im Web und im neuen Outlook unter Windows variiert das Postfachkonto, in dem ein Entwurf gespeichert wird, wenn saveAsync es 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 das Konto des freigegebenen Postfachs im Feld "Von " auswählt, saveAsync wird der Entwurf im Ordner "Entwürfe" des persönlichen Postfachs des Benutzers gespeichert. Öffnet der Absender das Konto für das freigegebene Postfach in einer separaten Browser-Registerkarte (z. B. über die Option " Anderes Postfach öffnen ") und erstellt dort eine neue Nachricht, saveAsync wird der Entwurf im Ordner "Entwürfe" des freigegebenen Postfachs gespeichert.

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, asyncResultder ein Office.AsyncResult Objekt ist. Die EWS-Nachrichten-ID wird in der asyncResult.value Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

  • Der zurückgegebene Bezeichner ist mit dem Bezeichner des Exchange-Webdienstes (Exchange-Webdienste, EWS) identisch. Die zurückgegebene Element-ID ist nicht identisch mit der Outlook-Eintrags-ID oder der ID, die von der Outlook-REST-API verwendet wird. Bevor REST-API-Aufrufe mit diesem Wert durchgeführt werden, sollte er mit Office.context.mailbox.convertToRestIdkonvertiert werden.

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

  • In Outlook im Web und im neuen Outlook unter Windows variiert das Postfachkonto, in dem ein Entwurf gespeichert wird, wenn saveAsync es 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 das Konto des freigegebenen Postfachs im Feld "Von " auswählt, saveAsync wird der Entwurf im Ordner "Entwürfe" des persönlichen Postfachs des Benutzers gespeichert. Öffnet der Absender das Konto für das freigegebene Postfach in einer separaten Browser-Registerkarte (z. B. über die Option " Anderes Postfach öffnen ") und erstellt dort eine neue Nachricht, saveAsync wird der Entwurf im Ordner "Entwürfe" des freigegebenen Postfachs gespeichert.

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

unloadAsync(options, callback)

Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

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

Parameter

options
Office.AsyncContextOptions

Ein Objektliteral, das die asyncContext Eigenschaft enthält. Weisen Sie der asyncContext Eigenschaft jedes Objekt zu, 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, asyncResultbei dem es sich um ein Office.AsyncResult Objekt handelt.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Wenn ein ausgewähltes E-Mail-Element mit loadItemByIdAsyncgeladen wird, müssen Sie es nach der Verarbeitung aufrufen unloadAsync . Dies muss erfolgen, bevor ein anderes ausgewähltes Element aufgerufen loadItemByIdAsync wird.

unloadAsync(callback)

Wenn mehrere E-Mail-Elemente ausgewählt sind, wird das aktuell geladene Element geschlossen, sodass ein anderes ausgewähltes E-Mail-Element zur Verarbeitung geladen werden kann.

unloadAsync(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, asyncResultbei dem es sich um ein Office.AsyncResult Objekt handelt.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

  • Wenn ein ausgewähltes E-Mail-Element mit loadItemByIdAsyncgeladen wird, müssen Sie es nach der Verarbeitung aufrufen unloadAsync . Dies muss erfolgen, bevor ein anderes ausgewähltes Element aufgerufen loadItemByIdAsync wird.