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

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

categories: Categories;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig: In Outlook im Web und dem neuen Outlook unter Windows können Sie die API nicht verwenden, um Kategorien in einer Nachricht im Compose-Modus zu verwalten.

Beispiele

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

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

...

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

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

...

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

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 das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht ab oder legt diese fest.

Die delayDeliveryTime Eigenschaft gibt ein DelayDeliveryTime Objekt zurück, das Methoden zum Verwalten des Übermittlungsdatums und der Übermittlungszeit der Nachricht bereitstellt.

delayDeliveryTime: DelayDeliveryTime;

Eigenschaftswert

Hinweise

API-Satz: Mailbox 1.13

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/delay-message-delivery.yaml

function setDeliveryDate(minutes) {
  // This snippet sets the delivery date and time of a message.
  const currentTime = new Date().getTime();
  const milliseconds = totalDelay * 60000;
  const timeDelay = new Date(currentTime + milliseconds);
  Office.context.mailbox.item.delayDeliveryTime.setAsync(timeDelay, (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log(asyncResult.error.message);
      return;
    }

    if (minutes === 1440) {
      console.log(`Delayed delivery by an additional one day.`);
    } else {
      console.log(`Delayed delivery by an additional ${minutes} minutes.`);
    }
  });
}

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

Die from Eigenschaft gibt ein From Objekt zurück, das eine Methode zum Abrufen des Von-Werts bereitstellt.

from: From;

Eigenschaftswert

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Diese Eigenschaft wird in Outlook unter Android und iOS unterstützt. Ein Beispielszenario finden Sie unter Implementieren der ereignisbasierten Aktivierung in Outlook Mobile-Add-Ins.

Beispiele

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

Office.context.mailbox.item.from.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const msgFrom = asyncResult.value;
    console.log("Message from: " + msgFrom.displayName + " (" + msgFrom.emailAddress + ")");
  } else {
    console.error(asyncResult.error);
  }
});

Ruft die Internetnachrichten-ID der ursprünglichen Nachricht ab, auf die von der aktuellen Nachricht geantwortet wird.

inReplyTo: string;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• In Outlook unter Windows wird der inReplyTo Wert für alle Antworten beibehalten, unabhängig von Änderungen, die der Benutzer vorgenommen hat, z. B. dem Ändern des Betreffs in einer Antwort.

• Die inReplyTo Eigenschaft wird zurückgegeben null , wenn neue Nachrichten und Besprechungseinladungen von einem Benutzer weitergeleitet werden, der auch der Besprechungsorganisator ist.

Beispiele

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

// This snippet gets the ID of the message being replied to by the current message (PR_IN_REPLY_TO_ID).
// The API call is supported on messages being composed and isn't supported on read items.
const inReplyTo = Office.context.mailbox.item.inReplyTo;
if (inReplyTo) {
  console.log("ID of the message being replied to: " + inReplyTo);
} else {
  console.log("No InReplyTo property available for this message");
}

Ruft die benutzerdefinierten Internetheader einer Nachricht ab oder legt sie fest.

Die internetHeaders Eigenschaft gibt ein InternetHeaders Objekt zurück, das Methoden zum Verwalten der Internetheader in der Nachricht bereitstellt.

Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen für eine Nachricht in einem Outlook-Add-In.

internetHeaders: InternetHeaders;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Die Internetheader-API wird in Outlook unter Android und unter iOS ab Version 4.2405.0 unterstützt. Weitere Informationen zu Features, die in Outlook auf Mobilgeräten unterstützt werden, finden Sie unter Outlook-JavaScript-APIs, die in Outlook auf Mobilgeräten unterstützt werden.

Beispiele

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

Office.context.mailbox.item.internetHeaders.getAsync(
  ["preferred-fruit", "preferred-vegetable", "best-vegetable", "nonexistent-header"],
  function (asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("Selected headers: " + JSON.stringify(asyncResult.value));
    } else {
      console.log("Error getting selected headers: " + JSON.stringify(asyncResult.error));
    }
  }
);

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

Ruft das Objekt ab, um die Vertraulichkeitsbezeichnung einer Nachricht abzurufen oder festzulegen.

sensitivityLabel: SensitivityLabel;

Eigenschaftswert

Hinweise

API-Satz: Mailbox 1.13

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Um das Feature für Vertraulichkeitsbezeichnungen in Ihrem Add-In verwenden zu können, müssen Sie über ein Microsoft 365 E5 Abonnement verfügen.

