Freigeben über


outlook package

Schnittstellen

Office.Appointment

Die Unterklasse von Item , die sich mit Terminen befasst.

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 .

Untergeordnete Schnittstellen:

Office.AppointmentCompose

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:

Office.AppointmentForm

Das AppointmentForm -Objekt wird verwendet, um auf den aktuell ausgewählten Termin zuzugreifen.

Office.AppointmentRead

Der Terminteilnehmermodus 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:

Office.AttachmentDetails

Stellt eine Anlage zu einem Element vom Server dar. Nur im Lesemodus.

Ein Array von AttachmentDetails -Objekten wird als - attachments Eigenschaft eines Termin- oder Nachrichtenelements zurückgegeben.

Office.Body

Das body-Objekt stellt Methoden zum Hinzufügen und Aktualisieren des Inhalts der Nachricht oder des Termins bereit. Es wird in der body-Eigenschaft des ausgewählten Elements zurückgegeben.

Office.CoercionTypeOptions

Stellt eine Option für das Datenformat bereit.

Office.Contact

Stellt die Details zu einem Kontakt dar (ähnlich wie bei einem physischen Kontakt oder Karte), die aus dem Text des Elements extrahiert wurden. Nur im Lesemodus.

Die Liste der Kontakte, die aus dem Textkörper einer E-Mail-Nachricht oder eines Termins extrahiert wurden, wird in der contacts -Eigenschaft des Entities-Objekts zurückgegeben, das von der - oder getEntitiesByType -getEntitiesMethode des aktuellen Elements zurückgegeben wird.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.CustomProperties

Das CustomProperties -Objekt stellt benutzerdefinierte Eigenschaften dar, die für ein bestimmtes E-Mail-Element und für ein Outlook-Add-In spezifisch sind. Beispielsweise kann ein Add-In erforderlich sein, um einige Daten zu speichern, die für die aktuelle Nachricht spezifisch sind, die das Add-In aktiviert hat. Wenn der Benutzer die gleiche Nachricht in Zukunft erneut abruft und das Add-In erneut aktiviert, kann das Add-In die Daten abrufen, die als benutzerdefinierte Eigenschaften gespeichert wurden.

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

Office.Diagnostics

Stellt einem Outlook-Add-In Diagnoseinformationen bereit.

Office.EmailAddressDetails

Stellt die E-Mail-Eigenschaften des Absenders oder angegebener Empfänger einer E-Mail-Nachricht oder eines Termins bereit.

Office.EmailUser

Stellt ein E-Mail-Konto auf einem Exchange-Server dar.

Office.Entities

Stellt eine Sammlung von in einer E-Mail-Nachricht oder einem Termin gefundenen Entitäten dar. Nur Lesemodus.

Das Entities -Objekt ist ein Container für die Entitätsarrays, die von den getEntities Methoden und getEntitiesByType zurückgegeben werden, wenn das Element (entweder eine E-Mail-Nachricht oder ein Termin) eine oder mehrere Entitäten enthält, die vom Server gefunden wurden. Sie können diese Entitäten im Code verwenden, um zusätzliche Kontextinformationen für den Betrachter bereitzustellen, z. B. eine Karte für eine im Element gefundene Adresse anzeigen oder ein Wählprogramm für eine Telefonnummer im Element öffnen.

Wenn keine Entitäten des in der Eigenschaft angegebenen Typs im Element vorhanden sind, lautet die dieser Entität zugeordnete Eigenschaft null. Wenn eine Nachricht z. B. eine Adresse und eine Telefonnummer enthält, enthalten die addresses-Eigenschaft und die phoneNumbers-Eigenschaft Informationen, und die anderen Eigenschaften sind null.

Damit eine Zeichenfolge als Adresse erkannt wird, muss sie eine US-Postadresse enthalten, die mindestens einen Teilsatz der Elemente Straßennummer, Straßenname, Stadt, Staat und Postleitzahl enthält.

Damit die Zeichenfolge als Telefonnummer erkannt wird, muss die Zeichenfolge ein nordamerikanisches Telefonnummernformat enthalten.

Die Entitätserkennung beruht auf der Erkennung von natürlicher Sprache, die auf großen, maschinell eingelernten Datenmengen basiert. Die Erkennung einer Entität ist nichtdeterministisch und der Erfolg hängt in einigen Fällen vom jeweiligen Kontext in einem Element ab.

