Office.MessageCompose interface

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

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

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

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

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

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

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

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

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

Gibt zurück

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

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

Gibt zurück

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.

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

Gibt zurück

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

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

Gibt zurück

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.

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

Gibt zurück

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

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

Gibt zurück

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

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

Gibt zurück

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

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

Gibt zurück

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

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

Gibt zurück

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.

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

Gibt zurück

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

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

Gibt zurück

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.