Office.MessageCompose interface

Der Modus zum Verfassen von Nachrichten 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:

Extends

Hinweise

Verwendet von

Beispiele

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

const attachmentUrl = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment with ID: ${result.value}`);
  }
);

Eigenschaften

bcc

Ruft ein Objekt ab, das Methoden bereitstellt, um die Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht abzurufen oder zu aktualisieren.

Je nach Client/Plattform (d. h. Windows, Mac usw.) können Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

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

Die cc-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Cc-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (d. h. Windows, Mac usw.) können jedoch Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

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.

itemType

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

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

notificationMessages

Ruft die Benachrichtigungen für ein Element ab.

subject

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.

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 ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

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 Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der An-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (d. h. Windows, Mac usw.) können jedoch Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

Methoden

addFileAttachmentAsync(uri, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addFileAttachmentAsync(uri, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Erstellungsformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, asyncResultder beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Statusinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web oder dem neuen Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das Element, das Sie bearbeiten, anfügen. Dies wird jedoch nicht unterstützt und auch nicht empfohlen.

addItemAttachmentAsync(itemId, attachmentName, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Erstellungsformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, asyncResultder beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Statusinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web oder dem neuen Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das Element, das Sie bearbeiten, anfügen. Dies wird jedoch nicht unterstützt und auch nicht empfohlen.

close()

Schließt das aktuelle Element, das gerade verfasst wird.

Das Verhalten der close-Methode hängt vom aktuellen Status des verfassten Elements ab. Wenn das Element nicht gespeicherte Änderungen enthält, fordert der Client den Benutzer auf, die Aktion zu speichern, zu verwerfen oder zu schließen.

In Outlook unter Windows (klassisch) und auf dem Mac hat diese close Methode keine Auswirkungen auf eine Antwort im Lesebereich.

getSelectedDataAsync(coercionType, options, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl getroffen wird, sich der Cursor jedoch im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Um auf die ausgewählten Daten aus der Rückruffunktion zuzugreifen, rufen Sie asyncResult.value.dataauf. Um auf die Quelleigenschaft zuzugreifen, aus der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, was entweder body oder ist subject.

getSelectedDataAsync(coercionType, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl getroffen wird, sich der Cursor jedoch im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Um auf die ausgewählten Daten aus der Rückruffunktion zuzugreifen, rufen Sie asyncResult.value.dataauf. Um auf die Quelleigenschaft zuzugreifen, aus der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, was entweder body oder ist subject.

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.

removeAttachmentAsync(attachmentId, options, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

removeAttachmentAsync(attachmentId, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

saveAsync(options, callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

saveAsync(callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

setSelectedDataAsync(data, options, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Text des Elements ein oder, wenn Text im Editor ausgewählt ist, ersetzt sie den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Text des Elements ein oder, wenn Text im Editor ausgewählt ist, ersetzt sie den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

Details zur Eigenschaft

bcc

Ruft ein Objekt ab, das Methoden bereitstellt, um die Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht abzurufen oder zu aktualisieren.

Je nach Client/Plattform (d. h. Windows, Mac usw.) können Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

bcc: Recipients;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

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

Office.context.mailbox.item.bcc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgBcc = asyncResult.value;
    console.log("Message being blind-copied to:");
    for (let i = 0; i < msgBcc.length; i++) {
      console.log(msgBcc[i].displayName + " (" + msgBcc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailBcc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.bcc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Bcc field.");
  } else {
    console.error(asyncResult.error);
  }
});

body

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

body: Body;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

Die cc-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der Cc-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (d. h. Windows, Mac usw.) können jedoch Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

cc: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

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

Office.context.mailbox.item.cc.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgCc = asyncResult.value;
    console.log("Message being copied to:");
    for (let i = 0; i < msgCc.length; i++) {
      console.log(msgCc[i].displayName + " (" + msgCc[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailCc") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.cc.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting Cc field.");
  } else {
    console.error(asyncResult.error);
  }
});

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

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}`);

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

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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;
}

notificationMessages

Ruft die Benachrichtigungen für ein Element ab.

notificationMessages: NotificationMessages;