Weitere Informationen zum Verwalten von Vertraulichkeitsbezeichnungen in Ihrem Add-In finden Sie unter Verwalten der Vertraulichkeitsbezeichnung Ihrer Nachricht oder Ihres Termins im Kompositionsmodus.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml

// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
    Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
        console.log(asyncResult.value);
      } else {
        console.log("Action failed with error: " + asyncResult.error.message);
      }
    });
  } else {
    console.log("Action failed with error: " + asyncResult.error.message);
  }
});

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

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

seriesId: string;

Eigenschaftswert

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

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

Beispiele

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

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

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

Verwaltet die SessionData eines Elements im Modus "Compose".

Wichtig: In Outlook-Clients, die Postfach 1.15 oder früher unterstützen, ist das gesamte SessionData-Objekt für jedes E-Mail-Element auf 50.000 Zeichen pro Add-In beschränkt. In Clients, die Mailbox 1.16 oder höher unterstützen, beträgt das Zeichenlimit pro Add-In 2.621.440 Zeichen.

sessionData: SessionData;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.11

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/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

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 eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.

Die addFileAttachmentFromBase64Async Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie im Erstellungsformular an das Element an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value Objekt zurück.

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Das Hinzufügen einer Base64-Inlinedatei zu einer Nachricht im Erstellungsmodus wird in Outlook unter Android und unter iOS 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 nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• Wenn Sie eine Daten-URL-API verwenden (z. B readAsDataURL. ), müssen Sie das Daten-URL-Präfix entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn die vollständige Zeichenfolge beispielsweise durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

• Um dem Text einer Nachricht oder eines Termins, der verfasst wird, ein Base64-codiertes Inlinebild hinzuzufügen, verwenden Sie die Body-API-Methoden wie prependAsync, setSignatureAsync, oder .setAsync Wenn Sie verwenden, um das Bild einzufügen, rufen Office.context.mailbox.item.body.getAsync Sie Office.context.mailbox.item.body.setAsync zuerst auf, um den aktuellen Text des Elements abzurufen. Andernfalls wird das Bild nach dem Einfügen nicht im Textkörper gerendert. Ein Beispiel finden Sie im Beispiel Hinzufügen eines Base64-codierten Inlinebilds zu Nachricht oder Termintext (Compose) in Script Lab.

Fehler:

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

• FileTypeNotSupported : Die Anlage weist eine unzulässige Erweiterung auf.

• 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 base64String = "iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAACXBIWXMAAAsSAAALEgHS3X78AAACRUlEQVRYw82XzXHbMBCFP2F8tzsQc8Ixyh0zoiuIXIGdCsxUYKqC0B04FdiuwMoM7mGOOIXqQGoAymXhgSX+itJM9kIRFLAP+3YXD5Pdbscx5oxaAIW8Ztr6l2PWmQwF4IyaieP53qdfAqQ8CwBn1JU4vpWhrbxXQA5MZfynANmcDIAzKgcy4FKGXsVJFf3nLgKyBQptfT4KQMRz2N0fcbxqmRMDWXflx0VPnrdArq0vekQ1Dv0UeHZGNebHhwjU8AzwKM43RyZnbAf58Q6ghudeWd0Aus0+5EcMIIRi3beua0D3Nm39BEAx3i7HTK4DEBJn5YxKOnaRA5+ErpMBWMpzDvx1RuXCcxOISlufAjfC7zgAsqsvUvMAD0ApPaEtGi9AIlUzKgJo60tt/SyKRkzLrAXERluf7W1gOICWaMyB386oooOWsIHvXbSoHuUSFovtHqicUVnH3EJoeT0aQEf5/XBGlc6otIOWBXAtPeZkAIJ9Bt6cUU9tZautX2nrk3MACHYr1ZKProKRtDw4o8pzAPjWo+NtpXTTvoteDDg8noDAcwbcRedAkGdFXyk2GEDcegVAFp2gyVDHjRQ4o6q2smoqtR5Hd+qMqtoALCWUUymr1m43QMZfOaMK4C0SrMsDANJ2E5FNcbdbjHC+ENl+H0myJFbLtaq4Rt8dyPBYRQV1E40nMv9rl7xrOw3DGb+Whcqu3i/OM6CUOWvgRlufNmnLYy4m77uJI7AXtdNcTDrU71LEyv7v01/N/ovL6bmu5/8A1tNWZldH0W4AAAAASUVORK5CYII=";
Office.context.mailbox.item.addFileAttachmentFromBase64Async(
  base64String,
  "logo.png",
  { isInline: false },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to add attachment from Base64-encoded string: ${result.error.message}.`);
      return;
    }
    console.log(`Added attachment from a Base64-encoded string with ID: ${result.value}`);
  }
);

...

// 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 = (document.getElementById("signature") as HTMLInputElement).value + "<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}`);
    }
  }
);

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

