Office.Body interface

Referenz

Paket:: outlook

Das body-Objekt stellt Methoden zum Hinzufügen und Aktualisieren des Inhalts der Nachricht oder des Termins bereit. Es wird in der body-Eigenschaft des ausgewählten Elements zurückgegeben.

Hinweise

[ API-Satz: Postfach 1.1 ]

Bekanntes Problem mit HTML-Tabellenrahmenfarben

Outlook für Windows: Wenn Sie verschiedene Zellrahmen in einer HTML-Tabelle im Compose Modus auf unterschiedliche Farben festlegen, spiegeln die Rahmen einer Zelle möglicherweise nicht die erwartete Farbe wider. Informationen zum bekannten Verhalten finden Sie unter OfficeDev/office-js Issue #1818.

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64-encoded image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64-encoded image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

Methoden

appendOnSendAsync(data, options, callback)	Fügt beim Senden des angegebenen Inhalts an das Ende des Elementtexts nach einer beliebigen Signatur an. Um zu verwenden `appendOnSendAsync`, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Weitere Informationen finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen. Weitere Informationen zu append-on-send und dessen Konfiguration finden Sie unter Implementieren von "append-on-send" in Ihrem Outlook-Add-In.
appendOnSendAsync(data, callback)	Fügt beim Senden des angegebenen Inhalts an das Ende des Elementtexts nach einer beliebigen Signatur an. Um zu verwenden `appendOnSendAsync`, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Weitere Informationen finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen. Weitere Informationen zu append-on-send und dessen Konfiguration finden Sie unter Implementieren von "append-on-send" in Ihrem Outlook-Add-In.
getAsync(coercionType, options, callback)	Gibt den aktuellen Text in einem bestimmten Format zurück. Diese Methode gibt den gesamten aktuellen Text in dem von `coercionType`angegebenen Format zurück.
getAsync(coercionType, callback)	Gibt den aktuellen Text in einem bestimmten Format zurück. Diese Methode gibt den gesamten aktuellen Text in dem von `coercionType`angegebenen Format zurück.
getTypeAsync(options, callback)	Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.
getTypeAsync(callback)	Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.
prependAsync(data, options, callback)	Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.
prependAsync(data, callback)	Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.
prependOnSendAsync(data, options, callback)	Stellt HTML- oder Nur-Text am Anfang einer Nachricht oder eines Termins vor, wenn das E-Mail-Element gesendet wird. Um zu verwenden `prependOnSendAsync`, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Eine Anleitung finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen.
prependOnSendAsync(data, callback)	Stellt HTML- oder Nur-Text am Anfang einer Nachricht oder eines Termins vor, wenn das E-Mail-Element gesendet wird. Um zu verwenden `prependOnSendAsync`, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Eine Anleitung finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen.
setAsync(data, options, callback)	Ersetzt den gesamten Textkörper mit dem angegebenen Text.
setAsync(data, callback)	Ersetzt den gesamten Textkörper mit dem angegebenen Text.
setSelectedDataAsync(data, options, callback)	Ersetzt die Auswahl im Textkörper mit dem angegebenen Text. Die `setSelectedDataAsync` -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nie im Textkörper des Elements befand oder der Textkörper des Elements den Fokus auf der Benutzeroberfläche verloren hat, wird die Zeichenfolge oben im Textkörperinhalt eingefügt. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.
setSelectedDataAsync(data, callback)	Ersetzt die Auswahl im Textkörper mit dem angegebenen Text. Die `setSelectedDataAsync` -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nie im Textkörper des Elements befand oder der Textkörper des Elements den Fokus auf der Benutzeroberfläche verloren hat, wird die Zeichenfolge oben im Textkörperinhalt eingefügt. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.
setSignatureAsync(data, options, callback)	Fügt dem Elementtext eine Signatur hinzu, wenn keine signatur vorhanden ist. Wenn bereits eine Signatur im Text vorhanden ist, ersetzt diese Signatur.
setSignatureAsync(data, callback)	Fügt dem Elementtext eine Signatur hinzu, wenn keine signatur vorhanden ist. Wenn bereits eine Signatur im Text vorhanden ist, ersetzt diese Signatur.

Details zur Methode

appendOnSendAsync(data, options, callback)

