outlook package

Schnittstellen

Office.Appointment

Die Unterklasse des Elements, das mit Terminen zu tun hat.

Wichtig: Dies ist ein internes Outlook Objekt, das nicht direkt über vorhandene Schnittstellen verfügbar gemacht wird. Sie sollten dies als Einen Modus von 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 Einen Modus von 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 Einen Modus von Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite "Objektmodell".

Übergeordnete Schnittstellen:

Office.AppointmentTimeChangedEventArgs

Stellt die aktuellen Datums- und Uhrzeitangaben des Termins bereit, der das Ereignis ausgelöst Office.EventType.AppointmentTimeChanged hat.

Office.AttachmentContent

Stellt den Inhalt einer Anlage für eine Nachricht oder ein Terminelement dar.

Office.AttachmentDetails

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

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

Office.AttachmentDetailsCompose

Stellt eine Anlage für ein Element dar. Nur im Verfassen-Modus.

Ein Array von AttachmentDetailsCompose Objekten wird als Anlageneigenschaft eines Termin- oder Nachrichtenelements zurückgegeben.

Office.AttachmentsChangedEventArgs

Stellt Informationen zu den Anlagen bereit, die das Ereignis ausgelöst Office.EventType.AttachmentsChanged haben.

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

Stellt die Kategorien für ein Element dar.

In Outlook kann ein Benutzer Nachrichten und Termine mithilfe einer Kategorie markieren, um sie farbcodieren zu können. Der Benutzer definiert Kategorien in einer Masterliste für sein Postfach. Anschließend können beliebig viele Kategorien auf ein Element angewendet werden.

Wichtig: In Outlook im Web können Sie die API nicht verwenden, um Kategorien zu verwalten, die auf eine Nachricht im Verfassenmodus angewendet werden.

Office.CategoryDetails

Stellt details wie Name und zugeordnete Farbe einer Kategorie dar.

Office.CoercionTypeOptions

Stellt eine Option für das Datenformat bereit.

Office.Contact

Stellt die Details zu einem Kontakt (ähnlich wie auf einem physischen Kontakt oder einer Visitenkarte) dar, die aus dem Textkörper 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 Eigenschaft des Entities-Objekts zurückgegeben, das von der or-Methode des aktuellen contacts Elements zurückgegeben getEntities getEntitiesByType wird.

Office.CustomProperties

Das CustomProperties Objekt stellt benutzerdefinierte Eigenschaften dar, die für ein bestimmtes Element und für ein Mail-Add-In für Outlook spezifisch sind. Beispielsweise kann es erforderlich sein, dass ein Mail-Add-In einige Daten speichert, die für die aktuelle E-Mail-Nachricht spezifisch sind, die das Add-In aktiviert hat. Wenn der Benutzer in Zukunft dieselbe Nachricht erneut anzeigt und das Mail-Add-In erneut aktiviert, kann das Add-In die Daten abrufen, die als benutzerdefinierte Eigenschaften gespeichert wurden. Wichtig: Die maximale Länge eines CustomProperties JSON-Objekts beträgt 2500 Zeichen.

Da Outlook auf dem Mac keine benutzerdefinierten Eigenschaften zwischenspeichert, können Mail-Add-Ins nicht auf ihre benutzerdefinierten Eigenschaften zugreifen, wenn das Netzwerk des Benutzers ausfällt.

Office.DelayDeliveryTime

Mit dem DelayDeliveryTime Objekt können Sie das Datum und die Uhrzeit der verzögerten Zustellung einer Nachricht verwalten.

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.

EmailUserObjekte werden in erster Linie in MeetingSuggestion- und TaskSuggestion-Entitäten empfangen, die aus einem Outlook Element extrahiert wurden. Weitere Informationen zu diesem Szenario finden Sie unter Extrahieren von Entitätszeichenfolgen aus einem Outlook Element.

Office.EnhancedLocation

Stellt die Gruppe von Speicherorten für einen Termin dar.

Office.EnhancedLocationsChangedEventArgs

Stellt die aktuellen erweiterten Speicherorte bereit, wenn das Office.EventType.EnhancedLocationsChanged Ereignis ausgelöst wird.

Office.Entities

Stellt eine Auflistung 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 der getEntities-Methode und der getEntitiesByType-Methode zurückgegeben werden, wenn das Element (eine E-Mail-Nachricht oder ein Termin) mindestens eine vom Exchange-Server gefundene Entität enthält. 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 Eigenschaftsarrays von der Methode zurückgegeben werden, enthält nur die Eigenschaft für die angegebene Entität Daten. Alle getEntitiesByType anderen Eigenschaften sind null.

Office.From

Stellt eine Methode zum Abrufen des From-Werts einer Nachricht in einem Outlook-Add-In bereit.

Office.InfobarClickedEventArgs

Enthält grundlegende Details zu der Benachrichtigung, die das Ereignis ausgelöst Office.EventType.InfobarClicked hat.

Office.InfobarDetails

