Office.MessageRead interface

Referenz

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 Modus behandeln Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite Objektmodell .

Übergeordnete Schnittstellen:

Extends: Office.Message

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.
cc	Bietet Zugriff auf die Kopienempfänger (Cc) einer Nachricht. Der Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die `cc` -Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Cc-Zeile der Nachricht aufgeführt ist. Die maximale Anzahl der zurückgegebenen Empfänger variiert je nach Outlook-Client. Windows: 500 Empfänger Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger Webbrowser: 20 Empfänger Neue Mac-Benutzeroberfläche: Keine Beschränkung
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.
end	Ruft das Datum und die Uhrzeit ab, zu dem der Termin beendet werden soll. Die `end` -Eigenschaft ist ein `Date` Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die `convertToLocalClientTime` -Methode verwenden, um den `end` Eigenschaftswert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren. Wenn Sie die `Time.setAsync`-Methode verwenden, um die Endzeit im Verfassenmodus festzulegen, sollten Sie die `convertToUtcClientTime`-Methode verwenden, um die Ortszeit auf dem Client für den Server in UTC umzuwandeln.
from	Ruft die E-Mail-Adresse des Absenders einer Nachricht ab. Die `from`- und `sender`-Eigenschaften stellen dieselbe Person dar, außer die Nachricht wurde von einem Delegaten gesendet. In diesem Fall stellt die `from` -Eigenschaft den Delegator und die `sender` -Eigenschaft den Delegaten dar. Hinweis: Die `recipientType` -Eigenschaft des `EmailAddressDetails` -Objekts in der `from` -Eigenschaft ist nicht definiert. Die `from` -Eigenschaft gibt ein `EmailAddressDetails` -Objekt zurück.
internetMessageId	Ruft den Internetnachrichtenbezeichner für eine E-Mail-Nachricht ab. Wichtig: Im Ordner "Gesendete Elemente " ist für `internetMessageId` zuletzt gesendete Elemente möglicherweise noch nicht verfügbar. Erwägen Sie in diesem Fall die Verwendung von Exchange-Webdiensten , um diese Eigenschaft vom Server abzurufen.
itemClass	Ruft die Exchange-Webdienst-Elementklasse der ausgewählten Nachricht ab.
itemId	Ruft den Exchange-Webdienst-Elementbezeichner für das aktuelle Element ab. Die `itemId` -Eigenschaft ist im Erstellmodus nicht verfügbar. Wenn ein Elementbezeichner erforderlich ist, kann die `saveAsync` -Methode verwendet werden, um das Element im Speicher zu speichern, der den Elementbezeichner im `asyncResult.value` Parameter in der Rückruffunktion zurückgibt. Hinweis: Der von der `itemId` -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die `itemId`-Eigenschaft ist nicht identisch mit der Outlook-Eintrags-ID oder der ID, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit `Office.context.mailbox.convertToRestId`konvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs aus einem Outlook-Add-In.
itemType	Ruft den Typ des Elements ab, das eine Instanz darstellt. Die `itemType` Eigenschaft gibt einen der Enumerationswerte zurück, der `ItemType` angibt, ob das Elementobjekt instance eine Nachricht oder ein Termin ist.
location	Ruft den Speicherort einer Besprechungsanfrage ab. Die `location`-Eigenschaft gibt eine Zeichenfolge zurück, die den Ort des Termins enthält.
normalizedSubject	Ruft den Betreff eines Elements ab, wobei alle Präfixe entfernt wurden (einschließlich RE: und FWD:). Die `normalizedSubject` -Eigenschaft ruft den Betreff des Elements mit allen Standardpräfixen (z. B. RE: und FW:) ab, die von E-Mail-Programmen hinzugefügt werden. Verwenden Sie `subject` die -Eigenschaft, um den Betreff des Elements mit intakten Präfixen abzurufen.
notificationMessages	Ruft die Benachrichtigungen für ein Element ab.
sender	Ruft die E-Mail-Adresse des Absenders einer E-Mail-Nachricht ab. Die `from`- und `sender`-Eigenschaften stellen dieselbe Person dar, außer die Nachricht wurde von einem Delegaten gesendet. In diesem Fall stellt die `from` -Eigenschaft den Delegator und die `sender` -Eigenschaft den Delegaten dar. Hinweis: Die `recipientType` -Eigenschaft des `EmailAddressDetails` -Objekts in der `sender` -Eigenschaft ist nicht definiert.
start	Ruft das Datum und die Uhrzeit ab, zu dem der Termin beginnen soll. Die `start` -Eigenschaft ist ein `Date` Objekt, das als UTC-Datums- und Uhrzeitwert (Coordinated Universal Time) ausgedrückt wird. Sie können die `convertToLocalClientTime` -Methode verwenden, um den Wert in das lokale Datum und die lokale Uhrzeit des Clients zu konvertieren.
subject	Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird. Die `subject`-Eigenschaft ruft den gesamten Betreff des Elements ab 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 Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab. Die `to` -Eigenschaft gibt ein Array zurück, das ein EmailAddressDetails-Objekt für jeden Empfänger enthält, der in der Zeile An der Nachricht aufgeführt ist. Die maximale Anzahl der zurückgegebenen Empfänger variiert je nach Outlook-Client. Windows: 500 Empfänger Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger Webbrowser: 20 Empfänger Neue Mac-Benutzeroberfläche: Keine Beschränkung