Wenn die Eigenschaftenarrays von der getEntitiesByType -Methode zurückgegeben werden, enthält nur die -Eigenschaft für die angegebene Entität Daten; alle anderen Eigenschaften sind NULL.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.Item

Der Elementnamespace wird verwendet, um auf die aktuell ausgewählte Nachricht, Besprechungsanfrage oder den Aktuell ausgewählten Termin zuzugreifen. Sie können den Typ des Elements mithilfe der itemType -Eigenschaft bestimmen.

Die vollständige Elementliste finden Sie auf der Seite Objektmodell .

Wenn IntelliSense nur für einen bestimmten Typ oder Modus angezeigt werden soll, wandeln Sie dieses Element in eine der folgenden Elemente um:

Office.ItemCompose

Der Verfassenmodus 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 .

Untergeordnete Schnittstellen:

Office.ItemRead

Der Lesemodus 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 .

Untergeordnete Schnittstellen:

Office.LocalClientTime

Stellt ein Datum und eine Uhrzeit in der lokalen Zeitzone des Clients dar. Nur im Lesemodus.

Office.Location

Bietet Methoden zum Abrufen und Festlegen des Orts einer Besprechung in einem Outlook-Add-In.

Office.Mailbox

Bietet Zugriff auf das Microsoft Outlook-Add-In-Objektmodell.

Wichtige Eigenschaften:

  • diagnostics : Stellt Diagnoseinformationen für ein Outlook-Add-In bereit.

  • item : Stellt Methoden und Eigenschaften für den Zugriff auf eine Nachricht oder einen Termin in einem Outlook-Add-In bereit.

  • userProfile : Stellt Informationen zum Benutzer in einem Outlook-Add-In bereit.

Office.MeetingSuggestion

Stellt eine vorgeschlagene Besprechung dar, die in einem Element gefunden wurde. Nur im Lesemodus.

Die Liste der in einer E-Mail-Nachricht vorgeschlagenen Besprechungen wird in der meetingSuggestions -Eigenschaft des Entities -Objekts zurückgegeben, das zurückgegeben wird, wenn die - oder getEntitiesByType -getEntitiesMethode für das aktive Element aufgerufen wird.

Die Anfangs- und Endwerte sind Zeichenfolgendarstellungen eines Date Objekts, das das Datum und die Uhrzeit enthält, an dem die vorgeschlagene Besprechung beginnen und enden soll. Die Werte befinden sich in der Standardzeitzone, die für den aktuellen Benutzer angegeben ist.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.Message

Eine Unterklasse von Item für Nachrichten.

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 .

Untergeordnete Schnittstellen:

Office.MessageCompose

Der Nachrichtenerstellungsmodus 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 .

  • Beachten Sie beim Aufrufen Office.context.mailbox.item einer Nachricht, dass der Lesebereich im Outlook-Client aktiviert sein muss. Eine Anleitung zum Konfigurieren des Lesebereichs finden Sie unter Verwenden und Konfigurieren des Lesebereichs für die Vorschau von Nachrichten.

Übergeordnete Schnittstellen:

Office.MessageRead

Der Nachrichtenlesemodus 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 .

  • Beachten Sie beim Aufrufen Office.context.mailbox.item einer Nachricht, dass der Lesebereich im Outlook-Client aktiviert sein muss. Eine Anleitung zum Konfigurieren des Lesebereichs finden Sie unter Verwenden und Konfigurieren des Lesebereichs für die Vorschau von Nachrichten.

Übergeordnete Schnittstellen:

Office.NotificationMessageDetails

Ein Array mit NotificationMessageDetails-Objekten wird von der NotificationMessages.getAllAsync-Methode zurückgegeben.

Office.NotificationMessages

Das NotificationMessages-Objekt wird als notificationMessages-Eigenschaft eines Elements zurückgegeben.

Office.PhoneNumber

Stellt eine in einem Element erkannte Telefonnummer dar. Nur im Lesemodus.

Ein Array von PhoneNumber -Objekten, die die in einer E-Mail-Nachricht gefundenen Telefonnummern enthalten, wird in der phoneNumbers -Eigenschaft des Entities Objekts zurückgegeben, das zurückgegeben wird, wenn Sie die getEntities -Methode für das ausgewählte Element aufrufen.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.Recipients

