Office.LoadedMessageRead interface

Paket:

outlook

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

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

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

• Office.Mailbox: loadItemByIdAsync

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

attachments	Ruft die Anlagen des Elements als Array 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. Die cc Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Cc-Zeile der Nachricht aufgeführt ist. Die maximale Anzahl von Empfängern, die zurückgegeben werden, variiert je nach Outlook-Client. Windows (klassisch): 500 Empfänger Windows (klassisch – in der Vorschauversion ab Version 2511 (Build 19426.20000)): 1.000 Empfänger Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 500 Empfänger (erweiterte Ansicht)
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.
dateTimeCreated	Ruft das Datum und die Uhrzeit der Erstellung eines Elements ab.
dateTimeModified	Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.
end	Ruft das Datum und die Uhrzeit ab, zu dem/der der Termin enden soll. Die end Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime Methode verwenden, um den end Eigenschaftswert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren. Wenn Sie die Time.setAsync-Methode verwenden, um die Endzeit im Verfassenmodus festzulegen, sollten Sie die convertToUtcClientTime-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.
from	Ruft die E-Mail-Adresse des Absenders einer Nachricht ab. Die from Eigenschaft gibt ein EmailAddressDetails Objekt zurück.
internetMessageId	Ruft den Internetnachrichtenbezeichner einer Nachricht ab.
itemClass	Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
itemId	Ruft den Bezeichner des Exchange-Webdienste-Elements für das aktuelle Element ab.
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.
location	Ruft den Speicherort einer Besprechungsanfrage ab. Die location-Eigenschaft gibt eine Zeichenfolge zurück, die den Ort des Termins enthält.
normalizedSubject	Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt werden (einschließlich RE: und FWD:). Die normalizedSubject Eigenschaft ruft den Betreff des Elements mit allen Standardpräfixen (z. B. RE: und FW:) ab, die von E-Mail-Programmen hinzugefügt werden. Um den Betreff des Elements mit intakten Präfixen abzurufen, verwenden Sie die subject Eigenschaft.
notificationMessages	Ruft die Benachrichtigungsmeldungen des Elements ab.
recurrence	Ruft das Serienmuster eines Termins ab. Ruft das Serienmuster einer Besprechungsanfrage ab. Lese- und Verfassenmodus für Terminelemente. Lesemodus für Besprechungsanfrageelemente. Die recurrence Eigenschaft gibt ein Recurrence Objekt für wiederkehrende Termine oder Besprechungsanfragen zurück, wenn es sich bei einem Element um eine Serie oder eine instance in einer Serie handelt. null wird für einzelne Termine und Besprechungsanfragen einzelner Termine zurückgegeben. undefined wird für Nachrichten zurückgegeben, die keine Besprechungsanfragen sind.
sender	Ruft die E-Mail-Adresse des Absenders einer E-Mail-Nachricht ab.
seriesId	Ruft die ID der Serie ab, zu der eine Instance gehört. 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.
start	Ruft das Datum und die Uhrzeit ab, zu der der Termin beginnen soll. Die start Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime Methode verwenden, um den Wert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.
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. Die subject-Eigenschaft gibt eine Zeichenfolge zurück. Verwenden Sie die normalizedSubject Eigenschaft, um den Betreff abzüglich aller führenden Präfixe wie RE: und FW: abzurufen.
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. Die to Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Zeile "An" der Nachricht aufgeführt ist. Die maximale Anzahl von Empfängern, die zurückgegeben werden, variiert je nach Outlook-Client. Windows (klassisch): 500 Empfänger Windows (klassisch – in der Vorschauversion ab Version 2511 (Build 19426.20000)): 1.000 Empfänger Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 500 Empfänger (erweiterte Ansicht)

Methoden

