Office.MessageRead interface

Paket:

outlook

Der Nachrichtenlesemodus von Office.context.mailbox.item.

Wichtig:

• Dies ist ein internes Outlook-Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als einen Modus von Office.context.mailbox.itembehandeln. Weitere Informationen finden Sie unter Outlook-Elementobjektmodell.

• Beachten Sie beim Aufrufen Office.context.mailbox.item einer Nachricht, dass der Lesebereich im Outlook-Client aktiviert sein muss. Anleitungen zum Konfigurieren des Lesebereichs finden Sie unter Verwenden und Konfigurieren des Lesebereichs für die Vorschau von Nachrichten.

Übergeordnete Schnittstellen:

• ItemRead

• Meldung

Extends

Office.Message

Hinweise

Verwendet von

• Office.Mailbox: Element

Beispiele

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

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

Eigenschaften

attachments	Ruft die Anlagen des Elements als Array ab.
body	Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
categories	Ruft ein Objekt ab, das Methoden zum Verwalten der Kategorien des Elements bereitstellt.
cc	Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Objekttyp und die Zugriffsebene hängen vom Modus des aktuellen Elements 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 – Postfach 1.15 und früher): 500 Empfänger Windows (klassisch – Postfach 1.16 und höher): 1.000 Empfänger Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 1.000 Empfänger (erweiterte Ansicht) Neue Mac-Benutzeroberfläche: Keine Begrenzung
conversationId	Ruft einen Bezeichner für die E-Mail-Unterhaltung ab, in der eine bestimmte Nachricht enthalten ist. Sie können für diese Eigenschaft eine ganze Zahl abrufen, wenn Ihre Mail-App in Formularen zum Lesen oder Antworten in Formularen zum Verfassen aktiviert wird. Wenn der Benutzer den Betreff der Antwortnachricht ändert, ändert sich beim Versenden die Konversations-ID für die entsprechende Nachricht, und der Wert, den Sie vorher bezogen haben, trifft nicht länger zu. Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die conversationId-Eigenschaft einen Wert zurück.
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.
display	Ruft ein Objekt ab, um den im Textkörper oder Betreff einer Nachricht angezeigten Inhalt vorübergehend in den Lesemodus zu versetzen.
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 die Internetnachrichten-ID für eine E-Mail-Nachricht ab.
itemClass	Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.
itemId	Ruft den Exchange-Webdienst-Elementbezeichner (Exchange-Webdienste, EWS) des aktuellen Elements 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 Benachrichtigungen für ein Element 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. Hinweis: Besprechungsanfragen haben einen itemClass-Wert von IPM.Schedule.Meeting.Request. Hinweis: Wenn das recurrence Objekt NULL ist, bedeutet dies, dass es sich bei dem Objekt um einen einzelnen Termin oder eine Besprechungsanfrage eines einzelnen Termins und NICHT um Teil einer Serie handelt.
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, unter Windows (neu und klassisch) und auf dem Mac gibt die seriesId die Exchange-Webdienste (EWS)-ID des übergeordneten Elements (Serie) zurück, zu dem dieses Element gehört. In Outlook unter Android und iOS seriesId wird jedoch die REST-ID des übergeordneten Elements zurückgegeben. Hinweis: Der von der seriesId Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Bezeichner des Exchange-Webdienste-Elements. Die seriesId Eigenschaft ist nicht identisch mit den Outlook-IDs, die von der Outlook-REST-API verwendet werden. Bevor REST-API-Aufrufe mit diesem Wert durchgeführt werden, sollte er mit Office.context.mailbox.convertToRestIdkonvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs von einem Outlook-Add-In. Die seriesId Eigenschaft gibt für Elemente zurück null , die keine übergeordneten Elemente haben, wie einzelne Termine, Serienelemente oder Besprechungsanfragen, und gibt für alle anderen Elemente zurück undefined , die keine Besprechungsanfragen sind.
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 gesamten Betreff des Elements ab oder legt ihn fest – so, 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	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 – Postfach 1.15 und früher): 500 Empfänger Windows (klassisch – Postfach 1.16 und höher): 1.000 Empfänger Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger Webbrowser, Windows (neu): 20 Empfänger (reduzierte Ansicht), 1.000 Empfänger (erweiterte Ansicht) Neue Mac-Benutzeroberfläche: Keine Begrenzung

