Verweisressourcen für die APIs für Mail, Kalender, Kontakte und Aufgaben-REST (version 1.0)

  • Artikel

Gilt für: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Hinweis

Version 1.0 der Outlook REST-API ist veraltet. Ab dem 1. November 2018 können Apps die Standardauthentifizierung nicht mehr mit dem REST-Endpunkt v1.0 verwenden. Ab dem 1. November 2019 wird der v1.0 REST-Endpunkt vollständig stillgelegt und die v1.0-Dokumentation kurz darauf entfernt. Starten Sie die Migration Ihrer App zur Verwendung der Outlook REST-API in v1.0 von Microsoft Graph. Weitere Details finden Sie in unserer Ankündigung.

Dieser Artikel beschreibt die REST-API-Entitäten, Eigenschaften, komplexen Typen, Aufzählungen und OData-Abfrageparameter, die Sie mit Outlook Mail, Kalender, Kontakteund Aufgabe API verwenden können, um auf Benutzerpostfachdaten in Office 365, Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com zuzugreifen.

Hinweis

Zur Vereinfachung des Verweises verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Kontodomänen aufzunehmen.

Weitere Informationen zu allen Untergruppen der Outlook-REST-API, finden Sie unter,Outlook-REST-API verwenden.

Kein Interesse an v1.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365 REST API reference und wählen Sie die gewünschte Version aus.

Tipp

