Office.AppointmentCompose interface

Referenz

Paket:: outlook

Der Terminorganisationsmodus von Office.context.mailbox.item.

Wichtig: Dies ist ein internes Outlook-Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als Modus behandeln Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite Objektmodell .

Übergeordnete Schnittstellen:

Extends: Office.Appointment

Eigenschaften

body	Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
end	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 Serie zu aktualisieren.
itemType	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.
location	Ruft den Ort eines Termins ab bzw. legt ihn fest. Die `location` -Eigenschaft gibt ein Location-Objekt zurück, das Methoden bereitstellt, die zum Abrufen und Festlegen der Position des Termins verwendet werden.
optionalAttendees	Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Typ des Objekts 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 (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
requiredAttendees	Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Typ des Objekts 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 (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .
start	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.
subject	Ruft die Beschreibung ab, die im Betrefffeld eines Elements angezeigt wird, oder legt sie fest. Die `subject`-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird. Die `subject`-Eigenschaft gibt ein `Subject`-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

Methoden

addFileAttachmentAsync(uri, attachmentName, options, callback)	Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die `addFileAttachmentAsync`-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
addFileAttachmentAsync(uri, attachmentName, callback)	Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu. Die `addFileAttachmentAsync`-Methode lädt die Datei am angegebenen URI hoch und fügt sie an das Element im Verfassenformular an.
addItemAttachmentAsync(itemId, attachmentName, options, callback)	Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die `addItemAttachmentAsync` -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, `asyncResult`der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den `options` -Parameter verwenden, um bei Bedarf Zustandsinformationen 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 in neuem Outlook unter Windows ausgeführt wird, kann die `addItemAttachmentAsync` Methode Elemente an andere Elemente als das element anfügen, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
addItemAttachmentAsync(itemId, attachmentName, callback)	Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu. Die `addItemAttachmentAsync` -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, `asyncResult`der entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den `options` -Parameter verwenden, um bei Bedarf Zustandsinformationen 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 in neuem Outlook unter Windows ausgeführt wird, kann die `addItemAttachmentAsync` Methode Elemente an andere Elemente als das element anfügen, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.
getSelectedDataAsync(coercionType, options, callback)	Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück. Wenn keine Auswahl vorhanden ist, sich aber der Cursor 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. Rufen `asyncResult.value.data`Sie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die `source` Eigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie `asyncResult.value.sourceProperty`auf, wobei entweder `body` oder ist `subject`.
getSelectedDataAsync(coercionType, callback)	Gibt asynchron ausgewählte Daten aus dem Betreff oder Textkörper einer Nachricht zurück. Wenn keine Auswahl vorhanden ist, sich aber der Cursor 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. Rufen `asyncResult.value.data`Sie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die `source` Eigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie `asyncResult.value.sourceProperty`auf, wobei entweder `body` oder ist `subject`.
loadCustomPropertiesAsync(callback, userContext)	Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element. Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und 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 für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte. Die benutzerdefinierten Eigenschaften werden als `CustomProperties`-Objekt in der `asyncResult.value`-Eigenschaft bereitgestellt. Dieses Objekt kann verwendet werden, um benutzerdefinierte Eigenschaften aus dem E-Mail-Element abzurufen, festzulegen, zu speichern und zu entfernen.
removeAttachmentAsync(attachmentId, options, callback)	Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die `removeAttachmentAsync`-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web, auf mobilen Geräten und in neuen Outlook unter Windows ist die Anlage-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
removeAttachmentAsync(attachmentId, callback)	Entfernt eine Anlage aus einer Nachricht oder einem Termin. Die `removeAttachmentAsync`-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web, auf mobilen Geräten und in neuen Outlook unter Windows ist die Anlage-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.
setSelectedDataAsync(data, options, callback)	Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein. Die `setSelectedDataAsync` -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.
setSelectedDataAsync(data, callback)	Fügt asynchron Daten in den Textkörper oder Betreff einer Nachricht ein. Die `setSelectedDataAsync` -Methode fügt die angegebene Zeichenfolge an der Cursorposition im Betreff oder Textkörper des Elements ein oder ersetzt, wenn Text im Editor ausgewählt ist, den markierten Text. Wenn sich der Cursor nicht im Text- oder Betrefffeld befindet, wird ein Fehler zurückgegeben. Nach dem Einfügen wird der Cursor am Ende des eingefügten Inhalts platziert.

Details zur Eigenschaft

body

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

body: Body;

Eigenschaftswert

Office.Body

Hinweise

[ API-Satz: Postfach 1.1 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

end

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 Serie zu aktualisieren.

end: Time;

Eigenschaftswert

Office.Time

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("End Time " + result.asyncContext.verb);
    }
});

// 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;
  }
  console.log(`Appointment ends: ${result.value}`);
});

...

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

itemType

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

Office.MailboxEnums.ItemType | string

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

location

Ruft den Ort eines Termins ab bzw. legt ihn fest. Die location -Eigenschaft gibt ein Location-Objekt zurück, das Methoden bereitstellt, die zum Abrufen und Festlegen der Position des Termins verwendet werden.

location: Location;

Eigenschaftswert

Office.Location

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

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