Methoden

addHandlerAsync(eventType, handler, options, callback)	Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.
addHandlerAsync(eventType, handler, callback)	Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.
displayReplyAllForm(formData)	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, 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.
displayReplyForm(formData)	Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator 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.
getEntities()	Ruft die Entitäten im Text des ausgewählten Elements ab. Warnung: 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.
getEntitiesByType(entityType)	Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind. Warnung: 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.
getFilteredEntitiesByName(name)	Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter erfüllen, der in einer Manifestdatei nur für Add-Ins definiert ist. Warnung: 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.
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 den regulären Ausdrücken entsprechen, die in einer Manifestdatei nur für Add-Ins definiert sind.
getRegExMatchesByName(name)	Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer Manifestdatei nur für Add-Ins definiert ist.
getSelectedEntities()	Ruft die Entitäten ab, die in einer hervorgehobenen Übereinstimmung gefunden werden, die ein Benutzer ausgewählt hat. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins. Warnung: 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.
getSelectedRegExMatches()	Gibt Zeichenfolgenwerte in einer hervorgehobenen Übereinstimmung zurück, die mit regulären Ausdrücken übereinstimmen, die in einer Manifestdatei nur für Add-Ins 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 (jetzt in der Vorschau). 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 für ein E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.
removeHandlerAsync(eventType, options, callback)	Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.
removeHandlerAsync(eventType, callback)	Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.

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.

Beispiele

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

const item = Office.context.mailbox.item;

if (item.attachments.length > 0) {
    for (let i = 0; i < item.attachments.length; i++) {
        const attachment = item.attachments[i];
        console.log(`${i+1}. Name: ${attachment.name}`);
        console.log(`ID: ${attachment.id}`);
        console.log(`Type: ${attachment.attachmentType}`);
        console.log(`Inline content: ${attachment.isInline}`);
        console.log(`Size: ${attachment.size}`);
    }
} else {
    console.log("This mail item doesn't contain any attachments.");
}

body

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

body: Body;

Eigenschaftswert

Office.Body

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

categories

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

categories: Categories;

Eigenschaftswert

Office.Categories

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

...

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

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

...

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

cc

Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Objekttyp und die Zugriffsebene hängen vom Modus des aktuellen Elements 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 – Postfach 1.15 und früher): 500 Empfänger

• Windows (klassisch – Postfach 1.16 und höher): 1.000 Empfänger

• Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger

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

• Neue Mac-Benutzeroberfläche: Keine Begrenzung

cc: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

const msgCc = Office.context.mailbox.item.cc;
console.log("Message copied to:");
for (let i = 0; i < msgCc.length; i++) {
  console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
}

conversationId

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

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

Sie erhalten in einem Formular zum Verfassen für diese Eigenschaft für ein neues Element null. Wenn der Benutzer einen Betreff festlegt und das Element speichert, gibt die conversationId-Eigenschaft einen Wert zurück.

conversationId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

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

Beispiele

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

console.log(`Creation date and time: ${Office.context.mailbox.item.dateTimeCreated}`);

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.

Beispiele

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

console.log(`Date and time item last modified: ${Office.context.mailbox.item.dateTimeModified}`);

display

Hinweis

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

Ruft ein Objekt ab, um den im Textkörper oder Betreff einer Nachricht angezeigten Inhalt vorübergehend in den Lesemodus zu versetzen.

display: Display;

Eigenschaftswert

Office.Display

Hinweise

API-Satz: Postfachvorschau

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = (document.getElementById("body-text-field") as HTMLInputElement).value;
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});

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