Sie können das komplette Metadaten-Dokument für das Entitätsdatenmodell Mail, Kalender, Kontakte und Aufgaben anzeigen, indem Sie zum$metadataEndpunkt in einem Webbrowser navigieren (z. B.https://outlook.office.com/api/v1.0/$metadata).

Anlage

Eine Datei oder ein Element (Kontakt, Ereignis oder Nachricht), die einem Ereignis oder einer Nachricht angefügt ist. Die
entsprechenden Ressourcen fileAttachmentund itemAttachment werden alle von der Attachment-Ressource abgeleitet.

Typ: Microsoft.OutlookServices.Entity

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ContentType Zeichenfolge Der MIME-Typ der Anlage. Ja Nein
IsInline Boolesch true , wenn die Anlage eine Inline-Anlage ist, andernfalls false. Ja Ja
LastModifiedDateTime DateTimeOffset Datum und Uhrzeit der letzten Änderung der Anlage. Das Datum und die Uhrzeit verwenden das ISO 8601-Format und sind immer in UTC-Zeit angegeben.

Zum Beispiel würde Mitternacht UTC am 1. Januar 2014 so aussehen: '2014-01-01T00: 00: 00Z'		 Nein Ja
Name Zeichenfolge Der Anzeigename der Anlage. Dies muss nicht der eigentliche Dateiname sein. Ja Ja
Größe Int32 Die Länge der Anlage in Byte. Nein Nein

Kalender

Ein Kalender, der ein Container für Ereignisse ist.

Typ: Microsoft.OutlookServices.Calendar

Eine Kalendar-Sammlung gibt ein Array von Kalendern in derWert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/calendars/$count

Unterstützte Aktionen finden Sie unter Kalenderoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Name Zeichenfolge Der Kalendername. Ja Ja
ChangeKey Zeichenfolge Identifiziert die Version des Kalenderobjekts. Jedes Mal, wenn der Kalender geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts vorzunehmen. Nein Nein
Farbe CalendarColor Gibt das Farbdesign an, um den Kalender von anderen Kalendern in einer Benutzeroberfläche zu unterscheiden. Die Eigenschaftswerte sind: LightBlue=0, LightGreen=1, LightOrange=2, LightGray=3, LightYellow=4, LightTeal=5, LightPink=6, LightBrown=7, LightRed=8, MaxColor=9, Auto=-1 Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner des Kalenders. Nein Nein
CalendarView Sammlung (Ereignis) Die Kalenderansicht für den Kalender. Navigationseigenschaft. Nein Nein
Ereignisse Sammlung (Ereignis) Die Ereignisse im Kalender. Navigationseigenschaft. Nein Nein

CalendarGroup

Eine Gruppe von Kalendern.

Hinweis

Outlook.com unterstützt nur die Standardkalendergruppe, die über die Verknüpfung ../me/calendars erreichbar ist. Sie können diese Kalendergruppe nicht löschen.

Typ:Microsoft.OutlookServices.CalendarGroup

Eine CalendarGroup-Sammlung gibt ein Array von Kalendergruppen in derWert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/calendargroups/$count

Unterstützte Aktionen finden Sie unter CalendarGroup-Operationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Name Zeichenfolge Der Gruppenname. Ja Ja
ChangeKey Zeichenfolge Identifiziert die Version der Kalendergruppe. Jedes Mal, wenn die Kalendergruppe geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts vorzunehmen. Nein Nein
ClassId Zeichenfolge Der Klassenbezeichner. Nein Ja
ID Zeichenfolge Der eindeutige Bezeichner der Kalendergruppe. Nein Nein
Kalender Sammlung (Kalender) Die Kalender in der Kalendergruppe. Navigationseigenschaft. Nein Nein

Kontakt

Ein Kontakt, der ein Element in Outlook ist, mit dem Benutzer Informationen über die Personen und Organisationen, mit denen sie kommunizieren, organisieren und speichern können. Kontakte sind in Kontaktordnern enthalten.

Typ:Microsoft.OutlookServices.Contact

Eine Kontaktsammlung gibt ein Array von Kontakten in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/contacts/$count

Unterstützte Aktionen finden Sie unter Kontaktoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
AssistantName Zeichenfolge Der Name des Assistenten des Kontakts. Ja Ja
Geburtstag datetimeoffset Das Geburtsdatum des Kontakts. Ja Ja
BusinessAddress PhysicalAddress Die Geschäftsadresse des Kontakts. Ja Ja
BusinessHomePage Zeichenfolge Die Business-Webseite des Kontakts. Ja Ja
BusinessPhones Sammlung(Zeichenfolge) Die geschäftlichen Telefonnummern des Kontakts. Ja Nein
Kategorien Sammlung(Zeichenfolge) Die Kategorien, die mit dem Kontakt verknüpft sind. Ja Nein
ChangeKey Zeichenfolge Identifiziert die Version des Kontakts. Jedes Mal, wenn der Kontakt geändert wird, ändert sich auch der ChangeKey. Dies ermöglicht es Exchange, die Änderungen an der richtigen Version des Objekts vorzunehmen. Nein Nein
Untergeordnete Objekte Sammlung(Zeichenfolge) Die Namen der untergeordneten Elemente des Kontakts. Ja Ja
CompanyName Zeichenfolge Der Name des Unternehmens des Kontakts. Ja Ja
Abteilung Zeichenfolge Die Abteilung des Kontakts. Ja Ja
DateTimeCreated datetimeoffset Die Uhrzeit, zu der der Kontakt erstellt wurde. Nein Ja
DateTimeLastModified datetimeoffset Die Änderungszeit des Kontakts. Nein Ja
DisplayName Zeichenfolge Der Anzeigename des Kontakts. Ja Ja
EmailAddresses Sammlung (EmailAdresse) Die E-Mail-Adressen des Kontakts. Ja Nein
FileAs Zeichenfolge Der Name, unter dem der Kontakt abgelegt ist. Ja Ja
Generation Zeichenfolge Die Generation des Kontakts. Ja Ja
GivenName Zeichenfolge Der Vorname des Kontakts. Ja Ja
HomeAddress PhysicalAddress Die Privatadresse des Kontakts. Ja Ja
HomePhones Sammlung(Zeichenfolge) Die privaten Telefonnummern des Kontakts. Ja Nein
ID Zeichenfolge Eindeutiger Bezeichner für den Kontakt. Nein Nein
ImAddresses Sammlung(Zeichenfolge) Instant Messaging Chatadressen des Kontakts. Ja Nein
Initialen Zeichenfolge Die Initialen des Kontakts. Ja Ja
JobTitle Zeichenfolge Die Position des Kontakts. Ja Ja
Manager Zeichenfolge Der Name des Vorgesetzten des Kontakts. Ja Ja
MiddleName Zeichenfolge Der zweite Vorname des Kontakts. Ja Ja
MobilePhone1 Zeichenfolge Die Mobiltelefonnummer des Kontakts. Ja Ja
NickName Zeichenfolge Der Spitzname des Kontakts. Ja Ja
OfficeLocation Zeichenfolge Der Bürostandort des Kontakts. Ja Ja
OtherAddress PhysicalAddress Weitere Adressen für den Kontakt. Ja Ja
ParentFolderId Zeichenfolge Die ID des übergeordneten Ordners des Kontakts. Nein Nein
PersonalNotes Zeichenfolge Die Notizen des Benutzers zu dem Kontakt. Ja Ja
Beruf Zeichenfolge Der Beruf des Kontakts. Ja Ja
SpouseName Zeichenfolge Der Name des Ehepartners des Kontakts. Ja Ja
Nachname Zeichenfolge Der Nachname des Kontakts. Ja Ja
Titel Zeichenfolge Der Titel des Kontakts. Ja Nein
YomiCompanyName Zeichenfolge Der phonetische japanische Firmenname des Kontakts. Diese Eigenschaft ist optional. Ja Nein
YomiGivenName Zeichenfolge Der phonetische japanische Vorname des Kontakts. Diese Eigenschaft ist optional. Ja Nein
YomiSurname Zeichenfolge Der phonetische japanische Nachname des Kontakts. Diese Eigenschaft ist optional. Ja Nein

ContactFolder

Ein Ordner, der Kontakte enthält.

Typ: Microsoft.OutlookServices.ContactFolder

Eine ContactFolder-Sammlung gibt ein Array von Kontaktordnern in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/contactfolders/$count

Unterstützte Aktionen finden Sie unter ContactFolder-Operationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChildFolders Sammlung (ContactFolder) Die Sammlung von Unterordnern im Ordner. Navigationseigenschaft. Nein Nein
Kontakte Sammlung (Kontakt) Die Kontakte im Ordner. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Ordners. Ja Ja
ID Zeichenfolge Eindeutiger Bezeichner des Kontaktordners. Nein Nein
ParentFolderId Zeichenfolge Die ID des übergeordneten Ordners des Ordners. Nein Nein

Ereignis

Ein Ereignis in einem Kalender.

Typ:Microsoft.OutlookServices.Event

Eine Ereignissammlung gibt ein Array von Ereignissen in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/events/$count

Unterstützte Aktionen finden Sie unter Ereignisoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Anlagen Sammlung (Anlage) Die Sammlung von FileAttachment- und ItemAttachment-Anlagen für das Ereignis. Navigationseigenschaft. Nein Nein
Teilnehmer Sammlung (Teilnehmer) Die Sammlung der Teilnehmer für das Ereignis. Ja Nein
Text ItemBody Der Text der Nachricht, die mit diesem Ereignis verknüpft ist. Ja Nein
BodyPreview Zeichenfolge Die Vorschau der Nachricht, die dem Ereignis verknüpft ist. Nein Nein
Kalender Kalender Der Kalender, der das Ereignis enthält. Navigationseigenschaft. Nein Nein
Kategorien Sammlung(Zeichenfolge) Die Kategorien, die mit dem Ereignis verknüpft sind. Ja Nein
ChangeKey Zeichenfolge Gibt die Version des Ereignisobjekts an. Jedes Mal, wenn das Ereignis geändert wird, wird auch die Eigenschaft „changeKey“ geändert. Auf diese Weise kann Exchange Änderungen an der korrekten Version des Objekts vornehmen. Nein Nein
DateTimeCreated datetimeoffset Das Datum und die Uhrzeit, zu dem bzw. zu der das Ereignis erstellt wurde. Nein Ja
DateTimeLastModified datetimeoffset Das Datum und die Uhrzeit, zu dem bzw. zu der das Ereignis zuletzt geändert wurde. Nein Ja
Ende datetimeoffset Das Datum und die Uhrzeit, zu der das Ereignis endet.

Standardmäßig ist die Endzeit in UTC angegeben. Sie können eine optionale Zeitzone in EndTimeZone angeben, die Endzeit in dieser Zeitzone angeben und einen Zeitunterschied zur UTC-Zeitzone angeben. Beachten Sie, dass bei Verwendung von EndTimeZone auch ein Wert für StartTimeZone angegeben werden muss.

In diesem Beispiel wird der 25. Februar 2015 21:34 in PST angegeben: "2015-02-25T21:34:00-08:00“.		 Ja Ja
EndTimeZone Zeichenfolge Gibt die Zeitzone der Besprechung für die Endzeit der Besprechung an (siehe Ende-Eigenschaft). Diese Eigenschaft wird mit dem Zeitzonennamen eingestellt, so wie er in Windows gespeichert ist. Sie können die Zeitzonennamen abrufen, indem Sie System.TimeZoneInfo.GetSystemTimeZones() aufrufen.

Diese Eigenschaft ist für v1.0 optional. Diese Eigenschaft muss jedoch verwendet werden, wenn die StartTimeZone-Eigenschaft verwendet wird.

Weitere Informationen finden Sie unter TimeZone.		 Ja Nein
HasAttachments boolesch Auf "Wahr" setzen, wenn das Ereignis Anhänge enthält. Nein Ja
ID Zeichenfolge Der eindeutige Bezeichner des Ereignisses. Nein Nein
Wichtigkeit Wichtigkeit Die Wichtigkeit des Ereignisses: Low, Normal, High. Ja Ja
Instanzen Sammlung (Ereignis) Die Instanzen des Ereignisses. Navigationseigenschaft. Nein Nein
iCalUID Zeichenfolge Ein eindeutiger Bezeichner, der von allen Instanzen eines Ereignisses in verschiedenen Kalendern gemeinsam genutzt wird. Nein Ja
IsAllDay boolesch Auf "Wahr" setzen, wenn das Ereignis den ganzen Tag dauert. Für das Anpassen dieser Eigenschaft müssen auch die Start- und Ende-Eigenschaften des Ereignisses angepasst werden. Ja Ja
IsCancelled boolesch Auf "Wahr" setzen, wenn das Ereignis abgesagt wurde. Ja Ja
IsOrganizer boolesch Auf "Wahr" setzen, wenn der Absender der Nachricht auch der Organisator ist. Ja Ja
Ort Ort Der Ort des Ereignisses. Ja Ja
Organisator Empfänger Der Organisator des Ereignisses. Ja Ja
Serie PatternedRecurrence Das Serienmuster für das Ereignis. Ja Nein
ResponseRequested boolesch Auf "Wahr" setzen, wenn der Absender eine Antwort möchte, wenn das Ereignis akzeptiert oder abgelehnt wird. Ja Ja
ResponseStatus ResponseStatus Gibt den Typ der Antwort an, die als Antwort auf eine Ereignisnachricht gesendet wurde. Nein Ja
Vertraulichkeit Vertraulichkeit Gibt die Datenschutzebene für das Ereignis an: Normal = 0, Persönlich = 1, Privat = 2, Vertraulich = 3. Ja Ja
SeriesMasterId Zeichenfolge Die dem Element zugewiesenen Kategorien. Ja Nein
ShowAs FreeBusyStatus Der anzuzeigende Status: Frei = 0, Mit Vorbehalt = 1, Beschäftigt = 2, Abwesend = 3, An anderem Ort tätig = 4; Unbekannt =-1. Ja Ja
Start datetimeoffset Die Startzeit des Ereignisses.

Standardmäßig ist die Startzeit in UTC angegeben. Sie können eine optionale Zeitzone in StartTimeZone angeben, die Startzeit in dieser Zeitzone angeben und einen Zeitunterschied zur UTC-Zeitzone angeben. Beachten Sie, dass bei Verwendung von StartTimeZone auch ein Wert für EndTimeZone angegeben werden muss.

In diesem Beispiel wird 25. Februar 2015 19:34 in PST angegeben: „2015-02-25T19:34:00-08:00“.		 Ja Ja
StartTimeZone Zeichenfolge Gibt die Zeitzone der Besprechung für die Startzeit der Besprechung an (siehe Start-Eigenschaft). Diese Eigenschaft verursacht, dass der Dienst Zeitzonenänderungen anstelle des Clients handhabt. Diese Eigenschaft wird mit dem Zeitzonennamen eingestellt, so wie er in Windows gespeichert ist. Sie können die Zeitzonennamen abrufen, indem Sie System.TimeZoneInfo.GetSystemTimeZones() aufrufen.

Diese Eigenschaft ist für v1.0 optional. Diese Eigenschaft muss jedoch verwendet werden, wenn die EndTimeZone-Eigenschaft verwendet wird.

Ein Beispielwert für diese Eigenschaft ist "Pacific Normalzeit". Weitere Informationen finden Sie unter TimeZone.		 Ja Nein
Betreff Zeichenfolge Der Text der Betreffzeile des Ereignisses. Ja Ja
Typ EventType Der Ereignistyp: SingleInstance = 0, Vorkommen = 1, Ausnahme= 2, SeriesMaster = 3. Ja Ja
WebLink Zeichenfolge Die URL zum Öffnen des Ereignisses in Outlook Web App:

Das Ereignis wird im Browser geöffnet, wenn Sie über Outlook Web App bei Ihrem Postfach angemeldet sind. Sie werden aufgefordert, sich anzumelden, wenn Sie noch nicht beim Browser angemeldet sind.

Auf diese URL kann von einem iFrame aus zugegriffen werden.		 Nein Nein

EventMessage

Eine Nachricht, die eine Besprechungsanfrage, Besprechungsabsage, Besprechungsannahme, Besprechungszusage oder Absage mit Vorbehalt darstellt.

Basistyp: Nachricht

Eine EventMessage befindet sich gewöhnlich im Posteingangsordner, wo sie entweder eingeht, weil ein Ereignisorganisator eine Besprechung erstellt, oder weil ein Teilnehmer auf eine Besprechungsanfrage antwortet. Mit Ereignisnachrichten gehen Sie genauso wie mit anderen Nachrichten um, abgesehen von einigen kleinen Unterschieden, die in der folgenden Tabelle beschrieben sind.

Aktion/Verb Berechtigung Beschreibung
Eine Ereignisnachricht melden (POST) Nicht zutreffend Nicht erlaubt. Ergibt den Antwortcode 400.
Eine Ereignisnachricht aktualisieren (PATCH) Mail.Write Sie können die Eigenschaften Von, Absender, ToRecipients, CcRecipients, BccRecipients, ReplyTo, IsDeliveryReceiptRequested, IsReadReceiptRequested, IsDraft, IsRead, Betreff, Text, Wichtigkeit und Kategorien aktualisieren.
Eine Ereignisnachricht löschen (DELETE) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht verschieben (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht kopieren (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Einen Antwortnachrichtentwurf erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Antwortentwurf für alle Nachrichten erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Antwort erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Allen Antworten erstellen (POST) Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine vorhandene Ereignisnachricht senden (POST) Mail.Write Sie können nur dann eine Ereignisnachricht senden, wenn die IsDraft-Eigenschaft den Wert wahr hat. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Entwurf für eine Weiterleitungsereignisnachricht erstellen Mail.Write Gleiche Aktion wie für eine Nachricht.
Eine Ereignisnachricht weiterleiten Mail.Write Gleiche Aktion wie für eine Nachricht.

Eine EventMessage-Instanz enthält Eigenschaften des Basistyps Nachricht sowie die Eigenschaften in der folgenden Tabelle.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Ereignis Ereignis Das Ereignis, das der Ereignisnachricht zugeordnet ist. Für Teilnehmer oder Raumressourcen wird davon ausgegangen, dass die Kalenderautomatik für die automatische Aktualisierung des Kalenders mit einem Ereignis festgelegt ist, wenn Ereignisnachrichten mit Besprechungsanfragen eingehen. Navigationseigenschaft. Nein Nein
MeetingMessageType MeetingMessageType Der Typ der Ereignismeldung: Keine = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 Nein Ja

EventMessageRequest (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie Beta.

Erweiterte Eigenschaften

Diese Feature ist derzeit in Beta und v2.0 verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

FileAttachment

Eine Datei (z. B. eine Textdatei oder ein Word-Dokument), die an eine Nachricht oder ein Ereignis angefügt ist. Die ContentBytes-Eigenschaft enthält den base64-codierten Inhalt der Datei. Abgeleitet von der Anlagen-Entität.

Typ: Microsoft.OutlookServices.FileAttachment

Basistyp: Microsoft.OutlookServices.Attachment

Eigenschaft Typ Beschreibung Beschreibbar?
ContentBytes Binär Der binäre Inhalt der Datei. Nein
ContentId Zeichenfolge Die ID der Anlage im Exchange-Speicher. Nein
ContentLocation Zeichenfolge Der URI (Uniform Resource Identifier), der dem Speicherort des Anlageninhalts entspricht. Nein
ContentType Zeichenfolge Der Inhaltstyp der Anlage. Ja
DateTimeLastModified datetimeoffset Datum und Uhrzeit der letzten Änderung der Anlage. Nein
ID Zeichenfolge Die Anlagen-ID. Nein
IsContactPhoto boolesch Veraltet. Ja
IsInline boolesch Auf "Wahr" setzen, wenn es sich um eine Inlineanlage handelt. Ja
Name Zeichenfolge Der Name, der den Text darstellt, der unter dem Symbol für die eingebettete Anlage angezeigt wird. Dies muss nicht der tatsächliche Dateiname sein. Ja
Größe Int32 Die Größe der Anlage in Byte. Nein

Ordner / MailFolder

Hinweis

In Versionen nach v1.0 wurden dieOrdner-Entität und der Typ in MailFolderumbenannt.

Ein Ordner im Postfach eines Benutzers, z.B. Posteingang, Entwürfe und Gesendete Objekte. Ordner können Nachrichten und andere Ordner enthalten.

Typ:Microsoft.OutlookServices.Folder

Eine Ordner-Sammlung gibt ein Array von Ordnern in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/folders/$count

Unterstützte Aktionen finden Sie unter Ordneroperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
ChildFolderCount Int32 Die Anzahl der Ordner im Ordner. Nein Ja
ChildFolders Sammlung (Ordner) Die Sammlung von Unterordnern im Ordner. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Ordners. Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner des Ordners. Sie können die folgenden bekannten Namen verwenden, um auf den entsprechenden Ordner zuzugreifen:Posteingang, Entwürfe, SendItems, DeletedItems. Nein Nein
Nachrichten Sammlung (Message) Die Sammlung von Nachrichten im Ordner. Navigationseigenschaft. Nein Nein
ParentFolderId Zeichenfolge Der eindeutige Bezeichner für den übergeordneten Ordner des Ordners. Nein Nein
TotalItemCount Int32 Die Anzahl der Elemente im Ordner. Nein Ja
UnreadItemCount Int32 Die Anzahl der Elemente im Ordner, die als „Ungelesen“ markiert sind. Nein Ja

Effizientes Zugriff auf Anzahl von der Elementen

Mit den EigenschaftenTotalItemCountund UnreadItemCounteines Ordners können Sie die Anzahl der gelesenen Elemente im Ordner problemlos ermitteln. Mithilfe dieser Eigenschaften werden Abfragen folgender Art vermieden, die zu erheblichen Wartezeiten führen:

https://outlook.office.com/api/v1.0/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false

Ordner in Outlook können mehr als einen Typ von Elementen enthalten, der Posteingang kann beispielsweise Besprechungsanfragen enthalten, die sich von E-Mail-Elementen unterscheiden. TotalItemCount und UnreadItemCount schließen Elemente in einem Ordner unabhängig von Elementtyp ein.

InferenceClassification

Dieses Feature ist derzeit in v2.0 und Beta verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

InferenceClassificationOverride

Dieses Feature ist derzeit in v2.0 und Beta verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

ItemAttachment

Eine Nachricht, ein Kontakt oder ein Ereignis, das an eine andere Nachricht oder ein Ereignis angehängt ist. Abgeleitet von der Anlagen-Entität.

Typ: Microsoft.OutlookServices.ItemAttachment

Basistyp: Microsoft.OutlookServices.Attachment

Eigenschaft Typ Beschreibung Beschreibbar?
ContentType Zeichenfolge Der Inhaltstyp der Anlage. Ja
DateTimeLastModified datetimeoffset Letzte Uhrzeit und letztes Datum der Änderung der Anlage. Nein
ID Zeichenfolge Die Anlagen-ID. Nein
Element Element Die angefügte Nachricht oder das angefügte Ereignis. Navigationseigenschaft. Ja
IsInline boolesch Stellen Sie auf wahr ein, wenn es sich um eine Inlineanlage handelt, z. B. ein eingebettetes Bild innerhalb des Textkörpers des Elements. Ja
Name Zeichenfolge Der Anzeigename der Anlage. Ja
Größe Int32 Die Größe der Anlage in Byte. Ja

Erwähnung (Vorschau)

Dieses Feature ist derzeit nur in der Beta-Version verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie Beta.

Nachricht

Eine Nachricht in einem Postfachordner.

Typ:Microsoft.OutlookServices.Message

Eine Nachrichten-Sammlung gibt ein Array von Nachrichten in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/messages/$count

Unterstützte Aktionen finden Sie unter Nachrichtenoperationen.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar? Suchbar?
Anlagen Sammlung (Anlage) DiefileAttachment- unditemAttachment-Anlagen der Nachricht. Navigationseigenschaft. Ja Nein Ja
BccRecipients Sammlung (Empfänger) Die Bcc-Empfänger der Nachricht. Ja Nein Ja
Text ItemBody Der Text der Nachricht. Ja Nein Standard
BodyPreview Zeichenfolge Die ersten 255 Zeichen des Nachrichtentextinhalts. Nein Nein Ja
Kategorien Sammlung (Zeichenfolge) Die Kategorien, die mit der Nachricht verknüpft sind. Ja Ja Ja
CcRecipients Sammlung (Empfänger) Die Cc-Empfänger der Nachricht. Ja Nein Ja
ChangeKey Zeichenfolge Die Version der Nachricht. Nein Nein Nein
ConversationId Zeichenfolge Die ID der Unterhaltung, zu der die E-Mail gehört. Nein Ja Nein
DateTimeCreated datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht erstellt wurde. Nein Ja Nein
DateTimeLastModified datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht zuletzt geändert wurde. Nein Ja Nein
DateTimeReceived datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht erhalten wurde. Nein Ja Ja
DateTimeSent datetimeoffset Das Datum und die Uhrzeit, zu der die Nachricht gesendet wurde. Nein Ja Nein
Von Empfänger Der Postfachbesitzer und der Absender der Nachricht. Ja Ja Ja
HasAttachments boolesch Gibt an, ob die Nachricht Anlagen enthält. Ja Ja Ja
ID Zeichenfolge Der eindeutige Bezeichner der Nachricht. Nein Nein Nein
Wichtigkeit Wichtigkeit Die Wichtigkeit der Nachricht: Niedrig = 0, Normal = 1, Hoch = 2. Ja Ja Ja
IsDeliveryReceiptRequested boolesch Gibt an, ob für die Nachricht eine Lesebestätigung angefordert wird. Ja Ja Nein
IsDraft boolesch Gibt an, ob die Nachricht ein Entwurf ist. Eine Nachricht ist ein Entwurf, solange sie noch nicht gesendet wurde. Nein Ja Nein
IsRead boolesch Gibt an, ob die Nachricht gelesen wurde. Ja Ja Nein
IsReadReceiptRequested boolesch Gibt an, ob für die Nachricht eine Lesebestätigung angefordert wird. Ja Ja Nein
ParentFolderId Zeichenfolge Der eindeutige Bezeichner für den übergeordneten Ordner der Nachricht. Nein Nein Nein
ReplyTo Sammlung (Empfänger) Die E-Mail-Adressen, die beim Antworten verwendet werden sollen. Ja Nein Nein
Absender Empfänger Das Konto, das tatsächlich verwendet wird, um die Nachricht zu generieren. Ja Ja Standard
Betreff Zeichenfolge Der Betreff der Nachricht. Ja Ja Standard
ToRecipients Sammlung (Empfänger) Die An-Empfänger der Nachricht. Ja Nein Ja
UniqueBody ItemBody Der Text der Nachricht, der für die Konversation eindeutig ist. Nein Nein Nein
WebLink Zeichenfolge Die URL zum Öffnen der Nachricht in Outlook Web App.

Sie können am Ende der URL das Argument „ispopout“ anhängen, um zu ändern, wie die Nachricht angezeigt wird. Wenn „ispopout“ nicht vorhanden oder auf 1 festgelegt ist, wird die Nachricht in einem Popout-Fenster angezeigt. Wenn „ispopout“ auf 0 festgelegt ist, zeigt der Browser die Nachricht in Outlook Web App im Prüffensterbereich an.

Die Nachricht wird im Browser geöffnet, wenn Sie über Outlook Web App bei Ihrem Postfach angemeldet sind. Sie werden aufgefordert, sich anzumelden, wenn Sie noch nicht beim Browser angemeldet sind.

Auf diese URL kann von einem iFrame aus zugegriffen werden.		 Nein Ja Nein

Entfernen von Skript aus der Text-Eigenschaft

Der Nachrichtentext kann entweder HTML oder Text sein. Wenn der Text HTML ist, wird standardmäßig jedes potentiell unsichere HTML (z. B. JavaScript), das in die Text-Eigenschaft eingebettet ist, entfernt, bevor der Inhalt des Textes in einer REST-Antwort zurückgegeben wird.

Fügen Sie den gesamten, ursprünglichen HTML-Inhalt ein, um den folgenden HTTP-Anforderungs-Header abzurufen:

Prefer: outlook.allow-unsafe-html

Festlegen der Von- und Absender-Eigenschaften

Beim Schreiben einer Nachricht stellen in den meisten Fällen die Von- undAbsender-Eigenschaften den gleichen angemeldeten Benutzer dar, es sei denn, eine der beiden Eigenschaften wird wie in den folgenden Szenarien beschrieben aktualisiert:

  • Die Von-Eigenschaft kann geändert werden, wenn der Exchange-Administrator SendAs-Rechte des Postfachs anderen Benutzern zugewiesen hat. Der Administrator kann dies tun, indem erPostfachberechtigungen des Postfachbesitzers im Azure-Verwaltungsportal auswählt oder dasExchange Admin Centeroder einWindows PowerShell Add-ADPermission-Cmdlet verwendet. Dann können Sie programmgesteuert die Von-Eigenschaft eines dieser Benutzer festlegen, die SendAs-Rechte für das Postfach haben.

  • Die Absender-Eigenschaft kann geändert werden, wenn der Exchange-Administrator eine oder mehrere Benutzer delegiert hat, um Nachrichten von diesem Postfach zu senden. Der Postfachbesitzer kann in Outlook delegieren. Wenn ein Stellvertreter eine Nachricht im Namen des Postfachbesitzers sendet, wird die Absender-Eigenschaft auf das Konto des Stellvertreters eingestellt und die Von-Eigenschaft bleibt als Postfachbesitzer erhalten. Programmgesteuert können Sie die Absender-Eigenschaft auf einen Benutzer einstellen, der die Stellvertreterrechte für dieses Postfach hat.

MessageRule (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie Beta.

OutlookCategory (Vorschau)

Dieses Feature ist derzeit in der Beta-Version verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie Beta.

Foto

Dieses Feature ist derzeit in v2.0 und Beta verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

ReferenceAttachment

Dieses Feature ist derzeit in der Beta-Version verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie Beta.

Aufgabe

Diese Feature ist derzeit in Beta und v2.0 verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

TaskFolder

Diese Feature ist derzeit in Beta und v2.0 verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

TaskGroup

Diese Feature ist derzeit in Beta und v2.0 verfügbar. Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum AbschnittOffice 365-REST-API-Referenzund wählen Sie die gewünschte Version aus.

Benutzer

Ein Benutzer im System. Der Me-Endpunkt ist eine Abkürzung für die Angabe des aktuellen Benutzers über die SMTP-Adresse ( users/sadie@contoso.com).

Typ:Microsoft.OutlookServices.User

Eine Users-Sammlung gibt ein Array von Benutzern in der Wert-Eigenschaft der OData-Antwort zurück. Mit $count können Sie die Anzahl der Objekte in der Sammlung ermitteln: .../me/users/$count

Hinweis

DieBenutzer-Entität enthält viele Eigenschaften und Beziehungen (Navigationseigenschaften), die häufig erweitert werden. Der folgende Abschnitt beschreibt nur eine Teilmenge. Aktuelle Informationen finden Sie in der Benutzer-Definition in der entsprechenden Metadaten-Datei für Ihre Version.

Eigenschaft Typ Beschreibung Beschreibbar? Filterbar?
Alias Zeichenfolge Der Alias des Benutzers. Gewöhnlich die SMTP-Adresse des Benutzers. Ja Ja
Kalender Kalender Primärer Kalender des Benutzers. Navigationseigenschaft. Nein Nein
CalendarGroups Sammlung (CalendarGroup) Die Kalendergruppen des Benutzers. Navigationseigenschaft. Nein Nein
Kalender Sammlung (Kalender) Die Kalender des Benutzers. Navigationseigenschaft. Nein Nein
CalendarView Sammlung (Ereignis) Die Kalenderansicht für den Kalender. Navigationseigenschaft. Nein Nein
ContactFolders Sammlung (ContactFolder) Die Kontaktordner des Benutzers. Navigationseigenschaft. Nein Nein
Kontakte Sammlung (Kontakt) Die Kontakte des Benutzers. Navigationseigenschaft. Nein Nein
DisplayName Zeichenfolge Der Anzeigename des Benutzers. Ja Ja
Ereignisse Sammlung (Ereignis) Die Ereignisse des Benutzers. Standardmäßig werden Ereignisse unter dem Standardkalender angezeigt. Navigationseigenschaft. Nein Nein
Ordner Sammlung (Ordner) Die Ordner in einem Postfach oder Ordner. Navigationseigenschaft. Nein Nein
ID Zeichenfolge Die eindeutige ID des Benutzers. Nein Nein
MailboxGuid GUID Die dem Postfach des Benutzers zugeordnete GUID. Nein Ja
Nachrichten Sammlung (Message) Die Nachrichten in einem Postfach oder Ordner. Navigationseigenschaft. Nein Nein
RootFolder Ordner Der Stammordner des Postfachs des Benutzers. Navigationseigenschaft. Nein Nein

Komplexe Typen

Teilnehmer

Ein Teilnehmer eines Ereignisses.

Typ: Microsoft.OutlookServices.Recipient

Eigenschaft Typ Beschreibung
Status ResponseStatus Die Antwort (keine, akzeptiert, abgelehnt usw.) und die Zeit.
Typ AttendeeType Der Typ des Teilnehmers: Required, Optional, Resource.

EmailAddress

Name und E-Mail-Adresse eines Kontakts oder eines Empfängers der Nachricht.

Typ:Microsoft.OutlookServices.EmailAddress

Eigenschaft Typ Beschreibung
Name Zeichenfolge Der Anzeigename der Person oder Entität.
Adresse Zeichenfolge Die E-Mail-Adresse der Person oder Entität.

GeoCoordinates

Die geografischen Koordinaten und die Rechteerweiterung des Orts.

Typ: Microsoft.OutlookServices.GeoCoordinates

Eigenschaft Typ Beschreibung
Höhe doppelt Die Höhe des Orts.
Breitengrad doppelt Der Breitengrad des Orts.
Längengrad doppelt Der Längengrad des Orts.
Genauigkeit doppelt Die Genauigkeit des Sensors, der den Breiten- und Längengrad liefert.
AltitudeAccuracy doppelt Die Genauigkeit des Sensors, der die Höhe liefert.

ItemBody

Der Textinhalt einer Nachricht oder eines Ereignisses.

Type: Microsoft.OutlookServices.ItemBody

Eigenschaft Typ Beschreibung
ContentType BodyType Der Inhaltstyp: Text = 0, HTML = 1.
Inhalt Zeichenfolge Der Text- oder HTML-Inhalt.

Ort

Der Ort eines Ereignisses.

Typ: Microsoft.OutlookServices.Location

Eigenschaft Typ Beschreibung
DisplayName Zeichenfolge Der Name, der mit dem Ort verknüpft ist.
Adresse PhysicalAddress Die physische Adresse des Ortes.
Koordinaten GeoCoordinates Die geografischen Koordinaten und die Rechteerweiterung des Orts.

PatternedRecurrence

Serienmuster und -bereich.

Typ: Microsoft.OutlookServices.PatternedRecurrence

Eigenschaft Typ Beschreibung
Muster RecurrencePattern Die Häufigkeit eines Ereignisses.
Range RecurrenceRange Die Dauer eines Ereignisses.

PhysicalAddress

Die physische Adresse eines Kontakts.

Typ: Microsoft.OutlookServices.PhysicalAddress

Eigenschaft Typ Beschreibung
Straße Zeichenfolge Die Straße.
Stadt Zeichenfolge Der Ort.
Status Zeichenfolge Das Land.
CountryOrRegion Zeichenfolge Land oder Region Ein frei formatierbarer Zeichenfolgenwert, z. B. Vereinigte Staaten.
PostalCode Zeichenfolge Die Postleitzahl.

Empfänger

Stellt Informationen zu einem Benutzer am sendenden oder empfangenden Ende eines Ereignisses oder einer Nachricht dar.

Typ: Microsoft.OutlookServices.Recipient

Eigenschaft Typ Beschreibung
EmailAddress EmailAddress Die E-Mail-Adresse des Empfängers.

RecurrencePattern

Die Häufigkeit eines Ereignisses.

Typ: Microsoft.OutlookServices.RecurrencePattern

Eigenschaft Typ Beschreibung
Typ RecurrencePatternType Der Serienmustertyp: Täglich = 0, Wöchentlich = 1, AbsolutMonthly = 2, RelativMonthly = 3, AbsolutYearly = 4, RelativYearly = 5.
Musterregeln:
- AbsoluteYearly. Muss den Monat und DayOfMonth des Ereignisses festlegen
- RelativeYearly. Muss den Monat, DaysOfWeek, und FirstDayOfWeek-Index festlegen
- AbsoluteMonthly. Muss DayOfMonth festlegen
- RelativeMonthly. Muss den FirstDayOfWeek-Index und den RecurrenceRange.NumberOfOccurrences festlegen
- Wöchentlich. Muss dieDaysOfWeek und den FirstDayOfWeek festlegen
- Täglich. Keine zusätzlichen Musterinformationen benötigt.
Intervall Int32 Die Anzahl von Einheiten eines bestimmten Serientyps zwischen Vorkommnise.
DayOfMonth Int32 Der Tag des Monats, an dem das Element auftritt.
Monat Int32 Der Monat, an dem das Element auftritt. Dies ist eine Zahl zwischen 1 und 12.
DaysOfWeek Sammlung (DayOfWeek) Eine Sammlung von Wochentagen: Sonntag = 0, Montag = 1, Dienstag = 2, Mittwoch = 3, Donnerstag = 4, Freitag = 5, Samstag = 6.
FirstDayOfWeek DayOfWeek Der Wochentag: Sonntag = 0, Montag = 1, Dienstag = 2, Mittwoch = 3, Donnerstag = 4, Freitag = 5, Samstag = 6.
Index WeekIndex Der Wochenindex: Erster = 0, zweiter = 1, dritter = 2, vierter = 3, letzter = 4.

RecurrenceRange

Die Dauer eines Ereignisses.

Typ: Microsoft.OutlookServices.RecurrenceRange

Eigenschaft Typ Beschreibung
Typ RecurrenceRangeType Der Serienbereich: EndDate = 0, NoEnd = 1, Nummeriert = 2.
StartDate datetimeoffset Erforderlich: Das Startdatum der Serie.
EndDate datetimeoffset Benötigt für datumsgebundene Muster: Das Enddatum der Serie. Muss nach dem Startdatum sein.
NumberOfOccurrences Int32 Benötigt für nummerierte Muster: Wie oft soll das Ereignis wiederholt werden.

ResponseStatus

Der Antwortstatus einer Besprechungsanfrage.

Typ: Microsoft.OutlookServices.ResponseStatus

Eigenschaft Typ Beschreibung
Antwort ResponseType Der Antworttyp: None, Organizer, TentativelyAccepted, Accepted, Declined, NotResponded.
Zeit datetimeoffset Datum und Uhrzeit, zu der die Antwort zurückgegeben wurde.

Aufzählungen

DayOfWeek

Die Menge der Wochentage.

Unterstützte Werte:

  • Sonntag
  • Montag
  • Dienstag
  • Mittwoch
  • Donnerstag
  • Freitag
  • Samstag

FreeBusyStatus

Gibt den Verfügbarkeitsstatus eines Teilnehmers für eine Besprechung an.

Unterstützte Werte:

  • Gebucht
  • Frei
  • Abwesend
  • Vorläufig
  • Unbekannt
  • WorkingElsewhere

ReferenceAttachmentPermissions

Zugriffsberechtigungen für die Datei oder den Ordner der Verweisanlage.

Unterstützte Werte:

  • Sonstiges
  • Ansicht
  • Bearbeiten
  • AnonymousView
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

ReferenceAttachmentProviders

Mögliche Dateispeicheranbieter für Verweisanlagen.

Unterstützte Werte:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Sonstiges

Vertraulichkeit

Zeigt die Datenschutzebene an.

Unterstützte Werte:

  • Standard
  • Persönlich
  • Privat
  • Vertraulich

OData-Abfrageparameter

Sie können die Standard-Abfrageparameter OData v4.0 verwenden, um Datenanforderungen zu filtern und die Seitenergebnisse zu sortieren und anzuzeigen, wenn Sie mit den Mail-, Kalender- und Kontakt-APIs arbeiten. Achten Sie bei der Angabe von Abfrageparametern darauf, dass Zeichen, die für besondere Bedeutungen in einem URI reserviert sind, entsprechend kodiert werden.

  • $search nach bestimmten Kriterien suchen

  • $filter nach bestimmten Kriterien filtern

  • $select um bestimmte Eigenschaften anzufordern

  • $orderby um Ergebnisse zu sortieren

  • $top und $skip zuSeite Ergebnisse

  • $expand , um Nachrichtenanlagen und Ereignisanlagen zu erweitern

  • $count um die Anzahlder Entitäten in einer Sammlung zu ermitteln. Dieser Parameter gehört in den URL-Pfad: .../me/calendars/$count

Die Abfrage mit der Mail-, Kalender- und Kontakt-API verwendet immer einen flachen Bereich. Es werden nur Elemente innerhalb des aktuellen Ordners zurückgegeben. Tiefe Suchen werden nicht unterstützt.

Suchanforderungen

Mit dem Parameter $search können Sie die Ergebnisse einer Anforderungen auf die Nachrichten beschränken, die einem Suchbegriff entsprechen. Suchzeichenfolgen werden mithilfe von Advanced Query Syntax (AQS) ausgedrückt. Die Ergebnisse werden nach Datum und Uhrzeit sortiert, an dem bzw. zu der die Nachricht gesendet wurde.

Hinweis

Sie können bis zu 250 Ergebnisse aus einer $searchAnforderung erhalten. Sie können $search nur für Nachrichten verwenden. Die Suche nach Kontakten und Kalenderereignissen wird nicht unterstützt.

Sie können $filter oder $orderby in einer Suchanforderung nicht verwenden. In diesem Fall erhalten Sie eine Fehlermeldung wie diese.

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }
Eigenschaft Beschreibung
Anlage Sucht nach der angegebenen Anlage nach Titel.
BCC Sucht das Bcc-Feld.
Text oder Inhalt Sucht das Text-Feld. Wird nur bei der Standardsuche unterstützt.
Kategorie Sucht das Kategorie-Feld.
Cc Sucht das Cc-Feld.
Von Sucht das Von-Feld.
Hat Sucht das HasAttachments-Feld.
Teilnehmer Sucht die An, Ccund Bcc-Felder.
Empfangen Sucht das Empfangen-Feld nach einem bestimmten Datum, ausgedrückt als MM/DD/YYYYY.
Absender Sucht das Absender-Feld.
Betreff Sucht das Betreff-Feld.
An Sucht dasAn-Feld.

Sie suchen allgemeine Felder mit dem Parameter$search ohne Angabe einer Eigenschaft. Eine Standardsuche durchsucht die Eigenschaften Text, Absenderund Betreff. Die folgende Suche gibt alle Nachrichten im Posteingang zurück, die "Pizza" in einer der drei Standardeigenschaften enthalten.

Schauen wir uns einige Beispiele an. Damit sie leichter lesbar werden, sind die URLs in den Beispielen nicht URL-codiert; wenn Sie diese Beispiele ausprobieren, stellen Sie jedoch sicher, dass sie URL-codiert sind, bevor Sie sie an den Server senden.

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die das Wort "Pizza" in der Eigenschaft Von, Betreff oder Text enthalten.

GET https://outlook.office.com/api/v1.0/me/messages?$search="pizza"

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die das Wort "Pizza" in der Eigenschaft Betreff enthalten.

GET https://outlook.office.com/api/v1.0/me/messages?$search="subject:pizza"

Sie können diese Anforderung verwenden, um alle Nachrichten im Posteingang zu erhalten, die von einer bestimmten Person gesendet wurden.

GET https://outlook.office.com/api/v1.0/me/messages?$search="from:help@contoso.com"

Die obigen Beispiele enthielten keine URL-Codierung, hier sind die gleichen Beispiele URL-codiert und bereit, an Ihren Server zu senden:

GET https://outlook.office.com/api/v1.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22from:help@contoso.com%22

Filteranforderungen

Mit dem Abfrageparameter $filter können Sie Suchkriterien mithilfe der folgenden Filteroperatoren angeben.

Nicht alle Eigenschaften unterstützen das Filtern. Nur die mit "Ja" gekennzeichneten Ressourceneigenschaften im Feld "Filterbar?" Spalte in den entsprechenden Tabellen oben können verwendet werden. Wenn eine Eigenschaft nicht filterbar ist, erhalten Sie eine Fehlermeldung wie diese, die zurückgegeben wird, wenn Sie versuchen, auf die Eigenschaft ChangeKey zu filtern:

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

Wenn Sie eine Filtermethode verwenden, die nicht unterstützt wird, erhalten Sie eine Fehlermeldung wie diese, die zurückgegeben wird, wenn die Filtermethode startswith für die Eigenschaft Betreff verwendet wird:

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }
Operator Typ Beispiel
und Logisch und (zum Vereinen mehrerer Kriterien) TotalCount gt 0 and ChildFolderCount eq 0
oder Logisch oder (zum Vereinen mehrerer Kriterien) TotalCount gt 0 or ChildFolderCount eq 0
eq Gleich IsRead eq false
ne Ist nicht gleich Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt Größer als DateTimeReceived gt 2014-09-01T00:00:00Z
ge Größer oder gleich DateTimeLastModified ge 2014-09-01T00:00:00Z
lt Kleiner als DateTimeReceived lt 2014-09-01T00:00:00Z
le Kleiner oder gleich DateTimeLastModified le 2014-09-01T00:00:00Z

Verwenden Sie einfache Anführungszeichen ('), um einen beliebigen Zeichenfolgenwert im Filterkriterium abzugrenzen. Verwenden Sie %27, um das einfache Anführungszeichen zu codieren. Die Zeichenfolge selbst unterscheidet nicht zwischen Groß- und Kleinschreibung.

Schauen wir uns einige Beispiele an. Damit sie leichter lesbar werden, sind die URLs in den Beispielen nicht URL-codiert; wenn Sie diese Beispiele ausprobieren, stellen Sie jedoch sicher, dass sie URL-codiert sind, bevor Sie sie an den Server senden.

Sie können nach der Eigenschaft Betreff filtern, um alle Ereignisse im Kalender des Benutzers mit einem bestimmten Thema zu erhalten.

GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject eq 'Mega Charity Bash'

Sie können nach der Eigenschaft IsRead filtern, um alle ungelesenen Nachrichten im Posteingang zu erhalten.

GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead eq false

Sie können nach der Eigenschaft HasAttachments filtern, um alle Nachrichten im Posteingang mit Anlagen zu erhalten.

GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments eq true

Sie können nach der Eigenschaft DateTimeReceived filtern, um alle Nachrichten im Posteingang seit dem 1. September 2014 zu erhalten.

GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived ge 2014-09-01

Sie können nach der Eigenschaft Absender filtern, um alle Nachrichten im Posteingang von "hr@contoso.com" zu erhalten.

GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

Die obigen Beispiele enthielten keine URL-Codierung, hier sind die gleichen Beispiele URL-codiert und bereit, an Ihren Server zu senden:

GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived%20ge%202014-09-01
GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

Bestimmte Eigenschaften auswählen, die zurückgegeben werden sollen

Mit dem Abfrageparameter $select können Sie nur die Eigenschaften angeben, die Ihre App benötigt.

Hinweis

Wenn Sie Mail-, Kalender- und Kontaktelemente erhalten, verwenden Sie immer$select, um nicht benötigte Eigenschaften in der Antwort-Nutzlast auszuschließen und um eine vernünftige Appleistung zu erhalten. Wenn Sie keinen Parameter $select angeben, werden alle Eigenschaften für die Elemente zurückgegeben.

Das folgende Beispiel liefert die Eigenschaften Betreff, Absender und DateTimeReceived für alle Nachrichten im Posteingang.

GET https://outlook.office.com/api/v1.0/me/messages?$select=Subject,Sender,DateTimeReceived

Sortierergebnisse

Sie können die Ergebnisse mit dem Abfrageparameter $orderby sortieren. Legen Sie den Wert dieses Parameters auf einen Eigenschaftsnamen fest und geben Sie optional aufsteigend (Standard) oder absteigend an. Denken Sie daran, dass Sie den Abfrageparameter $orderby mit $search nicht verwenden können.

Das folgende Beispiel ohne URL-Codierung sortiert alle Nachrichten im Posteingang nach der Eigenschaft DateTimeReceived in absteigender Reihenfolge.

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived desc

Das gleiche Beispiel mit URL-Codierung:

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived%20desc

Seitenergebnisse

Standardmäßig gibt eine GET-Anforderung für eineNachrichten- oder ChildFolders-Eigenschaft, eine Sammlung oder für eineCalendarViewzehn Einträge zurück (maximal 50). Sie können dieses Verhalten ändern, indem Sie den Abfrageparameter $top verwenden, um eine maximale Anzahl einzustellen. Das folgende Beispiel liefert die ersten fünf Nachrichten im Posteingang.

GET https://outlook.office.com/api/v1.0/me/messages?$top=5

Wenn sich mehr als fünf Nachrichten im Posteingang befinden, enthält die Antwort eine odata.nextLink-Eigenschaft. Die Anwesenheit dieser Eigenschaft zeigt an, dass mehr Elemente auf dem Server verfügbar sind. Der Wert dieser Eigenschaft ist eine URI, die zum Abrufen der nächsten fünf Elemente verwendet werden kann.

GET https://outlook.office.com/api/v1.0/me/messages?$top=5&$skip=5

Das Paging wird durch die Verwendung des Parameters $top zur Angabe einer Seitengröße und des Parameters $skip als Vielfaches der Seitengröße erreicht. Durch Erhöhen des Parameters $skip um die Seitengröße können Sie die nächste Seite in der Ergebnismenge anfordern.

Entitäten in einer Sammlung zählen

Sie können die Anzahl der Entitäten in einer Sammlung mit dem Parameter $count ermitteln. Sie können den Zählanforderung auch filtern.

Dieses Beispiel liefert die Anzahl der Nachrichten im Posteingang.

GET https://outlook.office.com/api/v1.0/me/messages/$count

Und dieses Beispiel ohne URL-Codierung liefert die Anzahl der ungelesenen Nachrichten im Posteingang.

GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead eq false

Das gleiche Beispiel mit URL-Codierung.

GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead%20eq%20false

Zusammengefasst

Sie können Parameter vereinen, um komplexe Abfragen zu erstellen. Das folgende Beispiel verfeinert eine Abfrage der Nachrichten im Posteingang wie folgt:

  • Gibt nur Elemente, deren Wichtigkeit auf Hoch eingestellt ist, zurück.

  • Gibt nur die Eigenschaften Betreff, Absenderund DateTimeReceivedzurück.

  • Gibt nur die ersten fünf Nachrichten zurück.

Hinweis

Die URL-Codierung wird nicht verwendet, und Zeilenumbrüche wurden hinzugefügt, um das Lesen des Beispiels zu vereinfachen.

https://outlook.office.com/api/v1.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,DateTimeReceived
    &$top=5

Wenn Sie $filter angeben, leitet der Server eine Sortierreihenfolge für die Ergebnisse ab. Wenn Sie$filter und $orderby verwenden, müssen die Eigenschaften in $filter zuerst im $orderby vor allen anderen Eigenschaften aufgeführt werden und sie müssen in der Reihenfolge aufgelistet werden, in der sie im Parameter $filter erscheinen. Das folgende Beispiel zeigt eine Abfrage, die nach den Eigenschaften Betreff und Wichtigkeit gefiltert und dann nach den Eigenschaften Betreff, Wichtigkeit und Absender sortiert wird.

https://outlook.office.com/api/v1.0/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

Hier sind die gleichen Beispiele mit URL-Codierung und ohne Zeilenumbrüche.

https://outlook.office.com/api/v1.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,DateTimeReceived&$top=5

https://outlook.office.com/api/v1.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

Siehe auch