Office.AppointmentCompose interface

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: Terminorganisator

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 an object that is passed as the result parameter to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

Ruft Datum und Zeit für das Ende des Termins ab oder legt diese fest.

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

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

Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um das Ende einer Wiederholung zu aktualisieren.

end: Time;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

Beispiele

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

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

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

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

itemType: MailboxEnums.ItemType | string;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

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 den Ort eines Termins ab bzw. legt ihn fest. Die location Eigenschaft gibt ein Location-Objekt zurück, das Methoden bereitstellt, mit denen der Ort des Termins ermittelt und festgelegt werden kann.

location: Location;

Eigenschaftswert

Hinweise

API-Satz: Postfach 1.1

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

Wichtig: Die enhancedLocation Eigenschaft wurde im Postfach-Anforderungssatz 1.8 eingeführt. Verwenden Sie die enhancedLocation Eigenschaft, um Terminorte besser zu identifizieren und zu verwalten, insbesondere, wenn Sie den Standorttyp bestimmen müssen. Eine Anleitung zum Auswählen der richtigen Standort-API für Ihr Szenario finden Sie unter Abrufen oder Festlegen des Standorts beim Verfassen eines Termins in Outlook.

Beispiele

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

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

...

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Objekttyp und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die optionalAttendees-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der optionalen Teilnehmer für eine Besprechung 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".

optionalAttendees: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

Beispiele

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

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

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

Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Objekttyp und die Zugriffsebene hängen vom Modus des aktuellen Elements ab.

Die requiredAttendees-Eigenschaft gibt ein Recipients-Objekt zurück, das Methoden zum Abrufen oder Aktualisieren der erforderlichen Teilnehmer für eine Besprechung 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".

requiredAttendees: Recipients;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

Beispiele

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

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

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

Ruft Datum und Zeit für den Beginn des Termins ab oder legt Datum und Uhrzeit fest.

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

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

Wichtig: Im Windows-Client können Sie diese Eigenschaft nicht verwenden, um den Beginn einer Wiederholung zu aktualisieren.

start: Time;

Eigenschaftswert

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

Beispiele

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

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

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

...

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

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: Terminorganisator

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

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: Terminorganisator

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.

• 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: Terminorganisator

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.

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

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

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

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

Fehler:

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

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

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

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

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

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

Wenn Ihr Office-Add-In in Outlook im Web und 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: Terminorganisator

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 und 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: Terminorganisator

Fehler:

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

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

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

Um auf die ausgewählten Daten aus der Rückruffunktion zuzugreifen, rufen Sie asyncResult.value.dataauf. Um auf die Eigenschaft zuzugreifen, von der source 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: Terminorganisator

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 Eigenschaft zuzugreifen, von der source die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, was entweder body oder ist subject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => 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: Terminorganisator

Beispiele

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

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

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

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.1

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminorganisator

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: Terminorganisator

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: Terminorganisator

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

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: Postfach 1.2

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminorganisator

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: Terminorganisator

Fehler:

• InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.