Beispiele

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

const time = Office.context.mailbox.item.end;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

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.

Beispiele

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

const msgFrom = Office.context.mailbox.item.from;
console.log("Message received from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");

internetMessageId

Ruft die Internetnachrichten-ID für eine E-Mail-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.

Beispiele

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

console.log(`Internet message ID: ${Office.context.mailbox.item.internetMessageId}`);

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.

Beispiele

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

console.log(`Item class: ${Office.context.mailbox.item.itemClass}`);

itemId

Ruft den Exchange-Webdienst-Elementbezeichner (Exchange-Webdienste, EWS) des aktuellen Elements 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.

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

Beispiele

// The following code checks for the presence of an item
// identifier. If the `itemId` property returns `null` or
// `undefined`, it saves the item to the store and gets the
// item identifier from the asynchronous result.
// **Important**: `saveAsync` was introduced with requirement set 1.3
// so you can't get the `itemId` in Compose mode in earlier sets.
let itemId = Office.context.mailbox.item.itemId;
if (itemId === null || itemId == undefined) {
    Office.context.mailbox.item.saveAsync(function(result) {
        itemId = result.value;
    });
}

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

Beispiele

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

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

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

Beispiele

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

console.log(`Appointment location: ${Office.context.mailbox.item.location}`);

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

Beispiele

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

console.log(`Normalized subject: ${Office.context.mailbox.item.normalizedSubject}`);

notificationMessages

Ruft die Benachrichtigungen für ein Element 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 Arten von Benachrichtigungen, die Sie implementieren können, finden Sie unter Erstellen von Benachrichtigungen für Ihr Outlook-Add-In.

Beispiele

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

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

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

...

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

...

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

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.

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

Hinweis: Wenn das recurrence Objekt NULL ist, bedeutet dies, dass es sich bei dem Objekt um einen einzelnen Termin oder eine Besprechungsanfrage eines einzelnen Termins und NICHT um Teil einer Serie handelt.

recurrence: Recurrence;

Eigenschaftswert

Office.Recurrence

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

if (recurrence === undefined) {
  console.log("This item is a message but not a meeting request.");
} else if (recurrence === null) {
  console.log("This is a single appointment.");
} else {
  console.log(JSON.stringify(recurrence));
}

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.

Beispiele

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

const msgSender = Office.context.mailbox.item.sender;
console.log("Sender: " + msgSender.displayName + " (" + msgSender.emailAddress + ")");

seriesId

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

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

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

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

seriesId: string;

Eigenschaftswert

string

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

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

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

Beispiele

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

const time = Office.context.mailbox.item.start;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);

subject

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

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

Die subject-Eigenschaft gibt 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

Beispiele

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

console.log(`Subject: ${Office.context.mailbox.item.subject}`);

to

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 – Postfach 1.15 und früher): 500 Empfänger

• Windows (klassisch – Postfach 1.16 und höher): 1.000 Empfänger

• Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger

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

• Neue Mac-Benutzeroberfläche: Keine Begrenzung

to: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

const msgTo = Office.context.mailbox.item.to;
const distributionLists = [];
const externalRecipients = [];
const internalRecipients = [];
const otherRecipients = [];
for (let i = 0; i < msgTo.length; i++) {
    switch (msgTo[i].recipientType) {
    case Office.MailboxEnums.RecipientType.DistributionList:
        distributionLists.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.ExternalUser:
        externalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.User:
        internalRecipients.push(msgTo[i]);
        break;
    case Office.MailboxEnums.RecipientType.Other:
        otherRecipients.push(msgTo[i]);
    }
}

