Outlook-Add-In-API-Anforderungssatz 1.1

Die Outlook-Add-In-API-Teilmenge der Office JavaScript-API enthält Objekte, Methoden, Eigenschaften und Ereignisse, die Sie in einem Outlook-Add-In verwenden können. Outlook JavaScript-API 1.1 (Mailbox 1.1) ist die erste Version der API.

Hinweis

Diese Dokumentation bezieht sich auf einen anderen Anforderungssatz als den aktuellen.

Neuigkeiten in 1.1

Postfachanforderungssatz 1.1 enthält alle gängigen API-Anforderungssätze , die in Outlook unterstützt werden. Zusätzlich wurden die folgenden Funktionen implementiert.

API-Liste

In der folgenden Tabelle sind die APIs aufgeführt, die im Postfach-Anforderungssatz 1.1 eingeführt wurden. Die API-Referenzdokumentation für alle APIs, die vom Postfachanforderungssatz 1.1 unterstützt werden, finden Sie unter Outlook-APIs.

Klasse Felder Beschreibung
AppointmentCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
Text Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
location Ruft den Ort eines Termins ab bzw. legt ihn fest.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Anlage aus einer Nachricht oder einem Termin.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Anlage aus einer Nachricht oder einem Termin.
AppointmentForm Text Legt den Text des Termins fest.
end Legt das Datum und die Uhrzeit fest, zu dem der Termin enden soll.
location Legt den Ort des Termins fest.
optionalAttendees Legt die optionalen Teilnehmer des Termins fest.
requiredAttendees Legt die erforderlichen Teilnehmer des Termins fest.
Ressourcen Legt die Ressourcen des Termins fest.
start Legt das Datum und die Uhrzeit fest, zu der der Termin beginnen soll.
Betreff Legt die Beschreibung fest, die im Titelfeld des Termins angezeigt wird.
AppointmentRead Text Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
dateTimeModified Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.
displayReplyAllForm(formData: string | ReplyFormData) Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des
displayReplyForm(formData: string | ReplyFormData) Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
getEntities() Ruft die Entitäten im Text des ausgewählten Elements ab.
getEntitiesByType(entityType: MailboxEnums.EntityType | string) Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind.
getFilteredEntitiesByName(name: string) Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter erfüllen, der in einer Manifestdatei nur für Add-Ins definiert ist.
getRegExMatches() Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer Manifestdatei nur für Add-Ins definiert sind.
getRegExMatchesByName(name: string) Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer Manifestdatei nur für Add-Ins definiert ist.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
location Ruft den Ort eines Termins ab.
AttachmentDetails attachmentType Ruft einen Wert ab, der den Typ der Anlage angibt.
contentType Ruft den MIME-Inhaltstyp der Anlage ab.
id Ruft die Exchange-Anlagen-ID der Anlage ab.
isInline Ruft einen Wert ab, der angibt, ob die Anlage als Bild im Textkörper des Elements und nicht in der Liste der Anlagen angezeigt wird.
name Ruft den Namen der Anlage ab.
size Ruft die Größe der Anlage in Byte ab.
Body getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.
getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) Ruft einen Wert ab, der angibt, ob der Inhalt HTML- oder Textformat aufweist.
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.
prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt den angegebenen Inhalt am Anfang des Elementkörpers hinzu.
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt die Auswahl im Textkörper mit dem angegebenen Text.
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt die Auswahl im Textkörper mit dem angegebenen Text.
CustomProperties get(name: string) Gibt den Wert der angegebenen benutzerdefinierten Eigenschaft zurück.
remove(name: string) Entfernt die angegebene Eigenschaft aus der Auflistung benutzerdefinierter Eigenschaften.
saveAsync(asyncContext?: any) Speichert benutzerdefinierte Eigenschaften in einer Nachricht oder einem Termin.
saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any) Speichert benutzerdefinierte Eigenschaften in einer Nachricht oder einem Termin.
set(name: string, value: string) Legt die angegebene Eigenschaft auf den angegebenen Wert fest.
Diagnose OWAView Ruft eine Zeichenfolge ab, die die aktuelle Ansicht von Outlook im Web darstellt.
hostName Ruft eine Zeichenfolge ab, die den Typ des Outlook-Clients darstellt.
hostVersion Ruft eine Zeichenfolge ab, die die Version des Outlook-Clients oder des Exchange Server angibt (z. B. "15.0.468.0").
Location getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft den Ort eines Termins ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft den Ort eines Termins ab.
setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt den Ort eines Termins fest.
setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt den Ort eines Termins fest.
Postfach displayAppointmentForm(itemId: string) Zeigt einen bestehenden Kalendertermin an.
displayMessageForm(itemId: string) Zeigt eine vorhandene Nachricht an.
displayNewAppointmentForm(Parameter: AppointmentForm) Zeigt ein Formular zum Erstellen eines neuen Kalendertermins an.
ewsUrl Ruft die URL des EWS-Endpunkts (Exchange-Webdienste) für dieses E-Mail-Konto ab.
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any) Sendet eine asynchrone Anforderung an einen Exchange-Webdienstedienst (EWS) auf dem Exchange-Server, der das Postfach des Benutzers hostet.
MessageCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt eine Datei zu einer Nachricht oder einem Termin als Anlage hinzu.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) Fügt der Nachricht oder dem Termin ein Exchange-Objekt, wie z. B. eine Nachricht, als Anhang hinzu.
bcc Ruft ein Objekt ab, das Methoden bereitstellt, um die Empfänger in der Bcc-Zeile (Blind Carbon Copy) einer Nachricht abzurufen oder zu aktualisieren.
Text Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Anlage aus einer Nachricht oder einem Termin.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Anlage aus einer Nachricht oder einem Termin.
MessageRead Text Ruft ein Objekt ab, das Methoden zum Bearbeiten des Textkörpers eines Elements bereitstellt.
dateTimeModified Ruft das Datum und die Uhrzeit der letzten Änderung eines Elements ab.
displayReplyAllForm(formData: string | ReplyFormData) Zeigt ein Antwortformular an, das entweder den Absender und alle Empfänger der ausgewählten Nachricht oder den Organisator und alle Teilnehmer des
displayReplyForm(formData: string | ReplyFormData) Zeigt ein Antwortformular an, das nur den Absender der ausgewählten Nachricht oder den Organisator des ausgewählten Termins enthält.
getEntities() Ruft die Entitäten im Text des ausgewählten Elements ab.
getEntitiesByType(entityType: MailboxEnums.EntityType | string) Ruft ein Array aller Entitäten des angegebenen Typs ab, die im Texts des ausgewählten Elements enthalten sind.
getFilteredEntitiesByName(name: string) Gibt bekannte Entitäten im ausgewählten Element zurück, die den benannten Filter erfüllen, der in einer Manifestdatei nur für Add-Ins definiert ist.
getRegExMatches() Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die den regulären Ausdrücken entsprechen, die in einer Manifestdatei nur für Add-Ins definiert sind.
getRegExMatchesByName(name: string) Gibt Zeichenfolgenwerte im ausgewählten Element zurück, die dem benannten regulären Ausdruck entsprechen, der in einer Manifestdatei nur für Add-Ins definiert ist.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) Lädt asynchron benutzerdefinierte Eigenschaften für dieses Add-In für das ausgewählte Element.
AttachmentType Cloud Die Anlage wird an einem Cloudspeicherort gespeichert, z. B. auf OneDrive.
File Bei der Anlage handelt es sich um eine Datei.
Element Bei der Anlage handelt es sich um ein Exchange-Element.
RecipientType DistributionList Gibt an, dass der Empfänger eine Verteilerliste ist, die eine Liste von E-Mail-Adressen enthält.
ExternalUser Gibt an, dass es sich bei dem Empfänger um eine SMTP-E-Mail-Adresse handelt, die sich nicht auf dem Exchange-Server befindet.
Andere Gibt an, dass der Empfänger keiner der anderen Empfängertypen ist.
Benutzer Gibt an, dass der Empfänger eine SMTP-E-Mail-Adresse auf dem Exchange-Server ist.
Empfänger addAsync(recipients: Arrayzeichenfolge<| EmailUser | EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt einen Liste der Empfänger den vorhandenen Empfängern für einen Termin oder eine Nachricht hinzu.
addAsync(recipients: Arrayzeichenfolge<| EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt einen Liste der Empfänger den vorhandenen Empfängern für einen Termin oder eine Nachricht hinzu.
getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) Ruft eine Empfängerliste für einen Termin oder eine Nachricht ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) Ruft eine Empfängerliste für einen Termin oder eine Nachricht ab.
setAsync(recipients: Arrayzeichenfolge<| EmailUser | EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void) Legt eine Empfängerliste für einen Termin oder eine Nachricht fest.
setAsync(recipients: Arrayzeichenfolge<| EmailUser | EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void) Legt eine Empfängerliste für einen Termin oder eine Nachricht fest.
ReplyFormAttachment inLine Wenn true, bedeutet dies, dass die Anlage inline im Nachrichtentext angezeigt wird und nicht in der Anlagenliste angezeigt werden sollte.
itemId Die EWS-Element-ID der Anlage.
name Eine Zeichenfolge, die den Namen der Anlage mit bis zu 255 Zeichen enthält.
type Gibt den Typ der Anlage an.
url Der URI des Speicherorts für die Datei.
ReplyFormData callback Wenn der Antwortanzeigeaufruf abgeschlossen ist, wird die im Rückrufparameter übergebene Funktion mit einem einzelnen Parameter aufgerufen.
htmlBody Eine Zeichenfolge, die Text- und HTML-Code enthält, die den Hauptteil des Antwortformulars darstellen.
options Ein Objektliteral, das die asyncContext Eigenschaft enthält.
RoamingSettings get(name: string) Ruft die angegebene Einstellung ab.
remove(name: string) Entfernt die angegebene Einstellung.
saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) Speichert die Einstellungen.
set(name: string, value: any) Legt die angegebene Einstellung fest oder erstellt sie.
Subject getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft den Betreff eines Termins oder einer Nachricht ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Ruft den Betreff eines Termins oder einer Nachricht ab.
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt den Betreff eines Termins oder einer Nachricht fest.
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt den Betreff eines Termins oder einer Nachricht fest.
Time getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void) Ruft die Start- oder Endzeit eines Termins ab.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void) Ruft die Start- oder Endzeit eines Termins ab.
setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt die Start- oder Endzeit eines Termins fest.
setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Legt die Start- oder Endzeit eines Termins fest.

Siehe auch

  • Last updated on