Die addFileAttachmentFromBase64Async Methode lädt die Datei aus der Base64-Codierung hoch und fügt sie im Erstellungsformular an das Element an. Diese Methode gibt den Anlagenbezeichner im asyncResult.value Objekt zurück.

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Das Hinzufügen einer Base64-Inlinedatei zu einer Nachricht im Erstellungsmodus wird in Outlook unter Android und unter iOS 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 nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• Wenn Sie eine Daten-URL-API verwenden (z. B readAsDataURL. ), müssen Sie das Daten-URL-Präfix entfernen und dann den Rest der Zeichenfolge an diese API senden. Wenn die vollständige Zeichenfolge beispielsweise durch data:image/svg+xml;base64,<rest of Base64 string>dargestellt wird, entfernen Sie data:image/svg+xml;base64,.

• Um dem Text einer Nachricht oder eines Termins, der verfasst wird, ein Base64-codiertes Inlinebild hinzuzufügen, verwenden Sie die Body-API-Methoden wie prependAsync, setSignatureAsync, oder .setAsync Wenn Sie verwenden, um das Bild einzufügen, rufen Office.context.mailbox.item.body.getAsync Sie Office.context.mailbox.item.body.setAsync zuerst auf, um den aktuellen Text des Elements abzurufen. Andernfalls wird das Bild nach dem Einfügen nicht im Textkörper gerendert. Ein Beispiel finden Sie im Beispiel Hinzufügen eines Base64-codierten Inlinebilds zu Nachricht oder Termintext (Compose) in Script Lab.

Fehler:

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

• FileTypeNotSupported : Die Anlage weist eine unzulässige Erweiterung auf.

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

Beispiele

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

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

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.

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

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

Schließt die aktuelle Nachricht mit der Option, nicht gespeicherte Änderungen zu verwerfen. Bei der zu verfassenden Nachricht kann es sich um eine neue Nachricht, eine Antwort oder einen vorhandenen Entwurf handeln.

closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die closeAsync Methode wird nur in Aufgabenbereichs- und Funktionsbefehlsimplementierungen unterstützt. Sie wird in ereignisbasierten Handlern oder Szenarien mit Mehrfachauswahl von Elementen nicht unterstützt.

• Wenn die closeAsync Methode die aktuelle Nachricht erfolgreich schließt und verwirft, wird das Add-In, das sie aufgerufen hat, nicht mehr ausgeführt.

Fehler:

• The operation was cancelled by the user : Der Benutzer wählt im Speicherdialogfeld "Abbrechen " aus und die discardItem Eigenschaft ist nicht definiert oder auf falsefestgelegt.

• The operation is not supported : Die closeAsync Methode versucht, eine Antwort im Lesebereich oder einen vorhandenen Entwurf zu schließen, und die discardItem Eigenschaft ist nicht definiert oder auf falsefestgelegt.

Schließt die aktuelle neue Nachricht, die verfasst wird.

Das Verhalten einer neu zu verfassenden Nachricht hängt davon ab, ob die Nachricht nicht gespeicherte Änderungen enthält. Wenn keine Änderungen vorgenommen wurden, wird die Nachricht ohne einen Speicherdialog geschlossen. Enthält die Nachricht hingegen nicht gespeicherte Änderungen, wird ein Dialogfeld zum Speichern angezeigt, in dem der Benutzer aufgefordert wird, einen Entwurf zu speichern, die Änderungen zu verwerfen oder den Vorgang abzubrechen.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die closeAsync Methode wird nur in Aufgabenbereichs- und Funktionsbefehlsimplementierungen unterstützt. Sie wird in ereignisbasierten Handlern oder Szenarien mit Mehrfachauswahl von Elementen nicht unterstützt.

• Wenn die closeAsync Methode die aktuelle Nachricht erfolgreich schließt und verwirft, wird das Add-In, das sie aufgerufen hat, nicht mehr ausgeführt.

Fehler:

• The operation was cancelled by the user : Der Benutzer wählt im Speicherdialogfeld Abbrechen aus.

• The operation is not supported : Die closeAsync Methode versucht, eine Antwort im Lesebereich oder einen vorhandenen Entwurf zu schließen.

Beispiele

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