if (distributionLists.length > 0) {
    console.log("Distribution Lists:");
    distributionLists.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (externalRecipients.length > 0) {
    console.log("External Recipients:");
    externalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (internalRecipients.length > 0) {
    console.log("Internal Recipients:");
    internalRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

if (otherRecipients.length > 0) {
    console.log("Other Recipients:");
    otherRecipients.forEach((recipient) => console.log(`${recipient.displayName}, ${recipient.emailAddress}`));
}

Details zur Methode

addHandlerAsync(eventType, handler, options, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.

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

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler

any

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

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: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig: Eine Liste der Ereignisse, die für ein E-Mail-Element unterstützt werden, finden Sie unter Outlook-Elementobjektmodell.

Beispiele

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

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

addHandlerAsync(eventType, handler, callback)

Fügt einen Ereignishandler für ein unterstütztes Ereignis hinzu. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.

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

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler aufrufen soll

handler

any

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

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: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig: Eine Liste der Ereignisse, die für ein E-Mail-Element unterstützt werden, finden Sie unter Outlook-Elementobjektmodell.

displayReplyAllForm(formData)

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.

displayReplyAllForm(formData: string | ReplyFormData): 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.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

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

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllForm("This is a reply ALL with <b>some bold text</b>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyAllForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply-all form with attachments.");
  }
});

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.

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyAllFormAsync("This is a reply ALL with <b>some bold text</b>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// The async version was introduced in requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyAllFormAsync(
  {
    htmlBody:
      "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
    attachments: [base64Attachment, fileAttachment, itemAttachment]
  },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${asyncResult.error.message}`);
      return;
    }

    console.log("Created a reply-all form with attachments.");
  }
);

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.

• Diese Methode wird in Outlook auf 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.

displayReplyForm(formData)

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

displayReplyForm(formData: string | ReplyFormData): 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.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

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

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyForm("This is a reply with <i>some text in italics</i>.");

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// Create the reply with attachments.
Office.context.mailbox.item.displayReplyForm({
  htmlBody:
    "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
  attachments: [base64Attachment, fileAttachment, itemAttachment],
  callback: (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${result.error.message}`);
      return;
    }

    console.log("Created a reply with attachments.");
  }
});

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.

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-reply-forms.yaml

Office.context.mailbox.item.displayReplyFormAsync("This is a reply with <i>some text in italics</i>.", function(
  asyncResult
) {
  console.log(JSON.stringify(asyncResult));
});

...