displayReplyAllFormAsync(formData, options, callback)	Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.
displayReplyAllFormAsync(formData, callback)	Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.
displayReplyFormAsync(formData, options, callback)	Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
displayReplyFormAsync(formData, callback)	Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
getAllInternetHeadersAsync(options, callback)	Ruft alle Internetheader für die Nachricht als Zeichenfolge ab. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen für eine Nachricht in einem Outlook-Add-In.
getAllInternetHeadersAsync(callback)	Ruft alle Internetheader für die Nachricht als Zeichenfolge ab. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen für eine Nachricht in einem Outlook-Add-In.
getAsFileAsync(options, callback)	Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.
getAsFileAsync(callback)	Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.
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.
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.
getRegExMatches()	Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind.
getRegExMatchesByName(name)	Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer XML-Anwendungsmanifestdatei definiert ist.
getSelectedRegExMatches()	Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins.
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.
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.
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

attachments

Ruft die Anlagen des Elements als Array ab.

attachments: AttachmentDetails[];

Eigenschaftswert

Office.AttachmentDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Bestimmte Typen von Dateien werden aufgrund von potenziellen Sicherheitsprobleme von Outlook blockiert und daher nicht zurückgegeben. Weitere Informationen finden Sie unter Blockierte Anlagen in Outlook.

• Anlagen, die mit der Option "Hochladen und teilen " hinzugefügt wurden, werden nicht zurückgegeben.

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: Nachricht lesen

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: Nachricht lesen

cc

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

Die cc Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Cc-Zeile der Nachricht aufgeführt ist. Die maximale Anzahl von Empfängern, die zurückgegeben werden, variiert je nach Outlook-Client.

• Windows (klassisch): 500 Empfänger

• Windows (klassisch – in der Vorschauversion ab Version 2511 (Build 19426.20000)): 1.000 Empfänger

• Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 500 Empfänger (erweiterte Ansicht)

cc: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

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.

conversationId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

dateTimeCreated

Ruft das Datum und die Uhrzeit der Erstellung eines Elements ab.

dateTimeCreated: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

dateTimeModified

Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.

dateTimeModified: Date;

Eigenschaftswert

Date

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig: Diese Eigenschaft wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

end

Ruft das Datum und die Uhrzeit ab, zu dem/der der Termin enden soll.

Die end Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime Methode verwenden, um den end Eigenschaftswert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.

Wenn Sie die Time.setAsync-Methode verwenden, um die Endzeit im Verfassenmodus festzulegen, sollten Sie die convertToUtcClientTime-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.

end: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

from

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

Die from Eigenschaft gibt ein EmailAddressDetails Objekt zurück.

from: EmailAddressDetails;

Eigenschaftswert

Office.EmailAddressDetails

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Die und-Eigenschaften stellen dieselbe Person dar, es sei denn, die Nachricht wird von einer Stellvertretung mit Berechtigungen zum Senden im Auftrag von Senden gesendet.fromsender In diesem Fall gibt die from Eigenschaft die E-Mail-Adresse des Postfachbesitzers oder des freigegebenen Postfachs zurück, und die sender Eigenschaft gibt die Adresse der Stellvertretung zurück. Wenn die Stellvertretung sowohl über die Berechtigung "Senden im Auftrag von" als auch über die Berechtigung "Senden als " verfügt, gilt die Berechtigung "Senden als ". Informationen zur Postfachdelegierung finden Sie unter Verwalten von Berechtigungen für Empfänger in Exchange Online.

• Die recipientType Eigenschaft des Objekts EmailAddressDetails in der from Eigenschaft ist nicht definiert.

internetMessageId

Ruft den Internetnachrichtenbezeichner einer Nachricht ab.

internetMessageId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig: Im Ordner "Gesendete Objekte " sind sie internetMessageId möglicherweise noch nicht für zuletzt gesendete Objekte verfügbar. In diesem Fall sollten Sie abhängig von Ihrer Exchange-Umgebung eine der folgenden Optionen verwenden.

• Verwenden Sie für Exchange Online Microsoft Graph, um die internetMessageId-Eigenschaft abzurufen.

• Verwenden Sie für Exchange Server (lokal) Exchange-Webdienste, um die InternetMessageId-Eigenschaft vom Server abzurufen.

itemClass

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

itemClass: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

In der folgenden Tabelle sind die Standardelementklassen für Nachrichten 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