Fügt beim Senden des angegebenen Inhalts an das Ende des Elementtexts nach einer beliebigen Signatur an.

Um zu verwenden appendOnSendAsync, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Weitere Informationen finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen. Weitere Informationen zu append-on-send und dessen Konfiguration finden Sie unter Implementieren von "append-on-send" in Ihrem Outlook-Add-In.

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

Parameter

data: string

Die Zeichenfolge, die am Ende des Textkörpers hinzugefügt werden soll. Die Zeichenfolge ist auf 5.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Das gewünschte Format für die anzufügenden Daten. Der Zeichenfolge im data-Parameter wird in dieses Format konvertiert.

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. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Wenn der Benutzer Add-Ins ausführt, die das On-Send-Feature mit ItemSend im Manifest implementieren, wird append-on-send vor der On-Send-Funktion ausgeführt.
Wenn Ihr Add-In das On-Send-Feature implementiert und im Handler aufruftappendOnSendAsync, gibt der appendOnSendAsync Aufruf einen Fehler zurück, da dieses Szenario nicht unterstützt wird.ItemSend
Um Daten aus einem vorherigen appendOnSendAsync Aufruf zu löschen, können Sie sie erneut aufrufen, wobei der data Parameter auf nullfestgelegt ist.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS appendOnSendAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 5.000 Zeichen.
InvalidFormatError : Der options.coercionType -Parameter ist auf Office.CoercionType.Html festgelegt, aber der Nachrichtentext ist nur-Text.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/append-text-on-send.yaml

// This snippet appends text to the end of the message or appointment's body once it's sent.
const text = $("#text-field").val();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the appendOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.appendOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be appended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

appendOnSendAsync(data, callback)

Fügt beim Senden des angegebenen Inhalts an das Ende des Elementtexts nach einer beliebigen Signatur an.

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

Parameter

data: string

Die Zeichenfolge, die am Ende des Textkörpers hinzugefügt werden soll. Die Zeichenfolge ist auf 5.000 Zeichen beschränkt.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.9 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Wenn der Benutzer Add-Ins ausführt, die das On-Send-Feature mit ItemSend im Manifest implementieren, wird append-on-send vor der On-Send-Funktion ausgeführt.
Wenn Ihr Add-In das On-Send-Feature implementiert und im Handler aufruftappendOnSendAsync, gibt der appendOnSendAsync Aufruf einen Fehler zurück, da dieses Szenario nicht unterstützt wird.ItemSend
Um Daten aus einem vorherigen appendOnSendAsync Aufruf zu löschen, können Sie sie erneut aufrufen, wobei der data Parameter auf nullfestgelegt ist.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS appendOnSendAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 5.000 Zeichen.
InvalidFormatError : Der options.coercionType -Parameter ist auf Office.CoercionType.Html festgelegt, aber der Nachrichtentext ist nur-Text.

getAsync(coercionType, options, callback)

Gibt den aktuellen Text in einem bestimmten Format zurück.

Diese Methode gibt den gesamten aktuellen Text in dem von coercionTypeangegebenen Format zurück.

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

Parameter

coercionType: Office.CoercionType | string

Das Format für den zurückgegebenen Text.

options: Office.AsyncContextOptions

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

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

Optional. Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Der Text wird im angeforderten Format in der asyncResult.value -Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der von der Body.getAsync -Methode zurückgegebene Wert nicht unbedingt genau derselbe Wert ist, der zuvor in der Body.setAsync -Methode übergeben wurde. Der Client kann den an übergebenen setAsync Wert ändern, damit er mit seiner Rendering-Engine effizient gerendert wird.
Wenn der Textkörper in Outlook im Web und neuen Outlook unter Windows formatierte Elemente wie Tabellen, Listen und Links enthält, geben Sie im Aufruf an Office.CoercionType.HtmlgetAsync. Andernfalls erhalten Sie möglicherweise einen unerwarteten Wert, z. B. eine leere Zeichenfolge.

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

getAsync(coercionType, callback)

Gibt den aktuellen Text in einem bestimmten Format zurück.

Diese Methode gibt den gesamten aktuellen Text in dem von coercionTypeangegebenen Format zurück.

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

Parameter

coercionType: Office.CoercionType | string