// Define attachments.
const base64Attachment = {
  base64file:
    "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAIAAABt+uBvAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAACxEAAAsRAX9kX5EAAAAZdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjAuMTM0A1t6AAAF3klEQVR4Xt2aMcolRRSFdQUuwSW4AAMzU8ENzAIMDA1NzHUBgqmZkbG4ADGVQRgGZBBElAERRPg9eC+PQ73qc6u66lZ3v48bzH+7uqr6VN/T1f3mjafT8Pr7b37+8G3En99+5akTcAqB/n7+48uP3vvp3TdvgT//+uE7P3woBwv07+s/Xn32jKXhwKF/Xr3wpgdxpEC/ffnp8/ffKkQpAg3QDDr6Ocs5RiCzm0ILEQca02qB7u2mPQ4xpnUCabtBWDWFdbfYmBYJ1HLZN6PBP3794uOiAcdKY0oXKLQbFE71jkBS33FrjClRoNBuXjx7J/QUNNCdZBtTikAtdtO1+JBA34Z5xjRfIG03I/YBTYVMScY0U6DQbsbXGdevF2C6Mc0RKLQbHEUbbz0MZNKPuYnGNCpQaDdY0iQTDR9zU4xpSCB9t+PQ719/7k3T0P49bkw7BQrtZnBajTS+uIwYU7dA4ZzynrhMWF/3sc+YOgQK7WaiNQpCh9bRu36tAmm7wT2MovOmaUAaPY3G6DKmWCBtNzaYN80EJjIuDUejMSmBUC/abnCrL3Di8IEwErhAvUGrCxRa4C+ffLDAicMVmhW42K2VLgUK67zlFXwcqL9GmltseUXlDirOvMXIbqKdHc/vieGTIJoE6rL93djNWwy9OHwqRCyQqM+J6LpeFj4bIhZoTWVdWCCLBbvkY93HwqdCdJg0AheQ/XRf9mivhk+C6BMIscawUdR5m0MRPjzRLZAFZMo2pnBHlhE+NhELJGa5YNO42Jh8VCIWCBnMEu8WRf4WC147sAxYjGLcjPDxiCaBDMxS+MKCF1cUdXbF+UhEh0CGqDjksz9CZ++2fRiiWyCgKw532QJjEhMYCR+A2COQoStuwcYyw5i8a2K/QIZ+Ei/YWM41Ju+UGBUI6Bses4eIqf6Nzkc+43N4j8QEgQxdcZApe2OJdRp/R/G+iGkCGbriFmws9TqF4b0QkwUC4SNmwcYSu419xuTnE/MFMrCSRT9FZG8s9xmTn0xkCQSKfu4Di5y9sew1Jj+NOFIgC1hG9q+y7b+s+QnE8QJZYJ0n/g+rKvoBYuFNibMIZJG9sYQx6Y8n3o44l0AILDKWOtW/xf/g8RbE6QSygGVkbyyrxuTHiJMKZLHgjbcY0bPEqQWySN1YFmN5lriAQBZJxlSM4lniMgIhMjaWxRCeJa4kkAWcdaIxFZ17lrieQBazNpZFt54lriqQBXZ9g8ZUdOhZ4toCIWxj6UP2U/TmWSJRoDU/9V1YIIDdcONr9L64dond2P19T8QjmDSDdUYhTJHpcR7z90Am/bVBx6NtFLcIv+pXAzfgo71qaFAmWx9linjYl9UWIJN4zD3454527ncD+DP7g5nBgyI8S5xCIIMHzbCbKjwowrPESQXyVD48aHXcWCDc7dm/Wxk8qKcymfZN2gJ+mfqDDODhPJUDLmTrAeotiFaBLJI2IwYP5KnZ2IaeByrC2xEVgdCFeCfIqzgexVNT0T9Ab30VqAgEwneCjIrj/j01CVFTFuKrQF0gQ/wCaQHJJ1Yc9+ypYcKawgXqrwJKIEPfmRMrjrv11BhTZh4LZGAdhDFNqTju0FN70TW1ZTdVWgUCoTFh1JGK46481U9YU70fITsEMrQxjVQc9+OpTnRNhXZTpVsgI5zKjorjHjzVjK6pkWXbKZCBm1kYU2/F8bmeakDXVJfdVBkSCGB+wpi6lo5P9FSEvpF77abKqECGNqbGiuNTPLWNrikc2mE3VeYIZOj1DCuOG3uqhq6pEbupMlMgA7PfMiY9e27pqTvEGozbTZX5AgFtTFsVx208ReiammI3VVIEMrQxYbWLS+KjnvofXVMT7aZKokCGKIqi4viQp3pOTyJdIAO3wJYx3SqOk/hT1FSS3VRZJBDQxlQUkaipPLupsk4gQxuTjmy7qbJaIEM4SzXW2E2VYwQyhDHdYqXdVDlSIKCNabHdVDlYIOPemA6xmyqnEMgwYzrQbio8Pf0HxndUxitiwgUAAAAASUVORK5CYII=",
  inLine: true,
  name: "script_lab.png",
  type: Office.MailboxEnums.AttachmentType.Base64
};
const fileAttachment = {
  inLine: true,
  name: "dog.jpg",
  type: Office.MailboxEnums.AttachmentType.File,
  url: "https://i.imgur.com/9S36xvA.jpg"
};
const itemAttachment = {
  itemId: Office.context.mailbox.item.itemId,
  name: "test_email.msg",
  type: Office.MailboxEnums.AttachmentType.Item
};