// This snippet closes the current message being composed and discards any unsaved changes when the optional property, discardItem, is set to true.
// The API call works on a new message being composed, a reply, or an existing draft.
// When discardItem is set to false or isn't defined on a new message with unsaved changes, the user is prompted to save a draft, discard the changes, or cancel the close operation.
Office.context.mailbox.item.closeAsync(
  { discardItem: true },
  (asyncResult) => {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Action failed with error: " + asyncResult.error.message);
      return;
    }
  });

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

• In Outlook im Web und im neuen Outlook unter Windows ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der Methode deaktiviert.

• In Outlook unter Windows (klassisch) und auf dem Mac ist die Signatur in den Abschnitten "Neue Nachrichten " und " Antworten/Weiterleitungen" des sendenden Kontos auf "(Keine)" festgelegt.

• In Outlook unter Android und iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Diese Methode wird in Nachrichten-Compose in Outlook unter Android und iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Beispiele

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

// Disable the client signature.
Office.context.mailbox.item.disableClientSignatureAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("disableClientSignatureAsync succeeded");
  } else {
    console.error(asyncResult.error);
  }
});

Deaktiviert die Outlook-Clientsignatur.

Das Verhalten dieser Methode hängt davon ab, auf welchem Client das Add-In ausgeführt wird.

• In Outlook im Web und im neuen Outlook unter Windows ist die Signaturoption für neue E-Mails, Antworten und Weiterleitungen deaktiviert. Eine ausgewählte Signatur wird ebenfalls von der Methode deaktiviert.

• In Outlook unter Windows (klassisch) und auf dem Mac ist die Signatur in den Abschnitten "Neue Nachrichten " und " Antworten/Weiterleitungen" des sendenden Kontos auf "(Keine)" festgelegt.

• In Outlook unter Android und iOS wird die auf dem mobilen Gerät gespeicherte Signatur gelöscht.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Diese Methode wird in Nachrichten-Compose in Outlook unter Android und iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die getAttachmentContentAsync Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

• Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• In Outlook im Web und dem neuen Outlook unter Windows werden Anlagen nicht unterstützt, getAttachmentContentAsync die mit der Option "Hochladen und Freigeben" hinzugefügt wurden.

• In Outlook im Web, auf mobilen Geräten und im neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt oder wenn der Benutzer mit dem Verfassen eines Inlineformulars beginnt und das Formular anschließend ausblendet, um in einem separaten Fenster fortzufahren.

Fehler:

• AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Nicht unterstützte Typen sind eingebettete Bilder im Rich-Text-Format oder andere Element-Anlagentypen als E-Mail oder Kalenderelemente (z. B. Kontakte oder Aufgabenelemente).

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

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

// Gets the attachments of the current message or appointment in compose mode. The getAttachmentsAsync call can only be used in compose mode.
Office.context.mailbox.item.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(result.error.message);
    return;
  }

  if (result.value.length <= 0) {
    console.log("Mail item has no attachments.");
    return;
  }

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

Ruft eine Anlage aus einer Nachricht oder einem Termin ab und gibt sie als AttachmentContent Objekt zurück.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die getAttachmentContentAsync Methode ruft die Anlage mit dem angegebenen Bezeichner aus dem Element ab. Als bewährte Methode sollten Sie den Bezeichner der Anlage aus einem getAttachmentsAsync Aufruf abrufen und diesen dann in derselben Sitzung verwenden, um die Anlage abzurufen.

• Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• In Outlook im Web und dem neuen Outlook unter Windows werden Anlagen nicht unterstützt, getAttachmentContentAsync die mit der Option "Hochladen und Freigeben" hinzugefügt wurden.

• In Outlook im Web, auf mobilen Geräten und im neuen Outlook unter Windows ist der Anlagenbezeichner nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt oder wenn der Benutzer mit dem Verfassen eines Inlineformulars beginnt und das Formular anschließend ausblendet, um in einem separaten Fenster fortzufahren.

Fehler:

• AttachmentTypeNotSupported : Der Anlagentyp wird nicht unterstützt. Nicht unterstützte Typen sind eingebettete Bilder im Rich-Text-Format oder andere Element-Anlagentypen als E-Mail oder Kalenderelemente (z. B. Kontakte oder Aufgabenelemente).

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• In Outlook im Web und dem neuen Outlook unter Windows können Benutzer die Option Hochladen und freigeben auswählen, um eine Anlage auf OneDrive hochzuladen und einen Link zur Datei in das E-Mail-Element einzufügen. Da jedoch nur ein Link enthalten ist, getAttachmentsAsync wird diese Anlage nicht zurückgegeben.