Das Format für den zurückgegebenen Text.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der von der Body.getAsync -Methode zurückgegebene Wert nicht unbedingt genau derselbe Wert ist, der zuvor in der Body.setAsync -Methode übergeben wurde. Der Client kann den an übergebenen setAsync Wert ändern, damit er mit seiner Rendering-Engine effizient gerendert wird.
Wenn der Textkörper in Outlook im Web und neuen Outlook unter Windows formatierte Elemente wie Tabellen, Listen und Links enthält, geben Sie im Aufruf an Office.CoercionType.HtmlgetAsync. Andernfalls erhalten Sie möglicherweise einen unerwarteten Wert, z. B. eine leere Zeichenfolge.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64-encoded image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64-encoded image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

getTypeAsync(options, callback)

Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.

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

Parameter

options: Office.AsyncContextOptions

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

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Der Inhaltstyp wird als einer der CoercionType Werte in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

Wichtig: In Outlook für Android und unter iOS wird diese Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird 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/20-item-body/get-body-format.yaml

// Get the mail item's body format (plain text or HTML) and log it to the console.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Body format: " + asyncResult.value);
});

getTypeAsync(callback)

Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.

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

Parameter

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

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Der Inhaltstyp wird als einer der CoercionType Werte in der asyncResult.value -Eigenschaft zurückgegeben.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose

prependAsync(data, options, callback)

Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.

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

Parameter

data: string

Die Zeichenfolge, die am Anfang des Texts eingefügt werden soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Das gewünschte Format für den Textkörper. Der Zeichenfolge im data-Parameter wird in dieses Format konvertiert.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Nachdem der Inhalt vorangestellt wurde, hängt die Position des Cursors davon ab, auf welchem Client das Add-In ausgeführt wird. In Outlook im Web und unter Windows (neu und klassisch) bleibt die Cursorposition im bereits vorhandenen Inhalt des Texts unverändert. Wenn der Cursor beispielsweise vor prependAsync dem Aufruf am Anfang des Textkörpers positioniert wurde, wird er nach dem Aufruf zwischen dem vorangestellten Inhalt und dem bereits vorhandenen Inhalt des Textkörpers angezeigt. In Outlook für Mac wird die Cursorposition nicht beibehalten. Der Cursor verschwindet nach dem prependAsync Aufruf und wird nur wieder angezeigt, wenn der Benutzer etwas im Textkörper des E-Mail-Elements auswählt.
Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der Client den an übergebenen Wert ändern kann, damit er mit seiner Rendering-Engine effizient gerendert prependAsync wird. Dies bedeutet, dass der Wert, der von einem nachfolgenden Aufruf der Body.getAsync -Methode zurückgegeben wird (eingeführt in Mailbox 1.3), nicht unbedingt den genauen Wert enthält, der im vorherigen prependAsync Aufruf übergeben wurde.
Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
In Outlook für Android und unter iOS wird diese Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS prependAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der Data-Parameter ist länger als 1.000.000 Zeichen.

Beispiele

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