Sie können benutzerdefinierte Klassen erstellen, die eine Standardelementklasse erweitern. Beispiel: IPM.Note.Contoso.

itemId

Ruft den Bezeichner des Exchange-Webdienste-Elements für das aktuelle Element ab.

itemId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Die itemId Eigenschaft ist im Verfassenmodus nicht verfügbar. Wenn ein Elementbezeichner erforderlich ist, kann die Office.context.mailbox.item.saveAsync Methode verwendet werden, um den Artikel im Shop zu speichern, wodurch der Elementbezeichner im asyncResult.value Parameter in der Rückruffunktion zurückgegeben wird. Wenn das Element bereits gespeichert ist, können Sie stattdessen die Office.context.mailbox.item.getItemIdAsync Methode aufrufen.

• Der von der itemId Eigenschaft zurückgegebene Bezeichner ist mit dem Bezeichner des Exchange-Webdienst-Elements identisch. Die itemId Eigenschaft 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.

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: Nachricht lesen

location

Ruft den Speicherort einer Besprechungsanfrage ab.

Die location-Eigenschaft gibt eine Zeichenfolge zurück, die den Ort des Termins enthält.

location: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

normalizedSubject

Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt werden (einschließlich RE: und FWD:).

Die normalizedSubject Eigenschaft ruft den Betreff des Elements mit allen Standardpräfixen (z. B. RE: und FW:) ab, die von E-Mail-Programmen hinzugefügt werden. Um den Betreff des Elements mit intakten Präfixen abzurufen, verwenden Sie die subject Eigenschaft.

normalizedSubject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

notificationMessages

Ruft die Benachrichtigungsmeldungen des Elements ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Office.NotificationMessages

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Informationen zu den verschiedenen Typen von Benachrichtigungen, die Sie implementieren können, finden Sie unter Erstellen von Benachrichtigungen für Ihr Outlook-Add-In.

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

recurrence

Ruft das Serienmuster eines Termins ab. Ruft das Serienmuster einer Besprechungsanfrage ab. Lese- und Verfassenmodus für Terminelemente. Lesemodus für Besprechungsanfrageelemente.

Die recurrence Eigenschaft gibt ein Recurrence Objekt für wiederkehrende Termine oder Besprechungsanfragen zurück, wenn es sich bei einem Element um eine Serie oder eine instance in einer Serie handelt. null wird für einzelne Termine und Besprechungsanfragen einzelner Termine zurückgegeben. undefined wird für Nachrichten zurückgegeben, die keine Besprechungsanfragen sind.

recurrence: Recurrence;

Eigenschaftswert

Office.Recurrence

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Besprechungsanfragen haben einen itemClass-Wert von .IPM.Schedule.Meeting.Request

• Wenn das recurrence Objekt NULL ist, bedeutet dies, dass es sich bei dem Objekt um einen einzelnen Termin oder um eine Besprechungsanfrage für einen einzelnen Termin und nicht um einen Teil einer Serie handelt.

• Es werden nur die Eigenschaften und die getAsync Methode des Serienobjekts unterstützt.

sender

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

sender: EmailAddressDetails;

Eigenschaftswert

Office.EmailAddressDetails

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Die und-Eigenschaften stellen dieselbe Person dar, es sei denn, die Nachricht wird von einer Stellvertretung mit Berechtigungen zum Senden im Auftrag von Senden gesendet.fromsender In diesem Fall gibt die from Eigenschaft die E-Mail-Adresse des Postfachbesitzers oder des freigegebenen Postfachs zurück, und die sender Eigenschaft gibt die Adresse der Stellvertretung zurück. Wenn die Stellvertretung sowohl über die Berechtigung "Senden im Auftrag von" als auch über die Berechtigung "Senden als " verfügt, gilt die Berechtigung "Senden als ". Informationen zur Postfachdelegierung finden Sie unter Verwalten von Berechtigungen für Empfänger in Exchange Online.

• Die recipientType Eigenschaft des Objekts EmailAddressDetails in der sender Eigenschaft ist nicht definiert.

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: Nachricht lesen