Stellt zusätzliche Details zu der Benachrichtigung bereit, die das Ereignis ausgelöst Office.EventType.InfobarClicked hat.

Office.InternetHeaders

Das InternetHeaders Objekt stellt benutzerdefinierte Internetheader dar, die beibehalten werden, nachdem das Nachrichtenelement Exchange verlassen hat und in eine MIME-Nachricht konvertiert wird. Diese Header werden als X-Header in der MIME-Nachricht gespeichert.

Internetheader werden als Schlüssel-Wert-Paare pro Element gespeichert.

Hinweis: Dieses Objekt ist für Sie vorgesehen, um Ihre benutzerdefinierten Kopfzeilen für ein Nachrichtenelement festzulegen und abzurufen. Weitere Informationen finden Sie unter Abrufen und Festlegen von Internetkopfzeilen in einer Nachricht in einem Outlook-Add-In.

Office.IsAllDayEvent

Stellt Methoden zum Abrufen und Festlegen des ganztägigen Ereignisstatus einer Besprechung in einem Outlook-Add-In bereit.

Office.Item

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

Informationen zur vollständigen Mitgliederliste finden Sie auf der Seite Objektmodell.

Wenn Sie die IntelliSense nur für einen bestimmten Typ oder Modus sehen möchten, wird dieses Element in einen der folgenden Elemente umg:

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 Einen Modus von 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 Einen Modus von 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 Lesemodus.

Office.Location

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

Office.LocationDetails

Stellt einen Speicherort dar. Schreibgeschützt.

Office.LocationIdentifier

Stellt die ID eines Speicherorts dar.

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 über den Benutzer in einem Outlook-Add-In bereit.

Office.MasterCategories

Stellt die Kategorienmasterliste im Postfach dar.

In Outlook kann ein Benutzer Nachrichten und Termine mithilfe einer Kategorie markieren, um sie farbcodieren zu können. Kategorien werden vom Benutzer in einer Masterliste in seinem Postfach definiert. Anschließend können beliebig viele Kategorien auf ein Element angewendet werden.

Wichtig: In Stellvertretungs- oder freigegebenen Szenarien kann der Delegat die Kategorien in der Masterliste abrufen, aber keine Kategorien hinzufügen oder entfernen.

Office.MeetingSuggestion

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

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

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

Office.Message

Eine Unterklasse des Elements für Nachrichten.

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

Untergeordnete Schnittstellen:

Office.MessageCompose

Der Nachrichtenerstellmodus 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 Einen Modus von Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite "Objektmodell".

Ü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 Einen Modus von Office.context.mailbox.item. Weitere Informationen finden Sie auf der Seite "Objektmodell".

Übergeordnete Schnittstellen:

Office.NotificationMessageAction

Die Definition der Aktion für eine Benachrichtigung.

Wichtig: In modernen Outlook im Web ist das NotificationMessageAction Objekt nur im Verfassenmodus verfügbar.

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

Stellt das aktualisierte Office Design bereit, das das Ereignis ausgelöst Office.EventType.OfficeThemeChanged hat.

Office.Organizer

Stellt den Terminorganisator dar, auch wenn zum Erstellen des Termins ein Alias oder eine Stellvertretung verwendet wurde. Dieses Objekt stellt eine Methode zum Abrufen des Organisatorwerts eines Termins in einem Outlook-Add-In bereit.

Office.PhoneNumber

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

Ein Array mir PhoneNumber-Objekten mit den Telefonnummern in einer E-Mail-Nachricht wird in der Eigenschaft phoneNumbers des Entities-Objekts zurückgegeben, das wiederum zurückgegeben wird, wenn Sie die Methode getEntitiess für das ausgewählte Element aufrufen.

Office.Recipients

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

Office.RecipientsChangedEventArgs

Stellt den Änderungsstatus von Empfängerfeldern bereit, wenn das Office.EventType.RecipientsChanged Ereignis ausgelöst wird.

Office.RecipientsChangedFields

Represents RecipientsChangedEventArgs.changedRecipientFields object.

Office.Recurrence

Das Recurrence Objekt bietet Methoden zum Abrufen und Festlegen des Serienmusters von Terminen, aber nur zum Abrufen des Serienmusters von Besprechungsanfragen. Es verfügt über ein Wörterbuch mit den folgenden Schlüsseln: seriesTime, recurrenceType, recurrencePropertiesund recurrenceTimeZone (optional).

Office.RecurrenceChangedEventArgs

Stellt ein aktualisiertes Serienobjekt bereit, das das Ereignis ausgelöst Office.EventType.RecurrenceChanged hat.

Office.RecurrenceProperties

Stellt die Eigenschaften der Serie dar.

Office.RecurrenceTimeZone

Stellt die Zeitzone der Serie dar.

Office.ReplyFormAttachment

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

Office.ReplyFormData

Ein ReplyFormData-Objekt, das Textkörper- 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 werden.