Stellt Empfänger eines Elements dar. Nur im Verfassen-Modus.

Office.ReplyFormAttachment

Eine Datei- oder Elementanlage. Wird beim Anzeigen eines Antwortformulars verwendet.

Office.ReplyFormData

Ein ReplyFormData-Objekt, das Text- oder Anlagendaten und eine Rückruffunktion enthält. Wird beim Anzeigen eines Antwortformulars verwendet.

Office.RoamingSettings

Die Einstellungen, die mit den Methoden des RoamingSettings-Objekts erstellt werden, werden pro Add-In und pro Benutzer gespeichert. Das heißt, sie sind nur für das Add-In verfügbar, das sie erstellt hat, und nur aus dem Postfach des Benutzers, in dem sie gespeichert sind.

Obwohl die Outlook-Add-In-API den Zugriff auf diese Einstellungen nur auf das Add-In beschränkt, das sie erstellt hat, sollten diese Einstellungen nicht als sicherer Speicher betrachtet werden. Auf sie kann über Exchange-Webdienste oder erweiterte MAPI zugegriffen werden. Sie sollten nicht zum Speichern vertraulicher Informationen wie Benutzeranmeldeinformationen oder Sicherheitstoken verwendet werden.

Der Name einer Einstellung ist eine Zeichenfolge, während der Wert vom Typ „string“, „number“, „boolean“, „null“, „object“ oder „array“ sein kann.

Der Zugriff auf das RoamingSettings-Objekt erfolgt über die roamingSettings-Eigenschaft im Office.context-Namespace.

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

Office.Subject

Bietet Methoden zum Abrufen und Festlegen des Betreffs eines Termins oder einer Nachricht in einem Outlook-Add-In.

Office.TaskSuggestion

Stellt eine in einem Element erkannte vorgeschlagene Aufgabe dar. Nur im Lesemodus.

Die Liste der in einer E-Mail-Nachricht vorgeschlagenen Aufgaben wird in der taskSuggestions -Eigenschaft des Entities-Objekts zurückgegeben, das zurückgegeben wird, wenn die - oder getEntitiesByType -getEntitiesMethode für das aktive Element aufgerufen wird.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.Time

Das Time -Objekt wird als Start- oder Endeigenschaft eines Termins im Verfassenmodus zurückgegeben.

Office.UserProfile

Informationen zum Benutzer, der dem Postfach zugeordnet ist. Dies umfasst den Kontotyp, den Anzeigenamen, die E-Mail-Adresse und die Zeitzone.

Enumerationen

Office.MailboxEnums.AttachmentType

Gibt den Typ der Anlage an.

Office.MailboxEnums.EntityType

Gibt einen Entitätstyp an.

Warnung: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden jetzt eingestellt. Regeln für reguläre Ausdrücke werden jedoch weiterhin unterstützt. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Eine Anleitung zum Implementieren dieser Regeln finden Sie unter Kontextbezogene Outlook-Add-Ins.

Office.MailboxEnums.ItemNotificationMessageType

Gibt den Benachrichtigungstyp für eine Nachricht oder einen Termin an.

Office.MailboxEnums.ItemType

Gibt einen Elementtyp an.

Office.MailboxEnums.OpenLocation

Gibt den Speicherort an, von dem aus ein Add-In auf Daten zugreifen möchte.

Office.MailboxEnums.OWAView

Stellt die aktuelle Ansicht von Outlook im Web dar.

Office.MailboxEnums.RecipientType

Gibt den Typ des Empfängers einer Nachricht oder eines Termins an.

Office.MailboxEnums.ResponseType

Gibt den Typ der Antwort auf eine Besprechungseinladung an.

Office.MailboxEnums.RestVersion

Gibt die Version der REST-API an, die einer für REST formatierten Element-ID entspricht.

Office.MailboxEnums.SaveLocation

Gibt den Speicherort an, an dem ein Add-In Daten speichern möchte.

Office.MailboxEnums.SourceProperty

Gibt die Quelle der ausgewählten Daten in einem Element an (weitere Informationen finden Sie unter Office.mailbox.item.getSelectedDataAsync ).