Wichtig:

• Der Bezeichner, der von der seriesId-Eigenschaft zurückgegeben wird, ist der gleiche Bezeichner wie der Exchange-Webdienste-Elementbezeichner. 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.

start

Ruft das Datum und die Uhrzeit ab, zu der der Termin beginnen soll.

Die start Eigenschaft ist ein Date Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die convertToLocalClientTime Methode verwenden, um den Wert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.

start: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

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.

Die subject-Eigenschaft gibt eine Zeichenfolge zurück. Verwenden Sie die normalizedSubject Eigenschaft, um den Betreff abzüglich aller führenden Präfixe wie RE: und FW: abzurufen.

subject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

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.

Die to Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Zeile "An" der Nachricht aufgeführt ist. Die maximale Anzahl von Empfängern, die zurückgegeben werden, variiert je nach Outlook-Client.

• Windows (klassisch): 500 Empfänger

• Windows (klassisch – in der Vorschauversion ab Version 2511 (Build 19426.20000)): 1.000 Empfänger

• Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 500 Empfänger (erweiterte Ansicht)

to: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Details zur Methode

displayReplyAllFormAsync(formData, options, callback)

Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData

string | Office.ReplyFormData

Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen. Die Zeichenfolge ist auf 32 KB beschränkt ODER ein ReplyFormData-Objekt , das Text- oder Anlagendaten und eine Rückruffunktion enthält.

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.9

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popup-Formular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.

• Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyAllFormAsync eine Ausnahme aus.

• Wenn im Parameter Anlagen angegeben formData.attachments werden, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.

displayReplyAllFormAsync(formData, callback)

Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des ausgewählten Termins enthält.

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData

string | Office.ReplyFormData

Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen. Die Zeichenfolge ist auf 32 KB beschränkt ODER ein ReplyFormData-Objekt , das Text- oder Anlagendaten und eine Rückruffunktion enthält.

callback

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.9

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popup-Formular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.

• Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyAllFormAsync eine Ausnahme aus.

• Wenn im Parameter Anlagen angegeben formData.attachments werden, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.

displayReplyFormAsync(formData, options, callback)

Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData

string | Office.ReplyFormData

Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen. Die Zeichenfolge ist auf 32 KB beschränkt ODER ein ReplyFormData-Objekt , das Text- oder Anlagendaten und eine Rückruffunktion enthält.

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.9

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popup-Formular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.

• Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyFormAsync eine Ausnahme aus.

• Wenn im Parameter Anlagen angegeben formData.attachments werden, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.

displayReplyFormAsync(formData, callback)

Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

formData

string | Office.ReplyFormData

Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen. Die Zeichenfolge ist auf 32 KB beschränkt ODER ein ReplyFormData-Objekt , das Text- oder Anlagendaten und eine Rückruffunktion enthält.

callback

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.9

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• In Outlook im Web und dem neuen Outlook unter Windows wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popup-Formular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.

• Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyFormAsync eine Ausnahme aus.

• Wenn im Parameter Anlagen angegeben formData.attachments werden, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.

getAllInternetHeadersAsync(options, callback)

Ruft alle Internetheader für die Nachricht als Zeichenfolge ab.

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