Methoden

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.
displayReplyForm(formData)	Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
getEntities()	Ruft die Entitäten im Text des ausgewählten Elements ab.
getEntitiesByType(entityType)	Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind.
getFilteredEntitiesByName(name)	Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter übergeben, der in einer XML-Manifestdatei definiert ist.
getRegExMatches()	Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer XML-Manifestdatei definiert sind.
getRegExMatchesByName(name)	Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer XML-Manifestdatei definiert ist.
loadCustomPropertiesAsync(callback, userContext)	Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element. Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und Element gespeichert. Diese Methode gibt ein CustomProperties-Objekt im Rückruf zurück, das Methoden für den Zugriff auf die benutzerdefinierten Eigenschaften bereitstellt, die für das aktuelle Element und das aktuelle Add-In spezifisch sind. Benutzerdefinierte Eigenschaften werden für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte. Die benutzerdefinierten Eigenschaften werden als `CustomProperties`-Objekt in der `asyncResult.value`-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.

Details zur Eigenschaft

attachments

Ruft die Anlagen des Elements als Array ab.

attachments: AttachmentDetails[];

Eigenschaftswert

Office.AttachmentDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Hinweis: Bestimmte Dateitypen werden von Outlook aufgrund potenzieller Sicherheitsprobleme blockiert und werden daher nicht zurückgegeben. Weitere Informationen finden Sie unter Blockierte Anlagen in Outlook.

Beispiele

// The following code builds an HTML string with details of all attachments on the current item.
const item = Office.context.mailbox.item;
let outputString = "";

if (item.attachments.length > 0) {
    for (let i = 0 ; i < item.attachments.length ; i++) {
        const attachment = item.attachments[i];
        outputString += "<BR>" + i + ". Name: ";
        outputString += attachment.name;
        outputString += "<BR>ID: " + attachment.id;
        outputString += "<BR>contentType: " + attachment.contentType;
        outputString += "<BR>size: " + attachment.size;
        outputString += "<BR>attachmentType: " + attachment.attachmentType;
        outputString += "<BR>isInline: " + attachment.isInline;
    }
}

console.log(outputString);

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