• Bei Anhängen des Typs Office.MailboxEnums.AttachmentType.Itemkönnen sich die Größe und der serialisierte Inhalt, der von zurückgegeben wird getAttachmentsAsync , zwischen Aufrufen von einem OnMessageSend ODER-Ereignishandler OnAppointmentSend unterscheiden. Um Anlagenänderungen zuverlässig zu erkennen, behandeln Sie stattdessen das OnMessageAttachmentsChanged oder-Ereignis OnAppointmentAttachmentsChanged .

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.getAttachmentsAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(result.error.message);
    return;
  }

  if (result.value.length > 0) {
    for (let i = 0; i < result.value.length; i++) {
      const attachment = result.value[i];
      let attachmentType;
      switch (attachment.attachmentType) {
        case Office.MailboxEnums.AttachmentType.Cloud:
          attachmentType = "Attachment is stored in a cloud location";
          break;
        case Office.MailboxEnums.AttachmentType.File:
          attachmentType = "Attachment is a file";
          break;
        case Office.MailboxEnums.AttachmentType.Item:
          attachmentType = "Attachment is an Exchange item";
          break;
      }
      console.log(
        "ID: " +
          attachment.id +
          "\n" +
          "Type: " +
          attachmentType +
          "\n" +
          "Name: " +
          attachment.name +
          "\n" +
          "Size: " +
          attachment.size +
          "\n" +
          "isInline: " +
          attachment.isInline
      );
    }
  } else {
    console.log("No attachments on this message.");
  }
});

Ruft die Anlagen des Elements als Array ab.

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Ab dem 30. März 2026 wird nach Abschluss des Aufrufs von addFileAttachmentAsync oder addFileAttachmentFromBase64Async mit isInline "Als festgelegt antrue" Inlinebildern in Nachrichten in Outlook im Web und dem neuen Outlook unter Windows 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 eine Exchange-Webdienste-ID (EWS) zugewiesen. 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.

• In Outlook im Web und dem neuen Outlook unter Windows können Benutzer die Option Hochladen und freigeben auswählen, um eine Anlage auf OneDrive hochzuladen und einen Link zur Datei in das E-Mail-Element einzufügen. Da jedoch nur ein Link enthalten ist, getAttachmentsAsync wird diese Anlage nicht zurückgegeben.

• Bei Anhängen des Typs Office.MailboxEnums.AttachmentType.Itemkönnen sich die Größe und der serialisierte Inhalt, der von zurückgegeben wird getAttachmentsAsync , zwischen Aufrufen von einem OnMessageSend ODER-Ereignishandler OnAppointmentSend unterscheiden. Um Anlagenänderungen zuverlässig zu erkennen, behandeln Sie stattdessen das OnMessageAttachmentsChanged oder-Ereignis OnAppointmentAttachmentsChanged .

Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp kann HTML oder Nur-Text sein.

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

Parameter

Gibt zurück

Ein Objekt mit ComposeType und-Enumerationswerten CoercionType für das Nachrichtenelement.

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Diese Methode wird in Outlook unter Android und iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Gibt den Typ der Nachrichtenerstellung und ihren Umwandlungstyp an. Die Nachricht kann neu, eine Antwort oder eine Weiterleitung sein. Der Umwandlungstyp kann HTML oder Nur-Text sein.

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

Parameter

Gibt zurück

Ein Objekt mit ComposeType und-Enumerationswerten CoercionType für das Nachrichtenelement.

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig: Diese Methode wird in Outlook unter Android und iOS ab Version 4.2352.0 unterstützt. Weitere Informationen zu unterstützten APIs in Outlook Mobile finden Sie unter In Outlook auf Mobilgeräten unterstützte Outlook-JavaScript-APIs.

Beispiele

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

// Get the compose type of the current message.
Office.context.mailbox.item.getComposeTypeAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log(
      "getComposeTypeAsync succeeded with composeType: " +
        asyncResult.value.composeType +
        " and coercionType: " +
        asyncResult.value.coercionType
    );
  } else {
    console.error(asyncResult.error);
  }
});

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Tipp: Sie können den Unterhaltungsindex verwenden, um eine Nachricht in einem Unterhaltungsthread zu suchen. Verwenden Sie dann den Inhalt, um Kontext für die aktuelle Nachricht bereitzustellen, die verfasst wird.

Ruft die Base64-codierte Position der aktuellen Nachricht in einem Unterhaltungsthread ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Tipp: Sie können den Unterhaltungsindex verwenden, um eine Nachricht in einem Unterhaltungsthread zu suchen. Verwenden Sie dann den Inhalt, um Kontext für die aktuelle Nachricht bereitzustellen, die verfasst wird.

