Freigeben über

Office.LoadedMessageRead interface

Paket:
outlook

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

Hinweise

[ API-Satz: Postfach 1.15 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

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

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

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 des Elements und sein Format ab.
categories

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

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

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 der zurückgegebenen Empfänger variiert je nach Outlook-Client.

  • Windows (klassisch): 500 Empfänger

  • Windows (klassisch – in der Vorschau 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 Termin beendet werden 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-Webdienst-Elementklasse der ausgewählten Nachricht ab.
itemId

Ruft den Exchange-Webdienst-Elementbezeichner 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 das Elementobjekt instance eine Nachricht oder ein Termin ist.
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 wurden (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. Verwenden Sie subject die -Eigenschaft, um den Betreff des Elements mit intakten Präfixen abzurufen.
notificationMessages

Ruft die Benachrichtigungsmeldungen des Elements ab.
recurrence

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

Die recurrence -Eigenschaft gibt ein Recurrence -Objekt für Terminserien oder Besprechungsanfragen zurück, wenn ein Element eine Reihe oder ein instance in einer Reihe ist. 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 Reihe ab, zu der ein instance gehört.

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

Ruft das Datum und die Uhrzeit ab, zu dem 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 gesamten Betreff des Elements ab, wie er vom E-Mail-Server gesendet wird.

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 Typ des Objekts 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 der zurückgegebenen Empfänger variiert je nach Outlook-Client.

  • Windows (klassisch): 500 Empfänger

  • Windows (klassisch – in der Vorschau 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 Internetheadern 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 Internetheadern für eine Nachricht in einem Outlook-Add-In.
getAsFileAsync(options, callback)

Ruft die aktuelle Nachricht im EML-Format ab, die in Base64 codiert ist.
getAsFileAsync(callback)

Ruft die aktuelle Nachricht im EML-Format ab, die 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 Nachricht mit Aktionen aktiviert wird.
getInitializationContextAsync(callback)

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

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer XML-Manifestdatei definiert sind.
getRegExMatchesByName(name)

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

Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die mit den in einer XML-Manifestdatei definierten regulären Ausdrücken übereinstimmen. 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 von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.
getSharedPropertiesAsync(callback)

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

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

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

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

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

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

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

Details zur Eigenschaft

attachments

Ruft die Anlagen des Elements als Array ab.

attachments: AttachmentDetails[];

Eigenschaftswert

Office.AttachmentDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 Freigeben hinzugefügt wurden, werden nicht zurückgegeben.

body

Ruft den Text des Elements und sein Format ab.

body: Body;

Eigenschaftswert

Office.Body

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

categories

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

categories: Categories;

Eigenschaftswert

Office.Categories

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

cc

Ruft Empfänger in der Cc-Zeile (Carbon Copy) 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 der zurückgegebenen Empfänger variiert je nach Outlook-Client.

  • Windows (klassisch): 500 Empfänger

  • Windows (klassisch – in der Vorschau 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: Lesen von Nachrichten

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

dateTimeCreated

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

dateTimeCreated: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 unterstützte JavaScript-APIs auf mobilen Geräten.

end

Ruft das Datum und die Uhrzeit ab, zu dem der Termin beendet werden 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: Lesen von Nachrichten

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

Wichtig:

  • Die from Eigenschaften und sender stellen dieselbe Person dar, es sei denn, die Nachricht wird von einem Delegaten mit den Berechtigungen Im Auftrag senden gesendet. In diesem Fall gibt die from -Eigenschaft die E-Mail-Adresse des Delegators und die sender -Eigenschaft die Adresse des Delegaten zurück. Informationen zur Postfachdelegierung finden Sie unter Verwalten von Berechtigungen für Empfänger in Exchange Online.

  • Die recipientType -Eigenschaft des EmailAddressDetails -Objekts 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: Lesen von Nachrichten

Wichtig: Im Ordner "Gesendete Elemente " ist für internetMessageId zuletzt gesendete Elemente möglicherweise noch nicht verfügbar. Erwägen Sie in diesem Fall die Verwendung von Exchange-Webdiensten , um diese Eigenschaft vom Server abzurufen.

itemClass

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

itemClass: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 Exchange-Webdienst-Elementbezeichner für das aktuelle Element ab.

itemId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 das Element im Speicher zu speichern, der den Elementbezeichner im asyncResult.value Parameter in der Rückruffunktion zurückgibt. 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 identisch mit dem Exchange-Webdienst-Elementbezeichner. Die itemId Eigenschaft ist nicht identisch mit der Outlook-Eintrags-ID oder der ID, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden.

itemType

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

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

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

normalizedSubject

Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt wurden (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. Verwenden Sie subject die -Eigenschaft, um den Betreff des Elements mit intakten Präfixen abzurufen.

normalizedSubject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

notificationMessages

Ruft die Benachrichtigungsmeldungen des Elements ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Office.NotificationMessages

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

recurrence

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

Die recurrence -Eigenschaft gibt ein Recurrence -Objekt für Terminserien oder Besprechungsanfragen zurück, wenn ein Element eine Reihe oder ein instance in einer Reihe ist. 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: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Besprechungsanfragen haben den itemClass-Wert IPM.Schedule.Meeting.Request.

  • Wenn das recurrence Objekt NULL ist, gibt dies an, dass das Objekt ein einzelner Termin oder eine Besprechungsanfrage eines einzelnen Termins und nicht Teil einer Reihe ist.

  • Nur die Eigenschaften und die getAsync -Methode des Recurrence-Objekts werden 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: Lesen von Nachrichten

Wichtig:

  • Die from Eigenschaften und sender stellen dieselbe Person dar, es sei denn, die Nachricht wird von einem Delegaten mit den Berechtigungen Im Auftrag senden gesendet. In diesem Fall gibt die from -Eigenschaft die E-Mail-Adresse des Delegators und die sender -Eigenschaft die Adresse des Delegaten zurück. Informationen zur Postfachdelegierung finden Sie unter Verwalten von Berechtigungen für Empfänger in Exchange Online.

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

seriesId

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

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

seriesId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.7 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs aus einem Outlook-Add-In.

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

start

Ruft das Datum und die Uhrzeit ab, zu dem 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: Lesen von Nachrichten

subject

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

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

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

to

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

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 der zurückgegebenen Empfänger variiert je nach Outlook-Client.

  • Windows (klassisch): 500 Empfänger

  • Windows (klassisch – in der Vorschau 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: Lesen von Nachrichten

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 oder ein ReplyFormData-Objekt beschränkt, das Text- oder Anlagendaten und eine Rückruffunktion enthält.

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

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

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

  • Wenn Anlagen im formData.attachments Parameter angegeben sind, 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 oder ein ReplyFormData-Objekt beschränkt, 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, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

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

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

  • Wenn Anlagen im formData.attachments Parameter angegeben sind, 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 oder ein ReplyFormData-Objekt beschränkt, das Text- oder Anlagendaten und eine Rückruffunktion enthält.

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

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

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

  • Wenn Anlagen im formData.attachments Parameter angegeben sind, 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 oder ein ReplyFormData-Objekt beschränkt, 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, asyncResult, der ein Office.AsyncResult -Objekt ist.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

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

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

  • Wenn Anlagen im formData.attachments Parameter angegeben sind, 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 Internetheadern 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: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der 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 unter 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: Lesen von Nachrichten

getAllInternetHeadersAsync(callback)

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

Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetheadern 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, asyncResult, der 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 unter 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: Lesen von Nachrichten

getAsFileAsync(options, callback)

Ruft die aktuelle Nachricht im EML-Format ab, die 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: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

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

Wenn die -Methode abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter aufgerufen, asyncResult, der ein Office.AsyncResult -Objekt ist. 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: Lesen von Nachrichten

getAsFileAsync(callback)

Ruft die aktuelle Nachricht im EML-Format ab, die 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, asyncResult, der ein Office.AsyncResult -Objekt ist. 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: Lesen von Nachrichten

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

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

  • In Outlook im Web und dem neuen Outlook unter Windows unterstützt keine Anlagen, 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 die Anlagen-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

Fehler:

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

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getAttachmentContentAsync(attachmentId, callback)

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, asyncResult, der ein Office.AsyncResult -Objekt ist. Wenn der Aufruf fehlschlägt, enthält die asyncResult.error Eigenschaft einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

  • In Outlook im Web und dem neuen Outlook unter Windows unterstützt keine Anlagen, 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 die Anlagen-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

Fehler:

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

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

getInitializationContextAsync(options, callback)

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

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

Parameter

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

getInitializationContextAsync(callback)

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

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

Parameter

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.8 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

getRegExMatches()

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer XML-Manifestdatei 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 Abgleichsregel ItemHasRegularExpressionMatch oder des FilterName Attributs der Abgleichsregel ItemHasKnownEntity . 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 Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

  • Diese Methode wird mit dem Aktivierungsregelnfeature 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 Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements 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-Manifestdatei 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 mit dem im Regelelement in der ItemHasRegularExpressionMatch XML-Manifestdatei definierten regulären Ausdruck mit dem angegebenen RegExName Elementwert übereinstimmen.

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 Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

  • Diese Methode wird mit dem Aktivierungsregelnfeature 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 Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements 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 in einer XML-Manifestdatei definierten regulären Ausdrücken übereinstimmen. 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: Lesen von Nachrichten

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 Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

  • Diese Methode wird mit dem Aktivierungsregelnfeature 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 Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements 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 von Szenarien für freigegebene Ordner und freigegebene Postfächer in einem Outlook-Add-In.

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

Parameter

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

getSharedPropertiesAsync(callback)

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

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

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

Parameter

callback

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

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

Gibt zurück

void

Hinweise

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

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

unloadAsync(options, callback)

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

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

Parameter

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.15 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

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

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

unloadAsync(callback)

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

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

Parameter

callback

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.15 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachrichten Compose

Wichtig:

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

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