optionalAttendees

Bietet Zugriff auf die optionalen Teilnehmer eines Ereignisses. Der Typ des Objekts 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 (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

optionalAttendees: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}

// 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 = $("#emailOptional")
  .val()
  .toString();
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);
  }
});

requiredAttendees

Bietet Zugriff auf die erforderlichen Teilnehmer eines Ereignisses. Der Typ des Objekts 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 (z. B. Windows, Mac usw.) gelten jedoch Grenzwerte für die Anzahl der Empfänger, die Sie abrufen oder aktualisieren können. Weitere Informationen finden Sie im Recipients-Objekt .

requiredAttendees: Recipients;

Eigenschaftswert

Office.Recipients

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfRequiredAttendeesRecipients = asyncResult.value;
    console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}

// 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 = $("#emailRequired")
  .val()
  .toString();
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);
  }
});

start

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

Office.Time

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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;
  }
  console.log(`Appointment starts: ${result.value}`);
});

...

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

subject

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

Die subject-Eigenschaft ruft den gesamten Betreff des Elements ab oder legt ihn fest – so, wie er vom E-Mail-Server gesendet wird.

Die subject-Eigenschaft gibt ein Subject-Objekt zurück, das Methoden zum Abrufen und Festlegen des Betreffs bereitstellt.

subject: Subject;

Eigenschaftswert

Office.Subject

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

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

Details zur Methode

addFileAttachmentAsync(uri, attachmentName, options, callback)

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

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

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

Parameter

uri: string

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

attachmentName: string

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

options: Office.AsyncContextOptions & { isInline: boolean }

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. isInline : Wenn true, gibt an, dass die Anlage inline als Bild im Nachrichtentext angezeigt wird und nicht in der Anlageliste angezeigt wird.

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

In den letzten Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
Der URI der datei, die angefügt werden soll, muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, auf dem das Image gehostet wird, sollte keinen Header zurückgebenCache-Control, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibtno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann das Zwischenspeichern verhindern, dass Sie Ihre Änderungen sehen. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .
Sie können denselben 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 verfügt über eine Erweiterung, die nicht zulässig ist.
NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

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

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

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

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

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

Parameter

uri: string

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

attachmentName: string

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig:

In den letzten Builds des klassischen Outlook unter Windows wurde ein Fehler eingeführt, der fälschlicherweise einen Authorization: Bearer Header an diese Aktion anhängt (unabhängig davon, ob diese API oder die Outlook-Benutzeroberfläche verwendet wird). Um dieses Problem zu umgehen, können Sie versuchen, die API zu verwenden, die addFileAttachmentFromBase64 mit dem Anforderungssatz 1.8 eingeführt wurde.
Der URI der datei, die angefügt werden soll, muss die Zwischenspeicherung in der Produktion unterstützen. Der Server, auf dem das Image gehostet wird, sollte keinen Header zurückgebenCache-Control, der , no-storeoder ähnliche Optionen in der HTTP-Antwort angibtno-cache. Wenn Sie jedoch das Add-In entwickeln und Änderungen an Dateien vornehmen, kann das Zwischenspeichern verhindern, dass Sie Ihre Änderungen sehen. Es wird empfohlen, Header während der Entwicklung zu verwenden Cache-Control .
Sie können denselben 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 verfügt über eine Erweiterung, die nicht zulässig ist.
NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

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

Die addItemAttachmentAsync -Methode fügt das Element mit dem angegebenen Exchange-Bezeichner an das Element im Verfassenformular an. Wenn Sie eine Rückruffunktion angeben, wird die Methode mit einem Parameter aufgerufen, asyncResultder entweder den Anlagenbezeichner oder einen Code enthält, der einen Fehler angibt, der beim Anfügen des Elements aufgetreten ist. Sie können den options -Parameter verwenden, um bei Bedarf Zustandsinformationen 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 in neuem Outlook unter Windows ausgeführt wird, kann die addItemAttachmentAsync Methode Elemente an andere Elemente als das element anfügen, das Sie gerade bearbeiten. Dies wird jedoch nicht unterstützt und nicht empfohlen.

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

Parameter

itemId: any

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

attachmentName: string

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

options: Office.AsyncContextOptions

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

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

Beispiele

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

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

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

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

addItemAttachmentAsync(itemId, attachmentName, callback)

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

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

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

Parameter

itemId: any

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

attachmentName: string

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

NumberOfAttachmentsExceeded : Die Nachricht oder der Termin weist zu viele Anlagen auf.

getSelectedDataAsync(coercionType, options, callback)

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

Wenn keine Auswahl vorhanden ist, sich aber der Cursor 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.

Rufen asyncResult.value.dataSie auf, um über die Rückruffunktion auf die ausgewählten Daten zuzugreifen. Um auf die source Eigenschaft zuzugreifen, von der die Auswahl stammt, rufen Sie asyncResult.value.sourcePropertyauf, wobei entweder body oder ist subject.

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

Parameter

coercionType: Office.CoercionType | string