getAllInternetHeadersAsync(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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter, , aufgerufen, asyncResultder ein Office.AsyncResult Objekt ist. Bei Erfolg werden die Internetheaderdaten in der asyncResult.value Eigenschaft als Zeichenfolge bereitgestellt. Die Formatierungsinformationen des zurückgegebenen Zeichenfolgenwerts finden Sie in RFC 2183 . 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: Nachricht lesen

getAllInternetHeadersAsync(callback)

Ruft alle Internetheader für die Nachricht als Zeichenfolge ab.

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

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

Parameter

callback

(asyncResult: Office.AsyncResult<string>) => 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. Bei Erfolg werden die Internetheaderdaten in der asyncResult.value Eigenschaft als Zeichenfolge bereitgestellt. Die Formatierungsinformationen des zurückgegebenen Zeichenfolgenwerts finden Sie in RFC 2183 . 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: Nachricht lesen

getAsFileAsync(options, callback)

Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.

getAsFileAsync(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 Rückrufparameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResultbei dem es sich um ein Office.AsyncResult Objekt handelt. Das Base64-codierte EML-Format der Nachricht wird in der asyncResult.value Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

getAsFileAsync(callback)

Ruft die aktuelle Nachricht im EML-Format ab, das in Base64 codiert ist.

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

Parameter

callback

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

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. Das Base64-codierte EML-Format der Nachricht wird in der asyncResult.value Eigenschaft zurückgegeben. Alle aufgetretenen Fehler werden in der asyncResult.error Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

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.

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: Nachricht lesen

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 item.attachments-Aufruf abrufen und diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

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

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: Nachricht lesen

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 item.attachments-Aufruf abrufen und diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

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

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: Nachricht lesen

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: Nachricht lesen

getRegExMatches()

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind.

getRegExMatches(): any;

Gibt zurück

any

Ein Objekt mit Arrays aus Zeichenfolgen, die den in der XML-Manifestdatei definierten regulären Ausdrücken entsprechen. Der Name jedes Arrays ist gleich dem entsprechenden Wert des RegExName-Attributs der übereinstimmenden ItemHasRegularExpressionMatch Regel oder des FilterName Attributs der übereinstimmenden ItemHasKnownEntity Regel. Bei einer ItemHasRegularExpressionMatch-Regel muss eine entsprechende Zeichenfolge in der Eigenschaft des Elements vorhanden sein, das von dieser Regel angegeben wird. Der einfache PropertyName-Typ definiert die unterstützten Eigenschaften.

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

• Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr kontextbezogenes Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Anleitungen zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

• Diese Methode wird mit dem Aktivierungsregelfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.

• Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Text des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks, z. B .* . um den gesamten Textkörper eines Elements zu erhalten, gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.

getRegExMatchesByName(name)

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer XML-Anwendungsmanifestdatei definiert ist.

getRegExMatchesByName(name: string): string[];

Parameter

name

string

Der Name des ItemHasRegularExpressionMatch-Regelelements, das den entsprechenden Filter definiert.

Gibt zurück

string[]

Ein Array, das die Zeichenfolgen enthält, die dem regulären Ausdruck entsprechen, der ItemHasRegularExpressionMatch im Regelelement in der Manifest-XML-Datei definiert ist, mit dem angegebenen RegExName Elementwert.

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

• Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr kontextbezogenes Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Anleitungen zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

• Diese Methode wird mit dem Aktivierungsregelfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.

• Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Text des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks, z. B .* . um den gesamten Textkörper eines Elements zu erhalten, gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.

getSelectedRegExMatches()

Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die mit den regulären Ausdrücken übereinstimmen, die in einer XML-Anwendungsmanifestdatei definiert sind. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins.

getSelectedRegExMatches(): any;

Gibt zurück

any

Ein Objekt mit Arrays aus Zeichenfolgen, die den in der XML-Manifestdatei definierten regulären Ausdrücken entsprechen. Der Name der einzelnen Arrays ist gleich dem entsprechenden Wert des RegExName-Attributs der entsprechenden ItemHasRegularExpressionMatch-Regel oder des FilterName-Attributs der entsprechenden ItemHasKnownEntity-Regel. Bei einer ItemHasRegularExpressionMatch-Regel muss eine entsprechende Zeichenfolge in der Eigenschaft des Elements vorhanden sein, das von dieser Regel angegeben wird. Der einfache PropertyName-Typ definiert die unterstützten Eigenschaften.

Hinweise

API-Satz: Postfach 1.6

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

• Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr kontextbezogenes Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Anleitungen zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

• Diese Methode wird mit dem Aktivierungsregelfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 nicht unterstützt wird.

• Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Text des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .*, um den gesamten Textkörper eines Elements zu erhalten, gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.

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: Nachricht lesen

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: Nachricht lesen

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: Nachricht lesen

Wichtig: Es werden nur die get und-Methoden getAll des CustomProperties-Objekts unterstützt.

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.