const attachments = Office.context.mailbox.item.attachments;
console.log(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: Lesen von Nachrichten

Beispiele

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

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

cc

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

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

Windows: 500 Empfänger
Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger
Webbrowser: 20 Empfänger
Neue Mac-Benutzeroberfläche: Keine Beschränkung

cc: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

Beispiele

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

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

dateTimeCreated

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

dateTimeCreated: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

Beispiele

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

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

end

Ruft das Datum und die Uhrzeit ab, zu dem der Termin beendet werden soll.

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

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

end: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Beispiele

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

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

from

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

Die from- und sender-Eigenschaften stellen dieselbe Person dar, außer die Nachricht wurde von einem Delegaten gesendet. In diesem Fall stellt die from -Eigenschaft den Delegator und die sender -Eigenschaft den Delegaten dar.

Hinweis: Die recipientType -Eigenschaft des EmailAddressDetails -Objekts in der from -Eigenschaft ist nicht definiert.

Die from -Eigenschaft gibt ein EmailAddressDetails -Objekt zurück.

from: EmailAddressDetails;

Eigenschaftswert

Office.EmailAddressDetails

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 den Internetnachrichtenbezeichner für eine E-Mail-Nachricht ab.

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

internetMessageId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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-Webdienst-Elementklasse der ausgewählten Nachricht ab.

itemClass: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

In der folgenden Tabelle sind die Standardelementklassen für Nachrichten aufgeführt.

Elementklasse	Beschreibung
IPM.Note	Neue Nachrichten und Nachrichtenantworten
IPM.Schedule.Meeting.Request	Besprechungsanfragen
IPM.Schedule.Meeting.Canceled	Besprechungsabsagen
IPM.Schedule.Meeting.Resp.Neg	Antworten zur Ablehnung von Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Pos	Antworten zur Zusage zu Besprechungsanfragen
IPM.Schedule.Meeting.Resp.Tent	Antworten zur Zusagen von Besprechungsanfragen unter Vorbehalt

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

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

Die itemId -Eigenschaft ist im Erstellmodus nicht verfügbar. Wenn ein Elementbezeichner erforderlich ist, kann die saveAsync -Methode verwendet werden, um das Element im Speicher zu speichern, der den Elementbezeichner im asyncResult.value Parameter in der Rückruffunktion zurückgibt.

Hinweis: Der von der itemId -Eigenschaft zurückgegebene Bezeichner ist identisch mit dem Exchange-Webdienst-Elementbezeichner. Die itemId-Eigenschaft ist nicht identisch mit der Outlook-Eintrags-ID oder der ID, die von der Outlook-REST-API verwendet wird. Bevor Sie REST-API-Aufrufe mit diesem Wert ausführen, sollte sie mit Office.context.mailbox.convertToRestIdkonvertiert werden. Weitere Informationen finden Sie unter Verwenden der Outlook-REST-APIs aus einem Outlook-Add-In.

itemId: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 das Elementobjekt instance eine Nachricht oder ein Termin ist.

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

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 wurden (einschließlich RE: und FWD:).

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

normalizedSubject: string;

Eigenschaftswert

string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Beispiele

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

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

...

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

...

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

...

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

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

...

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

...

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

sender

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

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

sender: EmailAddressDetails;

Eigenschaftswert

Office.EmailAddressDetails

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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 + ")");

start

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

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

start: Date;

Eigenschaftswert

Date

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Beispiele

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

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

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

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 Typ des Objekts und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

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

Windows: 500 Empfänger
Android, klassische Mac-Benutzeroberfläche, iOS: 100 Empfänger
Webbrowser: 20 Empfänger
Neue Mac-Benutzeroberfläche: Keine Beschränkung

to: EmailAddressDetails[];

Eigenschaftswert