Beispiele

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

// This snippet returns the Base64-encoded position of the current message in a conversation thread (PR_CONVERSATION_INDEX).
// The API call is supported on a message being composed and isn't supported on read items or appointments.
Office.context.mailbox.item.getConversationIndexAsync((result) => {
   if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(result.error.message);
      return;
   }
   
   const conversationIndex = result.value;
   if (conversationIndex) {
      console.log("Position in the conversation thread: " + conversationIndex);
   } else {
      console.log("The current message doesn't belong to a conversation thread.");
   }
});

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Beispiele

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

Ruft Initialisierungsdaten ab, die übergeben werden, wenn das Add-In durch eine Aktion erfordernde Nachricht aktiviert wird.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Ruft die Exchange-Webdienste-Elementklasse der ausgewählten Nachricht ab.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

In der folgenden Tabelle sind die Standardnachrichtenklassen aufgeführt.

Beispiele

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

// This snippet returns the Exchange Web Services item class property (PR_MESSAGE_CLASS) of the current message.
// The API call is only supported on a message being composed.
Office.context.mailbox.item.getItemClassAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }

  console.log("Item class of the current message: " + asyncResult.value);
});

Ruft asynchron die Exchange-Webdienste (Exchange-Webdienste, EWS)-Element-ID eines gespeicherten Elements ab.

Beim Aufrufen gibt diese Methode die Element-ID über die Rückruffunktion zurück.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

• Wenn Ihr Add-In aufruft getItemIdAsync (zum Beispiel, um eine Element-ID abzurufen, die mit EWS oder der REST-API verwendet werden soll), beachten Sie, dass es im Zwischenspeichermodus von Outlook einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird die Element-ID nicht erkannt, und ihre Verwendung gibt einen Fehler zurück.

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

Ruft asynchron die Exchange-Webdienste (Exchange-Webdienste, EWS)-Element-ID eines gespeicherten Elements ab.

Beim Aufrufen gibt diese Methode die Element-ID über die Rückruffunktion zurück.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

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

• Wenn Ihr Add-In aufruft getItemIdAsync (zum Beispiel, um eine Element-ID abzurufen, die mit EWS oder der REST-API verwendet werden soll), beachten Sie, dass es im Zwischenspeichermodus von Outlook einige Zeit dauern kann, bis das Element mit dem Server synchronisiert wird. Bis das Element synchronisiert wird, wird die Element-ID nicht erkannt, und ihre Verwendung gibt einen Fehler zurück.

Fehler:

• ItemNotSaved : Die ID kann erst abgerufen werden, wenn das Element gespeichert wurde.

Beispiele

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

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

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

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

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren freigegebener Ordner und Szenarien für freigegebene Postfächer in einem Outlook-Add-In.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8 für Unterstützung für gemeinsam genutzte Ordner, Postfach 1.13 für Unterstützung für gemeinsam genutzte Postfächer

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

Wichtig: Im Nachrichtenmodus Compose wird diese API in Outlook im Web oder Windows (neu und klassisch) nur unterstützt, wenn die folgenden Bedingungen erfüllt sind.

a. Zugriff delegieren/Freigegebene Ordner

1. Der Postfachbesitzer startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner "Entwürfe" in einen Ordner, der für die Stellvertretung freigegeben wurde.

3. Die Stellvertretung öffnet den Entwurf aus dem freigegebenen Ordner und setzt das Verfassen dann fort.

b. Freigegebenes Postfach, das im selben Bereich wie das primäre Postfach des Benutzers geöffnet ist (Web, klassisches Windows) oder das freigegebene Postfach, das nicht zu einem vollständigen Konto heraufgestuft wurde (neues Windows)

1. Der Benutzer des freigegebenen Postfachs startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner "Entwürfe" in einen Ordner im freigegebenen Postfach.

3. Ein anderer Benutzer des freigegebenen Postfachs öffnet den Entwurf aus dem freigegebenen Postfach und setzt das Verfassen dann fort.

Sobald diese Bedingungen erfüllt sind, wird die Nachricht in einem freigegebenen Kontext verfügbar, und Add-Ins, die diese gemeinsamen Szenarien unterstützen, können die gemeinsamen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner "Gesendete Elemente " des persönlichen Postfachs des Absenders.

Die getSharedPropertiesAsync Methode wird auf den folgenden Plattformen ohne zusätzliche Bedingungen unterstützt.