/* This snippet adds text to the beginning of the message or appointment's body. 
  
  When prepending a link in HTML markup to the body, you can disable the online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val().toString();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" prepended to the body.`);
  });
});

prependAsync(data, callback)

Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.

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

Parameter

data: string

Die Zeichenfolge, die am Anfang des Texts eingefügt werden soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Nachdem der Inhalt vorangestellt wurde, hängt die Position des Cursors davon ab, auf welchem Client das Add-In ausgeführt wird. In Outlook im Web und unter Windows (neu und klassisch) bleibt die Cursorposition im bereits vorhandenen Inhalt des Texts unverändert. Wenn der Cursor beispielsweise vor prependAsync dem Aufruf am Anfang des Textkörpers positioniert wurde, wird er nach dem Aufruf zwischen dem vorangestellten Inhalt und dem bereits vorhandenen Inhalt des Textkörpers angezeigt. In Outlook für Mac wird die Cursorposition nicht beibehalten. Der Cursor verschwindet nach dem prependAsync Aufruf und wird nur wieder angezeigt, wenn der Benutzer etwas im Textkörper des E-Mail-Elements auswählt.
Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der Client den an übergebenen Wert ändern kann, damit er mit seiner Rendering-Engine effizient gerendert prependAsync wird. Dies bedeutet, dass der Wert, der von einem nachfolgenden Aufruf der Body.getAsync -Methode zurückgegeben wird (eingeführt in Mailbox 1.3), nicht unbedingt den genauen Wert enthält, der im vorherigen prependAsync Aufruf übergeben wurde.
Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
In Outlook für Android und unter iOS wird diese Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS prependAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der Data-Parameter ist länger als 1.000.000 Zeichen.

prependOnSendAsync(data, options, callback)

Stellt HTML- oder Nur-Text am Anfang einer Nachricht oder eines Termins vor, wenn das E-Mail-Element gesendet wird.

Um zu verwenden prependOnSendAsync, müssen Sie eine zusätzliche Berechtigung im Manifest angeben. Details variieren je nach Art des Manifests. Eine Anleitung finden Sie unter Grundlegendes zu Outlook-Add-In-Berechtigungen.

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

Parameter

data: string

Die Zeichenfolge, die dem Anfang des Nachrichten- oder Termintexts vorangestellt werden soll. Die Zeichenfolge ist auf 5.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält:- asyncContext: Jedes Objekt, auf das in der Rückruffunktion zugegriffen werden kann. coercionType : Das gewünschte Format für den Textkörper. Die Zeichenfolge im data Parameter wird in dieses Format konvertiert.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig: Beachten Sie bei der Implementierung prependOnSendAsyncvon Folgendes.

In einem Smart Alerts-Add-In wird zuerst das Prepend-On-Send-Feature ausgeführt.
Nach dem vorangestellten Inhalt wird eine neue Zeile hinzugefügt.
Wenn mehrere aktive Add-Ins aufrufen prependOnSendAsync, hängt die Reihenfolge des eingefügten Inhalts von der Reihenfolge ab, in der das Add-In ausgeführt wird. Der Inhalt des Add-Ins der letzten Ausführung wird oberhalb des zuvor vorangestellten Inhalts angezeigt.
Wenn das Add-In versucht, HTML in einen Nur-Text-Text einzufügen, wird der Inhalt nicht vorangestellt. Umgekehrt wird Nur-Text in einen HTML-Text eingefügt.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS prependOnSendAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter überschreitet 5.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Htmlfestgelegt, aber der Elementtext weist das Nur-Text-Format auf.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/prepend-text-on-send.yaml

// This snippet prepends text to the beginning of the message or appointment's body once it's sent.
const text = $("#text-field").val().toString();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependOnSendAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.prependOnSendAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`"${text}" will be prepended to the body once the message or appointment is sent. Send the mail item to test this feature.`);
  });
});

prependOnSendAsync(data, callback)

Stellt HTML- oder Nur-Text am Anfang einer Nachricht oder eines Termins vor, wenn das E-Mail-Element gesendet wird.

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

Parameter

data: string

Die Zeichenfolge, die dem Anfang des Nachrichten- oder Termintexts vorangestellt werden soll. Die Zeichenfolge ist auf 5.000 Zeichen beschränkt.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.13 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig: Beachten Sie bei der Implementierung prependOnSendAsyncvon Folgendes.

In einem Smart Alerts-Add-In wird zuerst das Prepend-On-Send-Feature ausgeführt.
Nach dem vorangestellten Inhalt wird eine neue Zeile hinzugefügt.
Wenn mehrere aktive Add-Ins aufrufen prependOnSendAsync, hängt die Reihenfolge des eingefügten Inhalts von der Reihenfolge ab, in der das Add-In ausgeführt wird. Der Inhalt des Add-Ins der letzten Ausführung wird oberhalb des zuvor vorangestellten Inhalts angezeigt.
Wenn das Add-In versucht, HTML in einen Nur-Text-Text einzufügen, wird der Inhalt nicht vorangestellt. Umgekehrt wird Nur-Text in einen HTML-Text eingefügt.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS prependOnSendAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter überschreitet 5.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Htmlfestgelegt, aber der Elementtext weist das Nur-Text-Format auf.

setAsync(data, options, callback)

Ersetzt den gesamten Textkörper mit dem angegebenen Text.

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

Parameter

data: string

Die Zeichenfolge, die den vorhandenen Text ersetzen soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Das gewünschte Format für den Textkörper. Der Zeichenfolge im data-Parameter wird in dieses Format konvertiert.

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

Optional. Nach Abschluss der Methode wird die im callback Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResult aufgerufen. Alle aufgetretenen Fehler werden in der asyncResult.error-Eigenschaft bereitgestellt.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Nachdem der Textkörper durch den angegebenen Inhalt ersetzt wurde, hängt die Position des Cursors davon ab, welcher Client das Add-In ausführt. Im klassischen Outlook unter Windows wird der Cursor am Anfang des Textkörpers des E-Mail-Elements angezeigt. In Outlook im Web und dem neuen Outlook unter Windows wird der Cursor am Ende des Textkörpers des E-Mail-Elements angezeigt. In Outlook für Mac wird die Cursorposition nicht beibehalten. Der Cursor verschwindet nach dem prependAsync Aufruf und wird nur wieder angezeigt, wenn der Benutzer etwas im Textkörper des E-Mail-Elements auswählt.
Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der von der Body.getAsync -Methode zurückgegebene Wert nicht unbedingt genau derselbe Wert ist, der zuvor in der Body.setAsync -Methode übergeben wurde. Der Client kann den an übergebenen setAsync Wert ändern, damit er mit seiner Rendering-Engine effizient gerendert wird.
Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
In Outlook unter Windows und auf Mac kann der Add-In-Benutzer diese Aktion nicht mit dem Befehl Rückgängig rückgängig machen.
In Outlook für Android und unter iOS wird diese Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der Data-Parameter ist länger als 1.000.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

Beispiele

// When including links in HTML markup, you can disable online link preview
// by setting the id attribute on the anchor (<a>) to "LPNoLP".
Office.context.mailbox.item.body.setAsync(
    '<a id="LPNoLP" href="http://www.contoso.com">Click here!</a>',
    { 
        coercionType: Office.CoercionType.Html,
        asyncContext: "This is passed to the callback"
    },
    (result) => {
        // Process the result.
    }
);

// The following is an example of the result parameter passed to the callback function.
{
    "value": null,
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/add-inline-base64-image.yaml

const mailItem = Office.context.mailbox.item;
const base64String =
  "iVBORw0KGgoAAAANSUhEUgAAAGAAAABgCAMAAADVRocKAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAnUExURQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN0S+bUAAAAMdFJOUwAQIDBAUI+fr7/P7yEupu8AAAAJcEhZcwAADsMAAA7DAcdvqGQAAAF8SURBVGhD7dfLdoMwDEVR6Cspzf9/b20QYOthS5Zn0Z2kVdY6O2WULrFYLBaLxd5ur4mDZD14b8ogWS/dtxV+dmx9ysA2QUj9TQRWv5D7HyKwuIW9n0vc8tkpHP0W4BOg3wQ8wtlvA+PC1e8Ao8Ld7wFjQtHvAiNC2e8DdqHqKwCrUPc1gE1AfRVgEXBfB+gF0lcCWoH2tYBOYPpqQCNwfT3QF9i+AegJfN8CtAWhbwJagtS3AbIg9o2AJMh9M5C+SVGBvx6zAfmT0r+Bv8JMwP4kyFPir+cswF5KL3WLv14zAFBCLf56Tw9cparFX4upgaJUtPhrOS1QlY5W+vWTXrGgBFB/b72ev3/0igUdQPppP/nfowfKUUEFcP207y/yxKmgAYQ+PywoAFOfCH3A2MdCFzD3kdADBvq10AGG+pXQBgb7pdAEhvuF0AIc/VtoAK7+JciAs38KIuDugyAC/v4hiMCE/i7IwLRBsh68N2WQjMVisVgs9i5bln8LGScNcCrONQAAAABJRU5ErkJggg==";

// Get the current body of the message or appointment.
mailItem.body.getAsync(Office.CoercionType.Html, (bodyResult) => {
  if (bodyResult.status === Office.AsyncResultStatus.Succeeded) {
    // Insert the Base64-encoded image to the beginning of the body.
    const options = { isInline: true, asyncContext: bodyResult.value };
    mailItem.addFileAttachmentFromBase64Async(base64String, "sample.png", options, (attachResult) => {
      if (attachResult.status === Office.AsyncResultStatus.Succeeded) {
        let body = attachResult.asyncContext;
        body = body.replace("<p class=MsoNormal>", `<p class=MsoNormal><img src="cid:sample.png">`);

        mailItem.body.setAsync(body, { coercionType: Office.CoercionType.Html }, (setResult) => {
          if (setResult.status === Office.AsyncResultStatus.Succeeded) {
            console.log("Inline Base64-encoded image added to the body.");
          } else {
            console.log(setResult.error.message);
          }
        });
      } else {
        console.log(attachResult.error.message);
      }
    });
  } else {
    console.log(bodyResult.error.message);
  }
});

setAsync(data, callback)

Ersetzt den gesamten Textkörper mit dem angegebenen Text.

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

Parameter

data: string

Die Zeichenfolge, die den vorhandenen Text ersetzen soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie auf getTypeAsync, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

Wichtig:

Nachdem der Textkörper durch den angegebenen Inhalt ersetzt wurde, hängt die Position des Cursors davon ab, welcher Client das Add-In ausführt. Im klassischen Outlook unter Windows wird der Cursor am Anfang des Textkörpers des E-Mail-Elements angezeigt. In Outlook im Web und dem neuen Outlook unter Windows wird der Cursor am Ende des Textkörpers des E-Mail-Elements angezeigt. In Outlook für Mac wird die Cursorposition nicht beibehalten. Der Cursor verschwindet nach dem prependAsync Aufruf und wird nur wieder angezeigt, wenn der Benutzer etwas im Textkörper des E-Mail-Elements auswählt.
Bei der Arbeit mit Textkörpern im HTML-Format ist es wichtig zu beachten, dass der von der Body.getAsync -Methode zurückgegebene Wert nicht unbedingt genau derselbe Wert ist, der zuvor in der Body.setAsync -Methode übergeben wurde. Der Client kann den an übergebenen setAsync Wert ändern, damit er mit seiner Rendering-Engine effizient gerendert wird.
Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
In Outlook unter Windows und auf Mac kann der Add-In-Benutzer diese Aktion nicht mit dem Befehl Rückgängig rückgängig machen.
In Outlook für Android und unter iOS wird diese Methode im Nachrichtenmodus Compose nicht unterstützt. Nur der Modus "Terminorganisation" wird unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook unterstützte JavaScript-APIs auf mobilen Geräten.
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der Data-Parameter ist länger als 1.000.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

setSelectedDataAsync(data, options, callback)

Ersetzt die Auswahl im Textkörper mit dem angegebenen Text.

Die setSelectedDataAsync -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nie im Textkörper des Elements befand oder der Textkörper des Elements den Fokus auf der Benutzeroberfläche verloren hat, wird die Zeichenfolge oben im Textkörperinhalt eingefügt. 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 Zeichenfolge, die den vorhandenen Text ersetzen soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Das gewünschte Format für den Textkörper. Der Zeichenfolge im data-Parameter wird in dieses Format konvertiert.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie getTypeAsync auf, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

* Wichtig:

Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setSelectedDataAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 1.000.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

Beispiele

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

/* This snippet replaces selected text in a message or appointment's body with specified text.
  
  If you want to use a link in HTML markup as a value of the setSelectedDataAsync call's data parameter, you can disable online link preview by setting the anchor tag's id attribute to "LPNoLP". For example, '<a id="LPNoLP" href="https://www.contoso.com">Click here!</a>'.
*/
const text = $("#text-field").val().toString();