Office.EmailAddressDetails[]

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

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

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 oder ein ReplyFormData-Objekt beschränkt, 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 wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyForm eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// The following code passes a string to the `displayReplyAllForm` method.
Office.context.mailbox.item.displayReplyAllForm('hello there');
Office.context.mailbox.item.displayReplyAllForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyAllForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyAllForm(
{
'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : Office.MailboxEnums.AttachmentType.File,
        'name' : 'squirrel.png',
        'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
        'type' : 'item',
        'name' : 'rand',
        'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyAllForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// 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>.");

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

In Outlook im Web wird das Antwortformular als Popupformular in der 3-Spalten-Ansicht und als Popupformular in der 2-Spalten- oder 1-Spalten-Ansicht angezeigt.
Wenn einer der Zeichenfolgenparameter seinen Grenzwert überschreitet, löst displayReplyForm eine Ausnahme aus.
Wenn Anlagen im formData.attachments Parameter angegeben sind, versucht Outlook, alle Anlagen herunterzuladen und an das Antwortformular anzufügen. Wenn Anlagen nicht hinzugefügt werden können, wird in der Formularbenutzeroberfläche ein Fehler angezeigt. Wenn dies nicht möglich ist, wird keine Fehlermeldung ausgegeben.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// The following code passes a string to the `displayReplyForm` method.
Office.context.mailbox.item.displayReplyForm('hello there');
Office.context.mailbox.item.displayReplyForm('<b>hello there</b>');

// Reply with an empty body.
Office.context.mailbox.item.displayReplyForm({});

// Reply with just a body.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi'
});

// Reply with a body and a file attachment.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        }
    ]
});

// Reply with a body and an item attachment.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ]
});

// Reply with a body, file attachment, item attachment, and a callback.
Office.context.mailbox.item.displayReplyForm(
{
    'htmlBody' : 'hi',
    'attachments' :
    [
        {
            'type' : Office.MailboxEnums.AttachmentType.File,
            'name' : 'squirrel.png',
            'url' : 'http://i.imgur.com/sRgTlGR.jpg'
        },
        {
            'type' : 'item',
            'name' : 'rand',
            'itemId' : Office.context.mailbox.item.itemId
        }
    ],
    'callback' : function(asyncResult)
    {
        console.log(asyncResult.value);
    }
});

// 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>.");

...