• Outlook im Web, wenn das freigegebene Postfach mithilfe der Option "Anderes Postfach öffnen" in einer separaten Registerkarte oder einem separaten Fenster geöffnet wird.

• Neues Outlook unter Windows, wenn das freigegebene Postfach zu einem vollständigen Konto heraufgestuft wird.

Ruft die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach ab.

Weitere Informationen zur Verwendung dieser API finden Sie unter Aktivieren freigegebener Ordner und Szenarien für freigegebene Postfächer in einem Outlook-Add-In.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.8 für Unterstützung für gemeinsam genutzte Ordner, Postfach 1.13 für Unterstützung für gemeinsam genutzte Postfächer

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

Wichtig: Im Nachrichtenmodus Compose wird diese API in Outlook im Web oder Windows (neu und klassisch) nur unterstützt, wenn die folgenden Bedingungen erfüllt sind.

a. Zugriff delegieren/Freigegebene Ordner

1. Der Postfachbesitzer startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner "Entwürfe" in einen Ordner, der für die Stellvertretung freigegeben wurde.

3. Die Stellvertretung öffnet den Entwurf aus dem freigegebenen Ordner und setzt das Verfassen dann fort.

b. Freigegebenes Postfach, das im selben Bereich wie das primäre Postfach des Benutzers geöffnet ist (Web, klassisches Windows) oder das freigegebene Postfach, das nicht zu einem vollständigen Konto heraufgestuft wurde (neues Windows)

1. Der Benutzer des freigegebenen Postfachs startet eine Nachricht. Dies kann eine neue Nachricht, eine Antwort oder eine Weiterleitung sein.

2. Sie speichern die Nachricht und verschieben sie dann aus ihrem eigenen Ordner "Entwürfe" in einen Ordner im freigegebenen Postfach.

3. Ein anderer Benutzer des freigegebenen Postfachs öffnet den Entwurf aus dem freigegebenen Postfach und setzt das Verfassen dann fort.

Sobald diese Bedingungen erfüllt sind, wird die Nachricht in einem freigegebenen Kontext verfügbar, und Add-Ins, die diese gemeinsamen Szenarien unterstützen, können die gemeinsamen Eigenschaften des Elements abrufen. Nachdem die Nachricht gesendet wurde, befindet sie sich in der Regel im Ordner "Gesendete Elemente " des persönlichen Postfachs des Absenders.

Die getSharedPropertiesAsync Methode wird auf den folgenden Plattformen ohne zusätzliche Bedingungen unterstützt.

• Outlook im Web, wenn das freigegebene Postfach mithilfe der Option "Anderes Postfach öffnen" in einer separaten Registerkarte oder einem separaten Fenster geöffnet wird.

• Neues Outlook unter Windows, wenn das freigegebene Postfach zu einem vollständigen Konto heraufgestuft wird.

Beispiele

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

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

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook unter Windows (klassisch) und auf dem Mac gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, ob die Signatur für die VerfassentypennewMail , reply, oder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) oder auf Mac auf "(keine)" festgelegt oder in Outlook im Web oder im neuen Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.10

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/work-with-client-signatures.yaml

// Check if the client signature is currently enabled.
Office.context.mailbox.item.isClientSignatureEnabledAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("isClientSignatureEnabledAsync succeeded with result: " + asyncResult.value);
  } else {
    console.error(asyncResult.error);
  }
});

Ruft ab, ob die Clientsignatur aktiviert ist.

In Outlook unter Windows (klassisch) und auf dem Mac gibt der API-Aufruf zurück true , wenn die Standardsignatur für neue Nachrichten, Antworten oder Weiterleitungen auf eine Vorlage für das sendende Outlook-Konto festgelegt ist. In Outlook im Web und dem neuen Outlook unter Windows gibt der API-Aufruf zurücktrue, ob die Signatur für die VerfassentypennewMail , reply, oder forwardaktiviert ist. Wenn die Einstellungen in Outlook unter Windows (klassisch) oder auf Mac auf "(keine)" festgelegt oder in Outlook im Web oder im neuen Outlook unter Windows deaktiviert sind, gibt der API-Aufruf zurückfalse.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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.

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Mailbox 1.7

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Message Compose

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

Beispiele

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

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

Speichert die aktuelle Nachricht asynchron als Entwurf.

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

Parameter

Gibt zurück

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.

Speichert die aktuelle Nachricht asynchron als Entwurf.

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

Parameter

Gibt zurück

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