Eigenschaftswert

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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}.`);
});

subject

Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest.

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 ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

subject: Subject;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

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

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${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 Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der Empfänger in der An-Zeile der Nachricht bereitstellt. Je nach Client/Plattform (d. h. Windows, Mac usw.) können jedoch Beschränkungen hinsichtlich der Anzahl der Empfänger gelten, die Sie erhalten oder aktualisieren können. Weitere Informationen finden Sie im Objekt "Empfänger".

to: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

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

Office.context.mailbox.item.to.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgTo = asyncResult.value;
    console.log("Message being sent to:");
    for (let i = 0; i < msgTo.length; i++) {
      console.log(msgTo[i].displayName + " (" + msgTo[i].emailAddress + ")");
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = (document.getElementById("emailTo") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.to.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting To field.");
  } else {
    console.error(asyncResult.error);
  }
});

Details zur Methode

addFileAttachmentAsync(uri, attachmentName, options, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

uri

string

Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

options

Office.AsyncContextOptions & { isInline: boolean }

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. isInline : Wenn wahr, bedeutet dies, dass die Anlage inline als Bild im Nachrichtentext und nicht in der Anlagenliste angezeigt wird.

callback

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei erfolgreicher Ausführung wird der Anlagenbezeichner in der asyncResult.value Eigenschaft bereitgestellt. Der Bezeichner variiert je nach Outlook-Client. In Outlook im Web und dem neuen Outlook unter Windows wird die Exchange-Webdienste (EWS)-ID zurückgegeben. Wenn isInline diese Option auf truefestgelegt ist, wird eine temporäre Anlagen-ID mit dem Präfix addinId zunächst zurückgegeben, während die Anlage auf den Server hochgeladen wird. Nach Abschluss des Uploads wird der Anlage eine EWS-ID zugewiesen. Einzelheiten finden Sie in den Hinweisen im Abschnitt "Hinweise". In Outlook unter Windows (klassisch) und unter Mac wird der Index der Anlage für Inline- und Nicht-Inline-Anlagen zurückgegeben. Wenn das Hochladen der Anlage fehlschlägt, finden Sie eine Beschreibung des Fehlers in asyncResult.error.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1 für Outlook unter Windows (klassisch) und auf Mac, Postfach 1.8 für Outlook im Web und neues Outlook unter Windows

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

  • Bitmapbilder (BMP) werden nicht unterstützt, wenn sie als Inlineanlagen hinzugefügt werden.

  • In aktuellen Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise eine Authorization: Bearer Kopfzeile an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, verwenden Sie die API, die addFileAttachmentFromBase64 mit Anforderungssatz 1.8 eingeführt wurde.

  • Die URI der anzufügenden Datei muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, der das Bild hostet, sollte keinen Header zurückgeben, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibt Cache-Controlno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann die Zwischenspeicherung verhindern, dass Ihre Änderungen angezeigt werden. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .

  • Sie können dieselbe URI mit der removeAttachmentAsync Methode verwenden, um die Anlage in derselben Sitzung zu entfernen.

Fehler:

  • AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

  • FileTypeNotSupported : Die Anlage hat eine unzulässige Erweiterung.

  • NumberOfAttachmentsExceeded : Die Nachricht oder der Termin enthält zu viele Anlagen.

Beispiele

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

const attachmentUrl = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment with ID: ${result.value}`);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentAsync-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

uri

string

Der URI, der den Speicherort der an die Nachricht oder den Termin anzuhängenden Datei angibt. Die maximale Länge ist 2048 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

callback

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei erfolgreicher Ausführung wird der Anlagenbezeichner in der asyncResult.value Eigenschaft bereitgestellt. Der Bezeichner variiert je nach Outlook-Client. In Outlook im Web und dem neuen Outlook unter Windows wird die Exchange-Webdienste (EWS)-ID zurückgegeben. Wenn isInline diese Option auf truefestgelegt ist, wird eine temporäre Anlagen-ID mit dem Präfix addinId zunächst zurückgegeben, während die Anlage auf den Server hochgeladen wird. Nach Abschluss des Uploads wird der Anlage eine EWS-ID zugewiesen. Einzelheiten finden Sie in den Hinweisen im Abschnitt "Hinweise". In Outlook unter Windows (klassisch) und unter Mac wird der Index der Anlage für Inline- und Nicht-Inline-Anlagen zurückgegeben. Wenn das Hochladen der Anlage fehlschlägt, finden Sie eine Beschreibung des Fehlers in asyncResult.error.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1 für Outlook unter Windows (klassisch) und auf Mac, Postfach 1.8 für Outlook im Web und neues Outlook unter Windows

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

  • Bitmapbilder (BMP) werden nicht unterstützt, wenn sie als Inlineanlagen hinzugefügt werden.

  • In aktuellen Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise eine Authorization: Bearer Kopfzeile an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, verwenden Sie die API, die addFileAttachmentFromBase64 mit Anforderungssatz 1.8 eingeführt wurde.

  • Die URI der anzufügenden Datei muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, der das Bild hostet, sollte keinen Header zurückgeben, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibt Cache-Controlno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann die Zwischenspeicherung verhindern, dass Ihre Änderungen angezeigt werden. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .

  • Sie können dieselbe URI mit der removeAttachmentAsync Methode verwenden, um die Anlage in derselben Sitzung zu entfernen.