// The async version was introduced in requirement set 1.9.
// It provides a callback when the new appointment form has been created.
Office.context.mailbox.item.displayReplyFormAsync(
  {
    htmlBody:
      "This is a reply with an inline Base64-encoded attachment, an inline image, and an item attachment.<br><img src='cid:script_lab.png'><br><img src='cid:dog.jpg'>",
    attachments: [base64Attachment, fileAttachment, itemAttachment]
  },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.error(`Action failed with message ${asyncResult.error.message}`);
      return;
    }

    console.log("Created reply with attachments.");
  }
);

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.

• Diese Methode wird in Outlook auf 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.

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

Beispiele

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

Office.context.mailbox.item.getAllInternetHeadersAsync(function (asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Internet headers received successfully");
    if (asyncResult.value.match(/preferred-fruit:.*/gim)) {
      console.log("Sender's preferred fruit: " + asyncResult.value.match(/preferred-fruit:.*/gim)[0].slice(17));
    } else {
      console.log("Didn't receive header with sender's preferred fruit");
    }
    if (asyncResult.value.match(/preferred-vegetable:.*/gim)) {
      console.log(
        "Sender's preferred vegetable: " + asyncResult.value.match(/preferred-vegetable:.*/gim)[0].slice(21)
      );
    } else {
      console.log("Didn't receive header with sender's preferred vegetable");
    }
  } else {
    console.log("Error getting internet headers: " + JSON.stringify(asyncResult.error));
  }
});

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

Beispiele

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