Sendet die zu verfassende Nachricht.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die sendAsync Methode wird nur in Aufgabenbereichs- und Funktionsbefehlsimplementierungen unterstützt. Sie wird in ereignisbasierten Handlern oder Szenarien mit Mehrfachauswahl von Elementen nicht unterstützt.

• In der Implementierung eines Funktionsbefehls spiegelt der zurückgegebene asyncResult.status Wert möglicherweise nicht wider, ob der zu verfassende Termin erfolgreich gesendet wurde. Dies liegt daran, dass es sich bei der sendAsync Methode um eine asynchrone API handelt und Ereignisse außerhalb der Kontrolle des Add-Ins (z. B. Ereignisse, die von einem separat installierten Smart Alerts-Add-In behandelt werden) das Senden des Elements blockieren können. Da Sie sich nicht auf den zurückgegebenen asyncResult.status Status verlassen können, um bestimmte Vorgänge auszuführen, sollten Sie nur die event.completed-Methode in der Rückruffunktion aufrufen. Der event.completed Aufruf signalisiert, dass das Add-In die Verarbeitung abgeschlossen hat. Abgesehen von diesem Aufruf ist die Ausführung von anderem Code in der Rückruffunktion nicht garantiert. Es wird empfohlen, andere Vorgänge vor dem Aufruf von zu verarbeiten sendAsync.

• In einer Aufgabenbereichsimplementierung wird nicht garantiert, dass jeder Code, der asyncResult.statusOffice.AsyncResultStatus.Success beim Ausführen enthalten ist, verarbeitet wird. Dies liegt daran, dass das Element möglicherweise bereits gesendet wurde und das Add-In die Verarbeitung abgeschlossen hat. Es wird empfohlen, andere Vorgänge vor dem Aufruf von zu verarbeiten sendAsync.

• Code, der nach dem sendAsync Aufruf enthalten ist, wird nicht garantiert, dass er ausgeführt wird, da das Add-In die Verarbeitung nach dem sendAsync Aufruf abschließt.

• Die sendAsync Methode steht in Outlook auf Mac ab Version 16.105 (Build 25121117) zur Vorschau zur Verfügung. Um dieses Feature zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.

Sendet die zu verfassende Nachricht.

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe: Lese-/Schreibpostfach

Anwendbarer Outlook-Modus: Message Compose

Wichtig:

• Die sendAsync Methode wird nur in Aufgabenbereichs- und Funktionsbefehlsimplementierungen unterstützt. Sie wird in ereignisbasierten Handlern oder Szenarien mit Mehrfachauswahl von Elementen nicht unterstützt.

• In der Implementierung eines Funktionsbefehls spiegelt der zurückgegebene asyncResult.status Wert möglicherweise nicht wider, ob der zu verfassende Termin erfolgreich gesendet wurde. Dies liegt daran, dass es sich bei der sendAsync Methode um eine asynchrone API handelt und Ereignisse außerhalb der Kontrolle des Add-Ins (z. B. Ereignisse, die von einem separat installierten Smart Alerts-Add-In behandelt werden) das Senden des Elements blockieren können. Da Sie sich nicht auf den zurückgegebenen asyncResult.status Status verlassen können, um bestimmte Vorgänge auszuführen, sollten Sie nur die event.completed-Methode in der Rückruffunktion aufrufen. Der event.completed Aufruf signalisiert, dass das Add-In die Verarbeitung abgeschlossen hat. Abgesehen von diesem Aufruf ist die Ausführung von anderem Code in der Rückruffunktion nicht garantiert. Es wird empfohlen, andere Vorgänge vor dem Aufruf von zu verarbeiten sendAsync.

• In einer Aufgabenbereichsimplementierung wird nicht garantiert, dass jeder Code, der asyncResult.statusOffice.AsyncResultStatus.Success beim Ausführen enthalten ist, verarbeitet wird. Dies liegt daran, dass das Element möglicherweise bereits gesendet wurde und das Add-In die Verarbeitung abgeschlossen hat. Es wird empfohlen, andere Vorgänge vor dem Aufruf von zu verarbeiten sendAsync.

• Code, der nach dem sendAsync Aufruf enthalten ist, wird nicht garantiert, dass er ausgeführt wird, da das Add-In die Verarbeitung nach dem sendAsync Aufruf abschließt.

• Die sendAsync Methode steht in Outlook auf Mac ab Version 16.105 (Build 25121117) zur Vorschau zur Verfügung. Um dieses Feature zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.

Beispiele

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

// This snippet sends the current message or appointment being composed.
Office.context.mailbox.item.sendAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Action failed with error: " + asyncResult.error.message);
    return;
  }
});

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.