// It's recommended to call getTypeAsync and pass its returned value to the options.coercionType parameter of the prependAsync call.
Office.context.mailbox.item.body.getTypeAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  const bodyFormat = asyncResult.value;
  Office.context.mailbox.item.body.setSelectedDataAsync(text, { coercionType: bodyFormat }, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }

    console.log(`Replaced selected text with "${text}".`);
  });
});

setSelectedDataAsync(data, callback)

Ersetzt die Auswahl im Textkörper mit dem angegebenen Text.

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

Parameter

data: string

Die Zeichenfolge, die den vorhandenen Text ersetzen soll. Die Zeichenfolge ist auf 1.000.000 Zeichen beschränkt.

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Empfohlen: Rufen Sie getTypeAsync auf, und übergeben Sie dann den zurückgegebenen Wert an den options.coercionType Parameter.

* Wichtig:

Wenn Sie Links in HTML-Markup einschließen, können Sie die Onlinelinkvorschau deaktivieren, indem Sie das id -Attribut für den Anker (<a>) auf "LPNoLP" festlegen (ein Beispiel finden Sie im Abschnitt Beispiele).
SVG-Dateien werden nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setSelectedDataAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 1.000.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

setSignatureAsync(data, options, callback)

Fügt dem Elementtext eine Signatur hinzu, wenn keine signatur vorhanden ist. Wenn bereits eine Signatur im Text vorhanden ist, ersetzt diese Signatur.

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