Fehler:

  • AttachmentSizeExceeded : Die Anlage ist größer als zulässig.

  • FileTypeNotSupported : Die Anlage hat eine unzulässige Erweiterung.

  • NumberOfAttachmentsExceeded : Die Nachricht oder der Termin enthält zu viele Anlagen.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Erstellungsformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, asyncResultder beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Statusinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web oder dem neuen Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das Element, das Sie bearbeiten, anfügen. Dies wird jedoch nicht unterstützt und auch nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

itemId

any

Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

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 vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Fehler:

  • NumberOfAttachmentsExceeded : Die Nachricht oder der Termin enthält zu viele Anlagen.

Beispiele

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.

Die addItemAttachmentAsync Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Erstellungsformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, asyncResultder beim Anfügen des Elements aufgetreten ist. Sie können den options-Parameter verwenden, um bei Bedarf Statusinformationen an die Rückruffunktion zu übergeben.

Anschließend können Sie den Bezeichner mit der removeAttachmentAsync-Methode in der gleichen Sitzung zum Entfernen der Anlage verwenden.

Wenn Ihr Office-Add-In in Outlook im Web oder dem neuen Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das Element, das Sie bearbeiten, anfügen. Dies wird jedoch nicht unterstützt und auch nicht empfohlen.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parameter

itemId

any

Der Exchange-Bezeichner des Objekts, das angehängt werden soll. Die maximale Länge beträgt 100 Zeichen.

attachmentName

string

Der Name der Anlage, der beim Hochladen der Anlage angezeigt wird. Die maximale Länge ist 255 Zeichen.

callback

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Bei Erfolg wird der Anlagenbezeichner in der asyncResult.value-Eigenschaft bereitgestellt. Wenn beim Hinzufügen der Anlage ein Fehler auftritt, enthält das asyncResult-Objekt ein Error-Objekt mit einer Beschreibung des Fehlers.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Fehler:

  • NumberOfAttachmentsExceeded : Die Nachricht oder der Termin enthält zu viele Anlagen.

close()

Schließt das aktuelle Element, das gerade verfasst wird.

Das Verhalten der close-Methode hängt vom aktuellen Status des verfassten Elements ab. Wenn das Element nicht gespeicherte Änderungen enthält, fordert der Client den Benutzer auf, die Aktion zu speichern, zu verwerfen oder zu schließen.

In Outlook unter Windows (klassisch) und auf dem Mac hat diese close Methode keine Auswirkungen auf eine Antwort im Lesebereich.

close(): void;

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Eingeschränkt

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Wenn es sich bei dem Element um einen Termin handelt und es zuvor mit saveAsyncgespeichert wurde, wird der Benutzer aufgefordert, Outlook im Web und das neue Outlook unter Windows zu speichern, auch wenn seit dem letzten Speichern des Elements keine Änderungen vorgenommen wurden.

Tipp: Verwenden Sie die closeAsync-Methode anstelle der Methode, wenn close Ihr Add-In Folgendes ausführen soll:

  • Verwerfen Sie automatisch eine Nachricht, die ohne Rückfrage beim Benutzer im Dialogfeld "Speichern" verfasst wurde.

  • Bestimmen, wann ein Benutzer das Dialogfeld zum Speichern von Elementen während einer Nachricht abbricht.

  • Schließen einer Antwort im Lesebereich oder eines vorhandenen Entwurfs.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

getSelectedDataAsync(coercionType, options, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl getroffen wird, sich der Cursor jedoch im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Um auf die ausgewählten Daten aus der Rückruffunktion zuzugreifen, rufen Sie asyncResult.value.dataauf. Um auf die Quelleigenschaft zuzugreifen, aus der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, was entweder body oder ist subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

coercionType

Office.CoercionType | string

Fordert ein Format für die Daten an. If Text, gibt die Methode den Nur-Text als Zeichenfolge zurück, wobei alle vorhandenen HTML-Tags entfernt werden. Wenn Html, gibt die Methode den ausgewählten Text zurück, unabhängig davon, ob es sich um Nur-Text oder HTML handelt.

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge mit einem Format, das durch bestimmt wird coercionType.

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

// Get selected data.
Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, { option1: "option1"}, getCallback);

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log(`Selected text in ${prop}: ${text}`);
}

getSelectedDataAsync(coercionType, callback)

Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück.

Wenn keine Auswahl getroffen wird, sich der Cursor jedoch im Text oder Betreff befindet, gibt die Methode eine leere Zeichenfolge für die ausgewählten Daten zurück. Wenn ein anderes Feld als der Textkörper oder Betreff ausgewählt ist, gibt die Methode den InvalidSelection-Fehler zurück.