Fordert ein Format für die Daten an. Wenn Text, gibt die Methode den Nur-Text als Zeichenfolge zurück und entfernt alle vorhandenen HTML-Tags. Gibt HTMLdie Methode den markierten Text zurück, unabhängig davon, ob es sich um Klartext oder HTML handelt.

options: Office.AsyncContextOptions

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

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

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

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

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

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

getSelectedDataAsync(coercionType, callback)

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

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

Parameter

coercionType: Office.CoercionType | string

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

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

Gibt zurück

void

Die ausgewählten Daten als Zeichenfolge, deren Format durch bestimmt wird coercionType.

Hinweise

[ API-Satz: Postfach 1.2 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

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

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

loadCustomPropertiesAsync(callback, userContext)

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

Benutzerdefinierte Eigenschaften werden als Schlüssel-Wert-Paare pro App und 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 für das Element nicht verschlüsselt, sodass dies nicht als sicherer Speicher verwendet werden sollte.

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

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

Parameter

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

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

userContext: any

Optional. Entwickler können ein beliebiges Objekt bereitstellen, auf das sie in der Callbackfunktion zugreifen möchten. Der Zugriff auf dieses Objekt kann über die asyncResult.asyncContext-Eigenschaft in der Callbackfunktion erfolgen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

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

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Terminplaner

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

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

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

Die removeAttachmentAsync-Methode entfernt die Anlage mit dem angegebenen Bezeichner aus dem Element. Als bewährte Vorgehensweise sollten Sie den Anlagenbezeichner nur dann zum Entfernen einer Anlage verwenden, wenn die gleiche Mail-App die Anlage in der gleichen Sitzung hinzugefügt hat. In Outlook im Web, auf mobilen Geräten und in neuen Outlook unter Windows ist die Anlage-ID nur innerhalb derselben Sitzung gültig. Eine Sitzung ist beendet, wenn der Benutzer die App schließt, oder wenn der Benutzer mit der Erstellung eines Inlineformulars beginnt, dann wird das Formular anschließend eingeblendt, um in einem separaten Fenster fortzufahren.

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

Parameter

attachmentId: string

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

options: Office.AsyncContextOptions

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

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Wichtig*: Die removeAttachmentAsync -Methode entfernt keine Inlineanlagen aus einem E-Mail-Element. Um eine Inlineanlage zu entfernen, rufen Sie zuerst den Text des Elements ab, und entfernen Sie dann alle Verweise der Anlage aus ihrem 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(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Entfernt eine Anlage aus einer Nachricht oder einem Termin.

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

Parameter

attachmentId: string

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

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.1 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

setSelectedDataAsync(data, options, callback)

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

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

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

Parameter

data: string

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

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten. coercionType : Bei Text wird die aktuelle Formatvorlage in Outlook im Web, unter Windows (neu und klassisch) und unter Mac angewendet. Wenn das Feld ein HTML-Editor ist, werden nur die Textdaten eingefügt, selbst wenn es sich bei den Daten um HTML-Daten handelt. Wenn es sich bei den Daten um HTML handelt und das Feld HTML unterstützt (der Betreff nicht), wird die aktuelle Formatvorlage in Outlook im Web und dem neuen Outlook unter Windows angewendet. Der Standardstil wird in Outlook unter Windows (klassisch) und auf Mac angewendet. Ist das Feld ein Textfeld, wird ein Fehler des Typs InvalidDataFormat zurückgegeben. Wenn coercionType nicht festgelegt wird, hängt das Ergebnis vom Feld ab: Wenn das Feld HTML ist, wird HTML verwendet. Wenn das Feld Text ist, wird Nur-Text verwendet.

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Beispiele

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

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

setSelectedDataAsync(data, callback)

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

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

Parameter

data: string

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

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

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

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.2 ]

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Terminplaner

Fehler:

InvalidAttachmentId : Der Anlagenbezeichner ist nicht vorhanden.

Freigeben über

Office.AppointmentCompose interface

Eigenschaften

Methoden

Details zur Eigenschaft

body

Eigenschaftswert

Hinweise

Beispiele

end

Eigenschaftswert

Hinweise

Beispiele

itemType

Eigenschaftswert

Hinweise

Beispiele

location

Eigenschaftswert

Hinweise

Beispiele

optionalAttendees

Eigenschaftswert

Hinweise

Beispiele

requiredAttendees

Eigenschaftswert

Hinweise

Beispiele

start

Eigenschaftswert

Hinweise

Beispiele

subject

Eigenschaftswert

Hinweise

Beispiele

Details zur Methode

addFileAttachmentAsync(uri, attachmentName, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addFileAttachmentAsync(uri, attachmentName, callback)

Parameter

Gibt zurück

Hinweise

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

addItemAttachmentAsync(itemId, attachmentName, callback)

Parameter

Gibt zurück

Hinweise

getSelectedDataAsync(coercionType, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

getSelectedDataAsync(coercionType, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

loadCustomPropertiesAsync(callback, userContext)

Parameter

Gibt zurück

Hinweise

Beispiele

removeAttachmentAsync(attachmentId, options, callback)

Parameter

Gibt zurück

Hinweise

Beispiele

removeAttachmentAsync(attachmentId, callback)

Parameter

Gibt zurück

Hinweise