Parameter

data: string

Die Zeichenfolge, die die Signatur darstellt, die im Textkörper der E-Mail festgelegt werden soll. Diese Zeichenfolge ist auf 30.000 Zeichen beschränkt.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Das Format, auf das die Signatur festgelegt werden soll. Bei Text legt die Methode die Signatur auf Nur-Text fest und entfernt alle vorhandenen HTML-Tags. Bei Html legt die Methode die Signatur auf HTML fest.

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.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

In Outlook im Web und neuen Outlook unter WindowssetSignatureAsync funktioniert nur für Nachrichten.
Diese Methode wird ab Version 4.2352.0 in Message Compose unter Outlook unter Android und unter iOS unterstützt. Ein Beispielszenario finden Sie unter Implementieren der ereignisbasierten Aktivierung in mobilen Outlook-Add-Ins. Weitere Informationen zu den in Outlook Mobile unterstützten APIs finden Sie unter In Outlook auf mobilen Geräten unterstützte Outlook-JavaScript-APIs.
Das Verhalten von unterscheidet sich, wenn Sie es im Ereignishandler eines Add-Ins aufrufen, das das ereignisbasierte Aktivierungsfeature mithilfe vonsetSignatureAsync LaunchEvent im Manifest implementiert. Wenn der Benutzer ein neues Element (einschließlich Antwort oder Weiterleitung) erstellt, wird die Signatur festgelegt, aber das Formular wird nicht geändert. Dies bedeutet, dass der Benutzer, der das Formular schließt, ohne weitere Änderungen vorzunehmen, nicht aufgefordert wird, Änderungen zu speichern.
SVG-Dateien werden in E-Mail-Signaturen nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setSignatureAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 30.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