Office.context.mailbox.item.displayReplyForm({
  htmlBody: "This is a reply with a couple of attachments - an inline image and an item<br><img src='cid:dog.jpg'>",
  attachments: [
    { type: "file", url: "http://i.imgur.com/9S36xvA.jpg", name: "dog.jpg", isInline: true },
    { type: "item", itemId: Office.context.mailbox.item.itemId, name: "test_email.msg" }
  ],
  options: { asyncContext: null },
  callback: function(result) {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Action failed with message ${result.error.message}`);
    }
  }
});

getEntities()

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

getEntities(): Entities;

Gibt zurück

Office.Entities

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins, einschließlich der getEntities -Methode, werden im 2. Quartal 2024 eingestellt. Die Arbeiten zur Außerbetriebnahme dieser Methode beginnen im Mai und werden bis Ende Juni fortgesetzt. Nach Juni können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-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 Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins. Weitere Informationen zur Deaktivierung entitätsbasierter kontextbezogener Outlook-Add-Ins finden Sie unter Außerbetriebnahme entitätsbasierter kontextbezogener Outlook-Add-Ins.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

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

const entities = Office.context.mailbox.item.getEntities();
let entityTypesFound = 0;
if (entities.addresses.length > 0) {
    console.warn("physical addresses: ");
    console.log(entities.addresses);
    entityTypesFound++;
}
if (entities.contacts.length > 0) {
    console.warn("contacts: ");
    entities.contacts.forEach(function (contact) { console.log(contact.personName); })
    entityTypesFound++;
}
if (entities.emailAddresses.length > 0) {
    console.warn("email addresses: ");
    console.log(entities.emailAddresses);
    entityTypesFound++;
}
if (entities.meetingSuggestions.length > 0) {
    console.warn("meetings suggestions: ");
    entities.meetingSuggestions.forEach(function (meetingSuggestion) { console.log(meetingSuggestion.meetingString); })
    entityTypesFound++;
}
if (entities.phoneNumbers.length > 0) {
    console.warn("phone numbers: ");
    entities.phoneNumbers.forEach(function (phoneNumber) { console.log(phoneNumber.originalPhoneString); })
    entityTypesFound++;
}
if (entities.taskSuggestions.length > 0) {
    console.warn("task suggestions: ");
    entities.taskSuggestions.forEach(function (taskSuggestion) { console.log(taskSuggestion.taskString); })
    entityTypesFound++;
}
if (entities.urls.length > 0) {
    console.warn("URLs: ");
    console.log(entities.urls);
    entityTypesFound++;
}
if (entityTypesFound == 0)
{
    console.log("No entities found on this item.");
}

getEntitiesByType(entityType)

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

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

Parameter

entityType: Office.MailboxEnums.EntityType | string

Einer der EntityType Enumerationswerte.

Während die Mindestberechtigungsstufe für die Verwendung dieser Methode eingeschränkt ist, erfordern einige Entitätstypen leseelementzugriff , wie in der folgenden Tabelle angegeben.

Wert von entityType	Typ der Objekte im zurückgegebenen Array	Erforderliche Berechtigungsebene
Adresse	String	Restricted
Kontakt	Kontakt	ReadItem
EmailAddress	String	ReadItem
MeetingSuggestion	MeetingSuggestion	ReadItem
PhoneNumber	PhoneNumber	Restricted
TaskSuggestion	TaskSuggestion	ReadItem
URL	String	Restricted

Gibt zurück

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

Wenn der übergebene entityType Wert kein gültiger Member der EntityType Enumeration ist, gibt die Methode zurück null. 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: Lesen von Nachrichten

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins, einschließlich der getEntitiesByType -Methode, werden im 2. Quartal 2024 eingestellt. Die Arbeiten zur Außerbetriebnahme dieser Methode beginnen im Mai und werden bis Ende Juni fortgesetzt. Nach Juni können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-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 Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins. Weitere Informationen zur Deaktivierung entitätsbasierter kontextbezogener Outlook-Add-Ins finden Sie unter Außerbetriebnahme entitätsbasierter kontextbezogener Outlook-Add-Ins.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

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

console.log(Office.context.mailbox.item.getEntitiesByType(Office.MailboxEnums.EntityType.Address));

getFilteredEntitiesByName(name)

Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter übergeben, der in einer XML-Manifestdatei definiert ist.

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 mit dem regulären Ausdruck übereinstimmen, der ItemHasKnownEntity im Regelelement in der XML-Manifestdatei mit dem angegebenen FilterName Elementwert definiert ist. Wenn im Manifest kein ItemHasKnownEntity Element mit einem FilterName Elementwert vorhanden ist, der dem name Parameter entspricht, gibt die Methode zurück null. 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

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins, einschließlich der getFilteredEntitiesByName -Methode, werden im 2. Quartal 2024 eingestellt. Die Arbeiten zur Außerbetriebnahme dieser Methode beginnen im Mai und werden bis Ende Juni fortgesetzt. Nach Juni können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-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 Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins. Weitere Informationen zur Deaktivierung entitätsbasierter kontextbezogener Outlook-Add-Ins finden Sie unter Außerbetriebnahme entitätsbasierter kontextbezogener Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 (Vorschau) nicht unterstützt wird.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

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

// This API would only work when you click on highlighted physical address that has the word "Way" in it.
console.log(Office.context.mailbox.item.getFilteredEntitiesByName("sampleFilterName"));

getRegExMatches()

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

getRegExMatches(): any;

Gibt zurück

any

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

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden im 2. Quartal 2024 eingestellt. Nach der Außerbetriebnahme können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-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 Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins. Weitere Informationen zum Außerbetriebnahme von entitätsbasierten Kontext-Add-Ins finden Sie unter Einstellung entitätsbasierter kontextbezogener Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 (Vorschau) nicht unterstützt wird.
Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

// The following example shows how to access the array of
// matches for the regular expression rule elements `fruits`
// and `veggies`, which are specified in the manifest.
const allMatches = Office.context.mailbox.item.getRegExMatches();
const fruits = allMatches.fruits;
const veggies = allMatches.veggies;

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

// This API would only work when you click on 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 XML-Manifestdatei definiert ist.

getRegExMatchesByName(name: string): string[];

Parameter

name: string

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

Gibt zurück

string[]

Ein Array, das die Zeichenfolgen enthält, die mit dem im Regelelement in der ItemHasRegularExpressionMatch XML-Manifestdatei definierten regulären Ausdruck mit dem angegebenen RegExName Elementwert übereinstimmen.

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminteilnehmer

Wichtig:

Entitätsbasierte kontextbezogene Outlook-Add-Ins werden im 2. Quartal 2024 eingestellt. Nach der Außerbetriebnahme können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-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 Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins. Weitere Informationen zum Außerbetriebnahme von entitätsbasierten Kontext-Add-Ins finden Sie unter Einstellung entitätsbasierter kontextbezogener Outlook-Add-Ins.
Diese Methode wird mit dem Aktivierungsregelnfeature für Outlook-Add-Ins verwendet, das vom einheitlichen Manifest für Microsoft 365 (Vorschau) nicht unterstützt wird.
Wenn Sie eine ItemHasRegularExpressionMatch Regel für die body-Eigenschaft eines Elements angeben, sollte der reguläre Ausdruck den Text weiter filtern und nicht versuchen, den gesamten Textkörper des Elements zurückzugeben. Die Verwendung eines regulären Ausdrucks wie .* zum Abrufen des gesamten Textkörpers eines Elements gibt nicht immer die erwarteten Ergebnisse zurück. Verwenden Sie stattdessen die Body.getAsync-Methode, um den gesamten Textkörper abzurufen.
Diese Methode wird in Outlook unter Android oder iOS nicht unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.

Beispiele

// Consider an add-in manifest has the following `Rule` element:
//<Rule xsi:type="RuleCollection" Mode="And">
//  <Rule xsi:type="ItemIs" FormType="Read" ItemType="Message" />
//  <Rule xsi:type="RuleCollection" Mode="Or">
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="fruits" RegExValue="apple|banana|coconut" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//    <Rule xsi:type="ItemHasRegularExpressionMatch" RegExName="veggies" RegExValue="tomato|onion|spinach|broccoli" PropertyName="BodyAsPlaintext" IgnoreCase="true" />
//  </Rule>
//</Rule>

// The object returned from `getRegExMatches` would have two properties: `fruits` and `veggies`.
//{
//'fruits': ['apple','banana','Banana','coconut'],
//'veggies': ['tomato','onion','spinach','broccoli']
//}

const fruits = Office.context.mailbox.item.getRegExMatchesByName("fruits");
const veggies = Office.context.mailbox.item.getRegExMatchesByName("veggies");

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

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

loadCustomPropertiesAsync(callback, userContext)

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

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

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

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

Parameter

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

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

userContext: any

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Beispiele

// The following example shows how to use the loadCustomPropertiesAsync method
// to asynchronously load custom properties that are specific to the current item.
// The example also shows how to use the saveAsync method to save these properties
// back to the server. After loading the custom properties, the example uses the
// get method to read the custom property myProp, the set method to write the
// custom property otherProp, and then finally calls the saveAsync method to save
// the custom properties.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, add-in-specific code can run.
        const mailbox = Office.context.mailbox;
        mailbox.item.loadCustomPropertiesAsync(customPropsCallback);
    });
};

function customPropsCallback(asyncResult) {
    const customProps = asyncResult.value;
    const myProp = customProps.get("myProp");

    customProps.set("otherProp", "value");
    customProps.saveAsync(saveCallback);
}

function saveCallback(asyncResult) {
}

// 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(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Loaded following custom properties:");
    customProps = result.value;
    const dataKey = Object.keys(customProps)[0];
    const data = customProps[dataKey];
    for (let propertyName in data)
    {
      let propertyValue = data[propertyName];
      console.log(`${propertyName}: ${propertyValue}`);
    }              
  }
  else {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
  }
});