Office.context.mailbox.item.getAsFileAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Error encountered during processing: ${asyncResult.error.message}`);
    return;
  }

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

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.

Beispiele

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

// Gets the attachments of the current message or appointment in read mode. The item.attachments call can only be used in read mode.
const item = Office.context.mailbox.item;
const attachments = item.attachments;
if (attachments.length <= 0) {
  console.log("Mail item has no attachments.");
  return;
}

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

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.

getEntities()

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft die Entitäten im Text des ausgewählten Elements ab.

Warnung: 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.

getEntities(): Entities;

Gibt zurück

Office.Entities

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

getEntitiesByType(entityType)

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind.

Warnung: 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.

getEntitiesByType(entityType: MailboxEnums.EntityType | string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parameter

entityType

Office.MailboxEnums.EntityType | string

Einer der EntityType Enumerationswerte.

Gibt zurück

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Wenn der übergebene entityType Wert kein gültiges Mitglied der EntityType Aufzählung ist, gibt nulldie Methode zurück. Wenn keine Entitäten des angegebenen Typs im Text des Elements vorhanden sind, gibt die Methode ein leeres Array zurück. Andernfalls hängt der Typ der Objekte im zurückgegebenen Array vom Typ der Entität ab, die im entityType-Parameter angefordert wurde.

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Eingeschränkt

Anwendbarer Outlook-Modus: Nachricht lesen

getFilteredEntitiesByName(name)

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter erfüllen, der in einer Manifestdatei nur für Add-Ins definiert ist.

Warnung: 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.

getFilteredEntitiesByName(name: string): Array<string | Contact | MeetingSuggestion | PhoneNumber | TaskSuggestion>;

Parameter

name

string

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

Gibt zurück

Array<string | Office.Contact | Office.MeetingSuggestion | Office.PhoneNumber | Office.TaskSuggestion>

Die Entitäten, die dem regulären Ausdruck entsprechen, der ItemHasKnownEntity im Regelelement in der Add-In-Manifestdatei mit dem angegebenen FilterName Elementwert definiert ist. Wenn kein Element im Manifest mit einem Elementwert vorhanden istItemHasKnownEntity, der dem name Parameter entspricht, gibt die Methode zurücknull.FilterName Wenn der name Parameter mit einem ItemHasKnownEntity Element im Manifest übereinstimmt, aber keine Entitäten im aktuellen Element vorhanden sind, die übereinstimmen, gibt die Methode ein leeres Array zurück.

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

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

Beispiele

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

getInitializationContextAsync(callback)

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine 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 den regulären Ausdrücken entsprechen, die in einer Manifestdatei nur für Add-Ins definiert sind.

getRegExMatches(): any;

Gibt zurück

any

Ein Objekt, das Zeichenfolgenarrays enthält, die den regulären Ausdrücken entsprechen, die in der Add-In-Manifestdatei definiert sind. Der Name jedes Arrays ist gleich dem entsprechenden Wert des RegExName-Attributs der übereinstimmenden ItemHasRegularExpressionMatch Regel. Für eine ItemHasRegularExpressionMatch Regel muss eine übereinstimmende Zeichenfolge in der Eigenschaft des Elements auftreten, das durch diese 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.

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatches());

getRegExMatchesByName(name)

Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer Manifestdatei nur für Add-Ins 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 Add-In-Manifestdatei mit dem angegebenen RegExName Elementwert definiert ist.

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.

• Diese Methode wird in Outlook auf 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.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

// This API only works when you click on the highlighted word "ScriptLab".
console.log(Office.context.mailbox.item.getRegExMatchesByName("sampleRegexName"));

getSelectedEntities()

Warnung

Diese API ist nun veraltet.

Use regular expression rules instead.

Ruft die Entitäten ab, die in einer hervorgehobenen Übereinstimmung gefunden werden, die ein Benutzer ausgewählt hat. Hervorgehobene Übereinstimmungen gelten für Kontext-Add-Ins.

Warnung: 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.

getSelectedEntities(): Entities;

Gibt zurück

Office.Entities

Hinweise

API-Satz: Postfach 1.6

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

getSelectedRegExMatches()

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

getSelectedRegExMatches(): any;

Gibt zurück

any

Ein Objekt, das Zeichenfolgenarrays enthält, die den regulären Ausdrücken entsprechen, die in der Add-In-Manifestdatei definiert sind. Der Name jedes Arrays ist gleich dem entsprechenden Wert des RegExName Attributs der Vergleichsregel ItemHasRegularExpressionMatch . Für eine ItemHasRegularExpressionMatch Regel muss eine übereinstimmende Zeichenfolge in der Eigenschaft des Elements auftreten, das durch diese 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.

• Diese Methode wird in Outlook unter iOS oder Android 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.

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

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/75-regex-matches/contextual.yaml

const matches = Office.context.mailbox.item.getSelectedRegExMatches();
if (matches) {
    console.log(matches);
} else {
    console.error("Open add-in by clicking on a highlighted regex match, for this API to return something useful.");
}

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

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

getSharedPropertiesAsync(callback)

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab (jetzt in der Vorschau).

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

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

Beispiele

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

Office.context.mailbox.item.getSharedPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error("The current folder or mailbox isn't shared.");
    return;
  }
  const sharedProperties = result.value;
  console.log(`Owner: ${sharedProperties.owner}`);
  console.log(`Permissions: ${sharedProperties.delegatePermissions}`);
  console.log(`Target mailbox: ${sharedProperties.targetMailbox}`);
});

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 für ein E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.

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

Parameter

callback

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

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

userContext

any

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Beispiele

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

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

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

removeHandlerAsync(eventType, options, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.

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

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: 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: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig: Eine Liste der Ereignisse, die für ein E-Mail-Element unterstützt werden, finden Sie unter Outlook-Elementobjektmodell.

removeHandlerAsync(eventType, callback)

Entfernt die Ereignishandler für einen unterstützten Ereignistyp. Ereignisse stehen nur in Aufgabenbereich-Add-Ins zur Verfügung.

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

Parameter

eventType

Office.EventType | string

Das Ereignis, das den Handler widerrufen soll.

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig: Eine Liste der Ereignisse, die für ein E-Mail-Element unterstützt werden, finden Sie unter Outlook-Elementobjektmodell.

Beispiele

Office.context.mailbox.item.removeHandlerAsync(Office.EventType.ItemChanged, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
        console.error("Failed to remove event handler: " + asyncResult.error.message);
        return;
    }

    console.log("Event handler removed successfully.");
});