Um auf die ausgewählten Daten aus der Rückruffunktion zuzugreifen, rufen Sie asyncResult.value.dataauf. Um auf die Quelleigenschaft zuzugreifen, aus der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, was entweder body oder ist subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parameter

coercionType

Office.CoercionType | string

Fordert ein Format für die Daten an. If Text, gibt die Methode den Nur-Text als Zeichenfolge zurück, wobei alle vorhandenen HTML-Tags entfernt werden. Wenn Html, gibt die Methode den ausgewählten Text zurück, unabhängig davon, ob es sich um Nur-Text oder HTML handelt.

callback

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

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

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge mit einem Format, das durch bestimmt wird coercionType.

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

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

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

removeAttachmentAsync(attachmentId, options, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

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

Parameter

attachmentId

string

Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge beträgt attachmentId 200 Zeichen in Outlook im Web und unter Windows (neu und klassisch).

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 vom Typ Office.AsyncResultaufgerufen. Wenn beim Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Die removeAttachmentAsync Methode entfernt keine Inline-Anlagen aus einem E-Mail-Element. Wenn Sie eine Inline-Anlage entfernen möchten, rufen Sie zuerst den Textkörper des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus seinem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

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

Office.context.mailbox.item.removeAttachmentAsync(
  (document.getElementById("attachmentId") as HTMLInputElement).value,
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }
    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. 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.

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

Parameter

attachmentId

string

Der Bezeichner der zu entfernenden Anlage. Die maximale Zeichenfolgenlänge beträgt attachmentId 200 Zeichen in Outlook im Web und unter Windows (neu und klassisch).

callback

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

Optional. Wenn die Methode abgeschlossen ist, wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Wenn beim Entfernen der Anlage ein Fehler auftritt, enthält die Eigenschaft asyncResult.error einen Fehlercode mit dem Grund für den Fehler.

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Die removeAttachmentAsync Methode entfernt keine Inline-Anlagen aus einem E-Mail-Element. Wenn Sie eine Inline-Anlage entfernen möchten, rufen Sie zuerst den Textkörper des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus seinem Inhalt. Verwenden Sie die Office.Body-APIs , um den Text eines Elements abzurufen und festzulegen.

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

saveAsync(options, callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

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

Parameter

options
Office.AsyncContextOptions

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

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

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

  • Beachten Sie, dass es beim Abrufen einer Element-ID für die Verwendung mit EWS oder der REST-API durch Ihr Add-In einige Zeit saveAsync dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird, wenn Outlook sich im Cache-Modus befindet. Bis das Element synchronisiert wird, wird bei Verwendung der Element-ID ein Fehler zurückgegeben.

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

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

saveAsync(callback)

Speichert die aktuelle Nachricht asynchron als Entwurf.

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

Parameter

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Mailbox 1.3

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

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

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

  • Beachten Sie, dass es beim Abrufen einer Element-ID für die Verwendung mit EWS oder der REST-API durch Ihr Add-In einige Zeit saveAsync dauern kann, bis das Element tatsächlich mit dem Server synchronisiert wird, wenn Outlook sich im Cache-Modus befindet. Bis das Element synchronisiert wird, wird bei Verwendung der Element-ID ein Fehler zurückgegeben.

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

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Text des Elements ein oder, wenn Text im Editor ausgewählt ist, ersetzt sie den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType : Bei Text wird die aktuelle Formatvorlage in Outlook im Web, unter Windows (neu und klassisch) und auf Mac angewendet. Wenn das Feld ein HTML-Editor ist, werden nur die Textdaten eingefügt, selbst wenn es sich bei den Daten um HTML-Daten handelt. Wenn die Daten HTML sind und das Feld HTML unterstützt (der Betreff nicht), wird die aktuelle Formatvorlage in Outlook im Web und im neuen Outlook unter Windows angewendet. Die Standardformatvorlage wird in Outlook unter Windows (klassisch) und auf Mac angewendet. Ist das Feld ein Textfeld, wird ein Fehler des Typs InvalidDataFormat zurückgegeben. Wenn coercionType nicht festgelegt wird, hängt das Ergebnis vom Feld ab: Wenn das Feld HTML ist, wird HTML verwendet. Wenn das Feld Text ist, wird Nur-Text verwendet.

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein.

Die setSelectedDataAsync Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Text des Elements ein oder, wenn Text im Editor ausgewählt ist, ersetzt sie den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

data

string

Die einzufügenden Daten. Daten dürfen 1.000.000 Zeichen nicht überschreiten. Werden mehr als 1.000.000 Zeichen übergeben, wird eine ArgumentOutOfRange-Ausnahme ausgelöst.

callback

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

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

Gibt zurück

void

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Fehler:

  • InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.