Beispiele

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

// Set the signature for the current item with inline image.
const modIcon1Base64 = "iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA2ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYxIDY0LjE0MDk0OSwgMjAxMC8xMi8wNy0xMDo1NzowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpDRDMxMDg1MjBCNDZFMTExODE2MkM1RUI2M0M4MDYxRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpFMTUxQjgyRjQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpFMTUxQjgyRTQ2MEQxMUUxODlFMkQwNTYzQ0YwMTUxMiIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ1M1LjEgV2luZG93cyI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkQxMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkNEMzEwODUyMEI0NkUxMTE4MTYyQzVFQjYzQzgwNjFEIi8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+uC/WfAAAAehJREFUeNpilCzfwEAEkAbiECA2A2J1IOaHin8E4ptAfBaIVwLxU0IGMRKw0B6IW4DYhoE4cASIK6E0VsCEQ1wUiNcB8QESLGOAqj0MxBuhZhBloS4QnwHiQAbygR/UDF1CFupCXSjHQDmQg5qli8tCUBBsQUoQ1AD8UDNFsVk4n0o+w+bT+egWglKjNymmeGhLkqLcG2oHAwtUoIuQDj5OVgZPLUmwRe5aEmAxqYqNpFgKssOcCeplM0KqdST5GfpDDRm0JfkYrj3/SE7QguyQY4ImYYLgCtAS10kHGMw6dzNsv/qC7OwCClJXYlR++v6b4er3j5QmIFcmaNlIL6AOslCIjhYKMTHQGTBBqxh6gXcgC6/R0cKbIAv30dHCfaAKGJTxHxJSqS3Fz9DkowNmywpyMcgA8fF7b8D8VWcfM6w8+4gYC+VB+RCk8hSh0gaUD4/dewvlvUWRe/z+GzGWgex4BGtiOAHxXhoHpzMoSGHZAhSPW2lo2VZYWkHOh4nEtLrIAE+hZmNUwK+B2BOIv1PRsu9QM1/jatNcBtVZ0IREKXgENesyoVYbzNIdFFi2A5tl+NqlL6BB4QBNzsSCU1A9nlAzMAALAQMOQl0qB23qWwKxIlIrDBQ394H4OBCvISYqAAIMACVibHDqsO7zAAAAAElFTkSuQmCC";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  modIcon1Base64,
  "myImage.png",
  { isInline: true },
  function(result) {
    if (result.status == Office.AsyncResultStatus.Succeeded) {
      const signature = $("#signature").val() + "<img src='cid:myImage.png'>";
      console.log(`Setting signature to "${signature}".`);
      Office.context.mailbox.item.body.setSignatureAsync(
        signature,
        { coercionType: "html" },
        function(asyncResult) {
          console.log(`setSignatureAsync: ${asyncResult.status}`);
        }
      );
    } else {
      console.error(`addFileAttachmentFromBase64Async: ${result.error}`);
    }
  }
);