Während die Outlook-Add-In-API den Zugriff auf diese Einstellungen auf das Add-In beschränkt, das sie erstellt hat, sollten diese Einstellungen nicht als sicherer Speicher betrachtet werden. Auf sie können Exchange-Webdienste oder erweiterte MAPI zugreifen. 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.

Wichtig:

  • Das Objekt wird nur beim ersten Laden des Add-Ins aus dem dauerhaften RoamingSettings Speicher initialisiert. Für Aufgabenbereiche bedeutet dies, dass sie nur initialisiert wird, wenn der Aufgabenbereich zum ersten Mal geöffnet wird. Wenn der Aufgabenbereich zu einer anderen Seite navigiert oder die aktuelle Seite neu lädt, wird das Im-Speicher-Objekt auf seine Ursprünglichen Werte zurückgesetzt, auch wenn das Add-In beibehaltene Änderungen vorgenommen hat. Die dauerhaften Änderungen stehen erst zur Verfügung, wenn der Aufgabenbereich (oder das Element bei ui-less add-ins) geschlossen und erneut geöffnet wird.

  • Wenn diese Einstellungen über Outlook unter Windows oder Mac festgelegt und gespeichert werden, werden diese Einstellungen erst nach einer Browseraktualisierung in Outlook im Web angezeigt.

Office.Sensitivity

Stellt Methoden zum Abrufen und Festlegen der Terminempfindlichkeit einer Besprechung in einem Outlook-Add-In bereit.

Office.SeriesTime

Das SeriesTime Objekt stellt Methoden zum Abrufen und Festlegen der Datums- und Uhrzeitangaben von Terminen in einer Terminserie sowie zum Abrufen der Datums- und Uhrzeitangaben von Besprechungsanfragen in einer Terminserie bereit.

Office.SessionData

Stellt Methoden zum Verwalten der Sitzungsdaten eines Elements bereit.

Wichtig: Das gesamte SessionData-Objekt ist auf 50.000 Zeichen pro Add-In beschränkt.

Office.SharedProperties

Stellt die Eigenschaften eines Termins oder einer Nachricht in einem freigegebenen Ordner oder freigegebenen Postfach dar (jetzt in der Vorschau).

Weitere Informationen zur Verwendung dieses Objekts finden Sie im Artikel zu freigegebenen Ordnern und freigegebenen Postfächern.

Office.Subject

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

Office.TaskSuggestion

Stellt einen in einem Element identifizierten vorgeschlagenen Vorgang dar. Nur Lesemodus.

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

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. Dazu gehören kontotyp, Anzeigename, E-Mail-Adresse und Zeitzone.

Enumerationen

Office.MailboxEnums.ActionType

Gibt den Typ der benutzerdefinierten Aktion in einer Benachrichtigung an.

Office.MailboxEnums.AppointmentSensitivityType

Gibt den Vertraulichkeitstyp eines Termins an.

Office.MailboxEnums.AttachmentContentFormat

Gibt die Formatierung an, die für den Inhalt einer Anlage gilt.

Office.MailboxEnums.AttachmentStatus

Gibt an, ob einem Element eine Anlage hinzugefügt oder daraus entfernt wurde.

Office.MailboxEnums.AttachmentType

Gibt den Typ einer Anlage an.

Office.MailboxEnums.CategoryColor

Gibt die Kategoriefarbe an.

Hinweis: Die tatsächliche Farbe hängt davon ab, wie der Outlook-Client sie rendert. In diesem Fall gelten die farben, die auf jeder Voreinstellung für den Outlook Desktopclient angegeben sind.

Office.MailboxEnums.ComposeType

Compose-Typ.

Office.MailboxEnums.Days

Gibt den Wochentag oder den Typ des Tages an.

Office.MailboxEnums.DelegatePermissions

Diese Bitmaske stellt die Berechtigungen eines Delegaten für einen freigegebenen Ordner oder die Berechtigungen eines Benutzers für ein freigegebenes Postfach dar.

Office.MailboxEnums.EntityType

Gibt den Typ einer Entität an.

Office.MailboxEnums.InfobarActionType

Von Office.EventType.InfobarClicked unterstützte Aktionstypen.

Office.MailboxEnums.InfobarType

Von Office.EventType.InfobarClicked zugelassener Benachrichtigungstyp.

Office.MailboxEnums.ItemNotificationMessageType

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

Office.MailboxEnums.ItemType

Gibt einen Elementtyp an.

Office.MailboxEnums.LocationType

Gibt den Typ eines Terminspeicherorts an.

Office.MailboxEnums.Month

Gibt den Monat an.

Office.MailboxEnums.OWAView

Stellt die aktuelle Ansicht von Outlook im Web dar.

Office.MailboxEnums.RecipientType

Gibt den Empfängertyp für einen Termin an.

Office.MailboxEnums.RecurrenceTimeZone

Gibt die Zeitzone an, die auf die Serie angewendet wird.

Office.MailboxEnums.RecurrenceType

Gibt den Serientyp 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.SourceProperty

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

Office.MailboxEnums.WeekNumber

Gibt die Woche des Monats an.