...

// Set the signature for the current item.
const signature = $("#signature").val();
console.log(`Setting signature to "${signature}".`);
Office.context.mailbox.item.body.setSignatureAsync(signature, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("setSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

setSignatureAsync(data, callback)

Fügt dem Elementtext eine Signatur hinzu, wenn keine signatur vorhanden ist. Wenn bereits eine Signatur im Text vorhanden ist, ersetzt diese Signatur.

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

Parameter

data: string

Die Zeichenfolge, die die Signatur darstellt, die im Textkörper der E-Mail festgelegt werden soll. Diese Zeichenfolge ist auf 30.000 Zeichen beschränkt.

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.10 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Compose

Wichtig:

In Outlook im Web und neuen Outlook unter WindowssetSignatureAsync funktioniert nur für Nachrichten.
Diese Methode wird ab Version 4.2352.0 in Message Compose unter Outlook unter Android und unter iOS unterstützt. Ein Beispielszenario finden Sie unter Implementieren der ereignisbasierten Aktivierung in mobilen Outlook-Add-Ins. Weitere Informationen zu den in Outlook Mobile unterstützten APIs finden Sie unter In Outlook auf mobilen Geräten unterstützte Outlook-JavaScript-APIs.
Das Verhalten von unterscheidet sich, wenn Sie es im Ereignishandler eines Add-Ins aufrufen, das das ereignisbasierte Aktivierungsfeature mithilfe vonsetSignatureAsync LaunchEvent im Manifest implementiert. Wenn der Benutzer ein neues Element (einschließlich Antwort oder Weiterleitung) erstellt, wird die Signatur festgelegt, aber das Formular wird nicht geändert. Dies bedeutet, dass der Benutzer, der das Formular schließt, ohne weitere Änderungen vorzunehmen, nicht aufgefordert wird, Änderungen zu speichern.
SVG-Dateien werden in E-Mail-Signaturen nicht unterstützt. Verwenden Sie stattdessen JPG- oder PNG-Dateien.
Inline-CSS setSignatureAsync wird von der -Methode nicht unterstützt. Verwenden Sie stattdessen internes oder externes CSS.

Fehler:

DataExceedsMaximumSize : Der data Parameter ist länger als 30.000 Zeichen.
InvalidFormatError : Der options.coercionType Parameter ist auf Office.CoercionType.Html festgelegt, und der Nachrichtentext ist nur-Text.

Freigeben über

Office.Body interface

Hinweise

Beispiele

Methoden

Details zur Methode

appendOnSendAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

appendOnSendAsync(data, callback)

Parameter

Gibt zurück

Hinweise

getAsync(coercionType, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getAsync(coercionType, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getTypeAsync(options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getTypeAsync(callback)

Parameter

Gibt zurück

Hinweise

prependAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

prependAsync(data, callback)

Parameter

Gibt zurück

Hinweise

prependOnSendAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

prependOnSendAsync(data, callback)

Parameter

Gibt zurück

Hinweise

setAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

setAsync(data, callback)

Parameter

Gibt zurück

Hinweise

setSelectedDataAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

setSelectedDataAsync(data, callback)

Parameter

Gibt zurück

Hinweise

setSignatureAsync(data, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

setSignatureAsync(data, callback)

Parameter

Gibt zurück

Hinweise

Zusätzliche Ressourcen