Ressourcenverweis für die E-Mail-, Kalender-, Kontakte- und Aufgaben-REST-APIs (Beta)
Gilt für: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Hinweis
Diese Dokumentation behandelt neue oder geänderte Ressourcen für mehrere Ereignisspeicherorte, Kalenderfreigaben, @ -Markierungen, Schnellantworten, Sprache und Zeitzonen, die als "(Vorschau)" gekennzeichnet sind. Die Funktionen der Vorschauversion können vor der Fertigstellung geändert werden und können den Code beschädigen, der sie verwendet. Aus diesem Grund sollten Sie in der Regel nur eine Produktionsversion einer API in Ihrem Produktionscode verwenden. Falls vorhanden, ist v2.0 derzeit die bevorzugte Version.
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 der Referenz verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Kontodomänen einzuschließen.
Weitere Informationen, die allen Untergruppen von Outlook REST-API gemeinsam sind, finden Sie unter Verwendung der Outlook REST-API.
Sie interessieren sich nicht für die Beta-Version der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zu Office 365 REST-API-Referenz 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 $metadata
Endpunkt in einem Webbrowser navigieren (z. B.: https://outlook.office.com/api/beta/$metadata
).
Anlage
Eine Datei, ein Element (Kontakt, Ereignis oder Nachricht) oder eine Verknüpfung zu einer Datei oder zu einem Ordner, die an ein Ereignis, eine Nachrichtoder eine Aufgabe angehängt ist. Die entsprechenden fileAttachment, itemAttachment und referenceAttachment-Ressourcen stammen alle von der Attachment - Ressource.
Typ: Microsoft.OutlookServices.Entity
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Inhaltsart | Zeichenfolge | Der MIME-Typ der Anlage. | Ja | Nein |
IsInline | Boolesch | true , wenn die Anlage eine Inlineanlage 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 aktuelle Dateiname sein. | Ja | Ja |
Schriftgrad | 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 der Wert-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? |
---|---|---|---|---|
CanEdit | Boolesch | „True“, wenn der Benutzer in den Kalender schreiben kann, andernfalls „false“. Diese Eigenschaft ist für den Benutzer, der den Kalender erstellt hat, „true“. Diese Eigenschaft ist auch für einen Benutzer „true“, für den ein Kalender freigegeben wurde und der Schreibzugriff hat. | Nein | Ja |
CanShare | Boolesch | „True“, wenn der Benutzer die Berechtigung zum Freigeben des Kalenders hat, andernfalls „false“. Nur der Benutzer, der den Kalender erstellt hat, kann ihn freigeben. | Nein | Ja |
CanViewPrivateItems | Boolesch | „True“, wenn der Benutzer Elemente im Kalender lesen kann, die als „privat“ markiert wurden, andernfalls „false“. | Nein | Ja |
ChangeKey | Zeichenfolge | Identifiziert die Version des Kalenderobjekts. Jedes Mal, wenn der Kalender geändert wird, ändert sich auch der ChangeKey. Dadurch kann Exchange Änderungen an der richtigen Version des Objekts vornehmen. | 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 |
IsDefaultCalendar | Boolesch | Wahr, wenn dieser Kalender der Standardkalender des Benutzers ist, ansonsten falsch. | Ja | Ja |
IsShared | Boolesch | Wahr, wenn der Benutzer den Kalender mit anderen Benutzern geteilt hat, ansonsten falsch. Da nur der Benutzer, der den Kalender erstellt hat, ihn freigeben kann, können IsShared und IsSharedWithMe für denselben Benutzer nicht wahr sein. | Nein | Ja |
IsSharedWithMe | Boolesch | Wahr, wenn der Benutzer diesen Kalender freigegeben hat, andernfalls falsch. Diese Eigenschaft ist für einen Kalenderbesitzer immer falsch. | Nein | Ja |
Name | Zeichenfolge | Der Kalendername. | Ja | Ja |
Besitzer | EmailAddress | Wenn eingestellt, repräsentiert dies den Benutzer, der den Kalender erstellt oder hinzugefügt hat. Für einen Kalender, den der Benutzer erstellt oder hinzugefügt hat, wird die Eigenschaft Besitzer auf den Benutzer eingestellt. Für einen mit dem Benutzer geteilten Kalender wird die Eigenschaft Besitzer auf die Person eingestellt, die diesen Kalender mit dem Benutzer geteilt hat. | Nein | Ja |
CalendarView | Sammlung (Ereignis) | Die Kalenderansicht für den Kalender. Navigationseigenschaft. | Nein | Nein |
Ereignisse | Sammlung (Ereignis) | Die Ereignisse im Kalender. Navigationseigenschaft. | Nein | Nein |
MultiValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
SingleValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
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 der Wert-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. Dadurch kann Exchange Änderungen an der richtigen Version des Objekts vornehmen. | Nein | Nein |
ClassId | Zeichenfolge | Die Klassen-ID. | Nein | Ja |
ID | Zeichenfolge | Die eindeutige Kennung 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 |
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. Dadurch kann Exchange Änderungen an der richtigen Version des Objekts vornehmen. | Nein | Nein |
Untergeordnetes Element | Sammlung (Zeichenfolge) | Die Namen der Kinder des Kontakts. | Ja | Ja |
CompanyName | Zeichenfolge | Der Name des Unternehmens des Kontakts. | Ja | Ja |
CreatedDateTime | datetimeoffset | Die Zeit, zu der der Kontakt erstellt wurde. | Nein | Ja |
Abteilung | Zeichenfolge | Die Abteilung des Kontakts. | Ja | Ja |
Anzeigename | Zeichenfolge | Der Anzeigename des Kontakts. | Ja | Ja |
EmailAddresses | Sammlung (EmailAdresse) | Die E-Mail-Adressen des Kontakts. | Ja | Nein |
Erweiterungen | Sammlung (Erweiterung) | Die Sammlung von Datenerweiterungen offenen Typs, die für den Kontakt definiert sind. Navigationseigenschaft. | Nein | Ja |
FileAs | Zeichenfolge | Der Name, unter dem der Kontakt abgelegt ist. | Ja | Ja |
Kennzeichen | FollowupFlag | Informationen über die Nachverfolgung des Kontaktes. | Ja | Ja |
Geschlecht | Zeichenfolge | Das Geschlecht des Kontakts. | Ja | Ja |
Generation | Zeichenfolge | Die Generation des Kontakts. | Ja | Ja |
GivenName | Zeichenfolge | Der Vorname des Kontakts. | Ja | Ja |
ID | Zeichenfolge | Eindeutige Kennung des Kontakts. | 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 |
LastModifiedDateTime | datetimeoffset | Die Änderungszeit des Kontakts. | Nein | Ja |
Manager | Zeichenfolge | Der Name des Vorgesetzten des Kontakts. | Ja | Ja |
MiddleName | Zeichenfolge | Der zweite Vorname des Kontakts. | Ja | Ja |
NickName | Zeichenfolge | Der Spitzname des Kontakts. | Ja | Ja |
OfficeLocation | Zeichenfolge | Der Bürostandort des Kontakts. | Ja | Ja |
ParentFolderId | Zeichenfolge | Die ID des übergeordneten Ordners des Kontakts. | Nein | Nein |
PersonalNotes | Zeichenfolge | Die Notizen des Benutzers zu dem Kontakt. | Ja | Ja |
Telefone | Sammlung (Telefon) | Telefonnummern, die dem Kontakt zugeordnet sind, z. B. Haustelefon, Mobiltelefon und Geschäftstelefon. | Ja | Ja |
PostalAddresses | PhysicalAddress-Sammlung | Adressen, die dem Kontakt zugeordnet sind, z. B. Privatadresse und Geschäftsadresse. | Ja | Nein |
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 |
Webseiten | Sammlung (Website) | Websites, die dem Kontakt zugeordnet sind. | Ja | Nein |
WeddingAnniversary | Datum | Der Hochzeitstag des Kontaktes. | Ja | Ja |
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 |
Die Navigationseigenschaften MultiValueExtendedProperties und SingleValueExtendedProperties stehen auch für diese Ressource zur Verfügung, um Sammlungen der jeweiligen Typen von erweiterten Eigenschaften darzustellen, die für eine Ressourceninstanz definiert wurden. Weitere Informationen finden Sie unter Erweiterte Eigenschaften REST-API.
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 untergeordneten Ordnern im Ordner. Navigationseigenschaft. | Nein | Nein |
Kontakte | Sammlung (Kontakt) | Die Kontakte im Ordner. Navigationseigenschaft. | Nein | Nein |
Anzeigename | Zeichenfolge | Der Anzeigename des Ordners. | Ja | Ja |
ID | Zeichenfolge | Eindeutige Kennung des Kontaktordners. | Nein | Nein |
ParentFolderId | Zeichenfolge | Die ID des übergeordneten Ordners des Ordners. | Nein | Nein |
WellKnownName | Zeichenfolge | Der Name des Ordners, wenn der Ordner ein erkannter Ordner ist. Derzeit ist contacts der einzige erkannte Kontaktordner. |
Nein | Nein |
MultiValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
SingleValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
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-, ItemAttachment- und ReferenceAttachment-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 zugeordnet 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 |
CreatedDateTime | datetimeoffset | Datum und Uhrzeit der Erstellung des Ereignisses. | Nein | Ja |
Ende | DateTimeTimeZone | Datum und Uhrzeit für das Ende des Ereignisses. | Ja | Ja |
Erweiterungen | Sammlung (Erweiterung) | Die Sammlung von Datenerweiterungen offenen Typs, die für das Ereignis definiert sind. Navigationseigenschaft. | Nein | Ja |
HasAttachments | boolesch | „true“, wenn das Ereignis Anlagen hat | 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 für alle Instanzen eines Ereignisses in unterschiedlichen Kalendern verwendet wird | Nein | Ja |
IsAllDay | boolesch | True, wenn das Ereignis den ganzen Tag andauert. Für das Anpassen dieser Eigenschaft müssen auch die Start- und Ende-Eigenschaften des Ereignisses angepasst werden. | Ja | Ja |
IsCancelled | boolesch | „true“, wenn das Ereignis abgesagt wurde | Ja | Ja |
IsOrganizer | boolesch | „true“, wenn der Absender der Nachricht auch der Organisator ist | Ja | Ja |
IsReminderOn | Boolesch | True, wenn eine Benachrichtigung den Benutzer an das Ereignis erinnern soll. | Ja | Ja |
LastModifiedDateTime | datetimeoffset | Das Datum und die Uhrzeit, zu dem bzw. zu der das Ereignis zuletzt geändert wurde. | Nein | Ja |
Ort | Ort | Standortortinformationen des Ereignisses. | Ja | Ja |
Speicherorte | Sammlung (Ort) | Die Orte, an denen die Veranstaltung stattfindet. | Ja | Ja |
OnlineMeetingUrl | Zeichenfolge | Eine URL für eine Onlinebesprechung | Ja | Nein |
Organisator | Empfänger | Der Organisator des Ereignisses | Ja | Ja |
OriginalEndTimeZone | Zeichenfolge | Die Zeitzone, die bei der Erstellung des Ereignisses für das Ereignisende festgelegt wurde. Eine Liste der gültigen Zeitzonen finden Sie unter DateTimeTimeZone. | Nein | Ja |
OriginalStartTimeZone | Zeichenfolge | Die Zeitzone, die bei der Erstellung des Ereignisses für den Ereignisbeginn festgelegt wurde Eine Liste der gültigen Zeitzonen finden Sie unter DateTimeTimeZone. | Nein | Ja |
Serie | PatternedRecurrence | Das Serienmuster für das Ereignis. | Ja | Nein |
ReminderMinutesBeforeStart | Int32 | Festlegung, wie viele Minuten vor Beginn des Ereignisses die Erinnerung angezeigt werden soll | Ja | Nein |
ResponseRequested | boolesch | Legen Sie „True“ fest, wenn der Absender eine Antwort erhalten soll, wenn das Ereignis akzeptiert oder abgelehnt wird. | Ja | Ja |
ResponseStatus | ResponseStatus | Typ der Antwort, die als Antwort auf eine Ereignisnachricht gesendet wurde | Nein | Ja |
Vertraulichkeit | Vertraulichkeit | Gibt die Datenschutzebene für das Ereignis an: Normal , Personal , Private , Confidential . |
Ja | Ja |
SeriesMasterId | Zeichenfolge | Die dem Element zugeordneten Kategorien | Ja | Nein |
ShowAs | FreeBusyStatus | Der anzuzeigende Status: Free , Tentative , Busy , Oof , WorkingElsewhere , Unknown . |
Ja | Ja |
Start | DateTimeTimeZone | Die Startzeit des Ereignisses. | Ja | Ja |
Betreff | Zeichenfolge | Der Text der Betreffzeile des Ereignisses. | Ja | Ja |
Typ | EventType | Der Ereignistyp: SingleInstance , Occurrence , Exception , SeriesMaster . |
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 |
Die Navigationseigenschaften MultiValueExtendedProperties und SingleValueExtendedProperties stehen auch für diese Ressource zur Verfügung, um Sammlungen der jeweiligen Typen von erweiterten Eigenschaften darzustellen, die für eine Ressourceninstanz definiert wurden. Weitere Informationen finden Sie unter Erweiterte Eigenschaften REST-API.
EventMessage
Eine Nachricht, die eine Besprechungsanfrage darstellt, Nachricht über die Absage einer Besprechung, Nachricht zur Annahme einer Besprechung, Nachricht über die Zusage mit Vorbehalt oder Nachricht über das Ablehnen der Besprechung.
Basistyp: Nachricht
Eine EventMessage Instanz befindet sich gewöhnlich im Posteingangsordner, wo sie entweder ankommt, weil ein Ereignisorganisator ein Meeting erstellt, oder weil ein Teilnehmer auf eine Meetinganfrage 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. |
Erstellen einer Draft-Forward-Ereignisnachricht | 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? |
---|---|---|---|---|
EndDateTime | DateTimeTimeZone | Das Datum und die Uhrzeit, zu denen das verknüpfte Ereignis endet. | Ja | Ja |
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 Meetinganfragen eingehen. Navigationseigenschaft. | Nein | Nein |
IsAllDay | Boolesch | Gibt an, ob das Ereignis den ganzen Tag dauert. Für das Anpassen dieser Eigenschaft müssen auch die StartDateTime- und EndDateTime-Eigenschaften des Ereignisses angepasst werden. | Ja | Ja |
IsOutOfDate | Boolesch | Gibt an, ob diese Besprechungsanfrage durch eine aktuellere Anfrage veraltet ist. | Nein | Nein |
Ort | Ort | Der Ort des zugeordneten Ereignisses. | Ja | Ja |
MeetingMessageType | MeetingMessageType | Der Typ der Ereignismeldung: Keine = 0, MeetingRequest = 1, MeetingCancelled = 2, MeetingAccepted = 3, MeetingTentativelyAccepted = 4, MeetingDeclined = 5 | Nein | Ja |
Serie | PatternedRecurrence | Das Serienmuster für das zugeordnete Ereignis. | Ja | Nein |
StartDateTime | DateTimeTimeZone | Die Startzeit des zugeordneten Ereignisses. | Ja | Ja |
Typ | EventType | Der Typ des zugeordneten Ereignisses: SingleInstance = 0, Vorkommen = 1, Ausnahme = 2, SeriesMaster = 3. | Ja | Ja |
EventMessageRequest (Vorschau)
Eine Nachricht, die eine Besprechungsanfrage repräsentiert.
Basistyp: EventMessage
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
PreviousEndDateTime | DateTimeTimeZone | Das vorherige Enddatum und die vorherige Enduhrzeit der gewünschten Besprechung. | Nein | Ja |
PreviousLocation | Ort | Der vorherige Ort der gewünschten Besprechung. | Nein | Ja |
PreviousStartDateTime | DateTimeTimeZone | Das vorherige Startdatum und die vorherige Startuhrzeit der gewünschten Besprechung. | Nein | Ja |
Erweiterte Eigenschaften
Sie können eine benutzerdefinierte Eigenschaft auf einer Entität als MultiValueLegacyExtendedProperty oder SingleValueLegacyExtendedProperty erstellen, je nach den für die Eigenschaft vorgesehenen Werten.
MultiValueLegacyExtendedProperty
Eine erweiterte Eigenschaft, die eine Sammlung von mehreren Werten enthalten kann.
Typ: Microsoft.OutlookServices.MultiValueLegacyExtendedProperty
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Wert | Sammlung (Zeichenfolge) | Eine Sammlung von Eigenschaftswerten. | Ja | Nein |
PropertyId | Zeichenfolge | Die Eigenschafts-ID. Diese wird zur Identifizierung der Eigenschaft verwendet. | Nein | Nein |
SingleValueLegacyExtendedProperty
Eine erweiterte Eigenschaft, die einen einzelnen Wert enthält.
Typ: Microsoft.OutlookServices.SingleValueLegacyExtendedProperty
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Wert | Zeichenfolge | Ein Eigenschaftswert. | Ja | Nein |
PropertyId | Zeichenfolge | Die Eigenschafts-ID. Diese wird zur Identifizierung der Eigenschaft verwendet. | Nein | Ja |
Beim Erstellen einer erweiterten Eigenschaft gibt es verschiedene Möglichkeiten, die PropertyId anzugeben. Weitere Infromationen finden Sie unter PropertyId-Formate.
Informationen, welche verbundenen Operationen Sie verwenden können, finden Sie unter Erweiterte Eigenschaften REST-API-Verweis.
FileAttachment
Eine Datei (z. B. eine Textdatei oder ein Word-Dokument), die an eine Nachricht, ein Ereignis oder einer Aufgabe 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 |
Inhaltsart | Zeichenfolge | Der Inhaltstyp der Anlage. | Ja |
LastModifiedDateTime | datetimeoffset | Datum und Uhrzeit der letzten Änderung der Anlage. | Nein |
ID | Zeichenfolge | Die Anlagen-ID. | Nein |
IsInline | boolesch | True, 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 |
Schriftgrad | Int32 | Die Größe der Anlage in Byte. | Nein |
Ordner / MailFolder
Hinweis
Hinweis In der Beta-Version wurden Entität und Typ, die vorher als Ordner bekannt waren, 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.MailFolder
Eine MailFolders-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 (MailFolder) | Die Sammlung von untergeordneten Ordnern im Ordner. Navigationseigenschaft. | Nein | Nein |
Anzeigename | 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 |
MessageRules | Sammlung (MessageRule) | Die Sammlung von Regeln, die für den Posteingangsordner gelten. Navigationseigenschaft. | 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 |
WellKnownName | Zeichenfolge | Der bekannte Name des Ordners, z. B. clutter , deleteditems , drafts , inbox , junkemail , outbox oder sentitems . |
Nein | Ja |
MultiValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
SingleValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja |
Effizientes Ermitteln der Anzahl von Elementen
Mit den Eigenschaften TotalItemCount und UnreadItemCount eines 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/beta/me/mailfolders/inbox/messages?$count=true&$filter=isread%20eq%20false
Ordner in Outlook können mehr als einen Typ von Elementen enthalten, der Posteingang kann beispielsweise Meetinganfragen enthalten, die sich von E-Mail-Elementen unterscheiden. TotalItemCount und UnreadItemCount schließen Elemente in einem Ordner unabhängig von Elementtyp ein.
InferenceClassification
Klassifizierung der Nachrichten eines Benutzers, um den Fokus auf die Nachrichten zu legen, die für den Benutzer relevanter oder wichtiger sind.
Typ: Microsoft.OutlookServices.InferenceClassification
Eigenschaft | Typ | Beschreibung | Beschreibbar? |
---|---|---|---|
Außerkraftsetzungen | Sammlung (InferenceClassificationOverride) | Eine Reihe von Außerkraftsetzungen für einen Benutzer, um Nachrichten von bestimmten Absendern immer auf eine bestimmte Art und Weise zu klassifizieren, wie von InferenceClassificationType unterstützt. Navigationseigenschaft. | Ja |
InferenceClassificationOverride
Stellt die Außerkraftsetzung eines Benutzers dafür dar, wie eingehende Nachrichten von einem bestimmten Absender immer klassifiziert werden sollen.
Typ: Microsoft.OutlookServices.InferenceClassificationOverride
Eigenschaft | Typ | Beschreibung | Beschreibbar? |
---|---|---|---|
ClassifyAs | InferenceClassificationType | Gibt an, wie eingehende Nachrichten von einem bestimmten Absender immer klassifiziert werden sollen. Relevant=0, Andere=1. | Ja |
ID | Zeichenfolge | Die eindeutige Kennung der Überschreibung. | Nein |
SenderEmailAddress | EmailAddress | Die E-Mail-Adressinformationen des Absenders, für den die Außerkraftsetzung erstellt wird. | Ja |
ItemAttachment
Eine Nachricht, ein Kontakt oder ein Ereignis, das einer anderen Nachricht, einem anderen Ereignis oder einer anderen Aufgabe angehängt ist. Abgeleitet von der Anlagen-Entität.
Typ: Microsoft.OutlookServices.ItemAttachment
Basistyp: Microsoft.OutlookServices.Attachment
Eigenschaft | Typ | Beschreibung | Beschreibbar? |
---|---|---|---|
Inhaltsart | Zeichenfolge | Der Inhaltstyp der Anlage. | Ja |
LastModifiedDateTime | 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. Navigation-Eigenschaft | Ja |
IsInline | boolesch | Legen Sie diesen auf „true“ fest, 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 |
Schriftgrad | Int32 | Die Größe der Anlage in Byte. | Ja |
Erwähnung (Vorschau)
Repräsentiert eine Benachrichtigung an eine Person, die auf der der E-Mail-Adresse der Person beruht. Diese Art der Benachrichtigung wird auch als @ -Markierungen bezeichnet.
Die Nachricht-Ressource unterstützt Erwähnung. Es enthält eine MentionsPreview -Eigenschaft, die angibt, ob der angemeldete Benutzer in diesem Fall erwähnt wird, sowie die Erwähnungen -Navigationseigenschaft, die das Empfangen von Details zu jeder Erwähnung in dieser Instanz unterstützt.
Beim Erstellen einer Nachricht kann eine App eine Erwähnung in der gleichen POST
Anfrage erzeugen, indem sie die Erwähnung in die Eigenschaft Erwähnungen einfügt. Mit einer GET
Anfrage mit dem Abfrageparameter $filter
kann eine App alle Nachrichten im Postfach des angemeldeten Benutzers zurückgeben, die den Benutzer erwähnen. Eine GET
Anfrage mit dem Abfrageparameter $expand
lässt die App alle Erwähnungen in einer bestimmten Nachricht erweitern.
Dieser Mechanismus, dass eine App Erwähnungen in Nachrichten einstellen und erhalten kann, ermöglicht leichtgewichtige Benachrichtigungen, wobei der erwähnende Benutzer im bestehenden Kontext bleiben kann (z. B. beim Verfassen eines Nachrichtentextes), während die App die zugrunde liegende Erwähnungen-Eigenschaft einstellt. Erwähnte Personen können durch GET
-Anfragen mit $filter
oder dem $expand
-Abfrageparameter leicht herausfinden, ob und wo sie erwähnt werden.
Ein Beispiel für den Anwendungsfall der Erwähnungen-API ist Outlook, der Mail-Client. Wenn ein Benutzer beim Schreiben einer Nachricht @
eingibt, lässt Outlook den Benutzer einfach einen Namen auswählen oder eingeben, um die @-Erwähnung abzuschließen, ohne aus dem Kontext treten zu müssen, um die Aufmerksamkeit der Person zu erregen. Unterhalb der Abdeckung stellt Outlook die Eigenschaft Erwähnungen ein, bevor die Nachricht erstellt und gesendet wird. Outlook verwendet auch GET
-Operationen mit $filter
und $expand
, um den angemeldeten Benutzer bequem nachschlagen zu lassen, ob und welche Nachrichten den Benutzer erwähnen und den Benutzer auf Aktionselemente oder Diskussionen aufmerksam machen, damit er schneller reagieren kann.
Typ: Microsoft.OutlookServices.Mention
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Anwendung | Zeichenfolge | Der Name der Anwendung, in der die Erwähnung erstellt wird. Optional. Wird für Nachricht nicht verwendet und als Null vorgegeben. | Ja | Nein |
ClientReference | Zeichenfolge | Ein eindeutiger Bezeichner, der eine übergeordnete Instanz der Ressourceninstanz repräsentiert. Optional. Wird für Nachricht nicht verwendet und als Null vorgegeben. | Ja | Ja |
CreatedBy | EmailAddress | Die E-Mail-Informationen des Benutzers, der die Erwähnung erstellt hat. Erforderlich. | Ja | Nein |
CreatedDateTime | DateTimeOffset | Das Datum und die Uhrzeit, zu dem bzw. zu der die Erwähnung auf dem Client erstellt wird. | Nein | Nein |
DeepLink | Zeichenfolge | Ein Deep-Weblink zum Kontext der Erwähnung in der Ressourceninstanz. Optional. Wird für Nachricht nicht verwendet und als Null vorgegeben. | Ja | Nein |
ID | Zeichenfolge | Der eindeutige Bezeichner einer Erwähnung in einer Ressourceninstanz. | Nein | Nein |
Erwähnt | EmailAddress | Die E-Mail-Informationen der erwähnten Person. Erforderlich. | Ja | Nein |
MentionText | Zeichenfolge | Inhalt für die Erwähnung. Optional. Wird für Nachricht nicht verwendet und als Null vorgegeben. | Ja | Nein |
ServerCreatedDateTime | DateTimeOffset | Das Datum und die Uhrzeit, zu dem bzw. zu der die Erwähnung auf dem Server erstellt wird. Optional. Wird für Nachricht nicht verwendet und als Null vorgegeben. | Nein | Nein |
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) | Die FileAttachment und ItemAttachment Anhänge 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 |
CcEmpfänger | Sammlung (Empfänger) | Die Cc-Empfänger der Nachricht. | Ja | Nein | Ja |
ChangeKey | Zeichenfolge | Die Version der Nachricht. | Nein | Nein | Nein |
KonversationId | Zeichenfolge | Die ID der Konversation, zu der die E-Mail gehört. | Nein | Ja | Nein |
KonversationIndex | Binär | Gibt die relative Position des Elements innerhalb der Konversation an, zu der die E-Mail gehört. | Nein | Nein | Nein |
CreatedDateTime | datetimeoffset | Das Datum und die Uhrzeit, zu der die Nachricht erstellt wurde. | Nein | Ja | Nein |
Erweiterungen | Sammlung (Erweiterung) | Die Sammlung der Datenerweiterungen offenen Typs, die für die Nachricht definiert sind. Navigationseigenschaft. | Nein | Ja | Nein |
Kennzeichen | FollowupFlag | Informationen über die Nachverfolgung der Nachricht. | Ja | Ja | Ja |
Von | Empfänger | Der Postfachbesitzer und der Absender der Nachricht. | Ja | Ja | Ja |
HasAttachments | boolesch | Gibt an, ob die Nachricht Anlagen enthält. | Nein | 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 |
InferenceClassification | InferenceClassificationType | Die Klassifizierung dieser Nachricht für den Benutzer, basierend auf der abgeleiteten Relevanz oder Bedeutung oder auf einer expliziten Überschreibung. | Ja | Ja | Nein |
InternetMessageId | Zeichenfolge | Die Nachrichten-ID im von RFC2822 angegebenen Format. | Nein | Nein | Nein |
InternetNachrichtenKopfzeilen | Sammlung (InternetMessageHeader) | Die Sammlung von Internetnachrichten-Headern im von RFC2822 angegebenen Format. | Nein | Nein | Nein |
IsDeliveryReceiptRequested | boolesch | Zeigt 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 | Zeigt an, ob für die Nachricht eine Lesebestätigung angefordert wird. | Ja | Ja | Nein |
LastModifiedDateTime | datetimeoffset | Das Datum und die Uhrzeit, zu der die Nachricht zuletzt geändert wurde. | Nein | Ja | Nein |
Erwähnungen | Sammlung (Erwähnungen) | Eine Sammlung von Markierungen in der Nachricht, sortiert nach CreatedDateTime vom neuesten zum ältesten Element. Standardmäßig gibt eine GET -Nachricht diese Eigenschaft nicht zurück, es sei denn, Sie wenden $expand auf die Eigenschaft an. Navigationseigenschaft. |
Ja | Nein | Nein |
MentionsPreview | MentionsPreview | Informationen über Erwähnungen in der Nachricht. Bei der Verarbeitung einerGET /messages Anfrage stellt der Server diese Eigenschaft ein und schließt sie standardmäßig in die Antwort ein. Der Server gibt null zurück, wenn es keine Erwähnungen in der Nachricht gibt. Optional. |
Nein | Nein | Nein |
MultiValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Mehrfachwert-Eigenschaften vom Typ MultiValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja | Nein |
ParentFolderId | Zeichenfolge | Die eindeutige Kennung für den übergeordneten Ordner der Nachricht. | Nein | Nein | Nein |
ReceivedDateTime | datetimeoffset | Das Datum und die Uhrzeit, zu der die Nachricht erhalten wurde. | Nein | Ja | Ja |
ReplyTo | Sammlung (Empfänger) | Die E-Mail-Adressen, die beim Antworten verwendet werden sollen. | Nein | Nein | Nein |
Absender | Empfänger | Das Konto, das tatsächlich verwendet wird, um die Nachricht zu generieren. | Ja | Ja | Standard |
SentDateTime | datetimeoffset | Das Datum und die Uhrzeit, zu der die Nachricht gesendet wurde. | Nein | Ja | Nein |
SingleValueExtendedProperties | Eine Sammlung | Eine Sammlung von erweiterten Einwert-Eigenschaften vom Typ SingleValueLegacyExtendedProperty. Dies ist eine Navigationseigenschaft. Weitere Informationen über erweiterte Eigenschaften. |
Ja | Ja | Nein |
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 |
UnsubscribeData | Sammlung (Zeichenfolge) | Dieser enthält die gültigen Einträge aus dem List-Unsubscribe -Header. Wenn die UnsubscribeEnabled-Eigenschaft true ist, würde dies die Daten für den Befehl mailto: im List-Unsubscribe -Header enthalten. Die Daten müssen RFC-2369 entsprechen. Beenden Sie mit der Aktion Abbestellen, dass zukünftige Nachrichten an die entsprechende Verteilerliste gesendet werden. |
Nein | Nein | Nein |
UnsubscribeEnabled | boolesch | Gibt an, ob diese Nachricht einem Empfänger das Abbestellen erlaubt und das Senden zukünftiger Nachrichten nach einer E-Mail-Verteilerliste beendet. True wenn der List-Unsubscribe -Header mit RFC-2369 übereinstimmt. |
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
Einstellung 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)
Eine Regel, die auf Nachrichten im Posteingang eines Benutzers angewendet wird.
Typ: Microsoft.OutlookServices.MessageRule
Eigenschaft | Typ | Beschreibung | Beschreibbar? |
---|---|---|---|
Aktionen | MessageRuleActions | Aktionen, die auf eine Nachricht angewendet werden, wenn die entsprechenden Bedingungen erfüllt sind. | Ja |
Bedingungen | NachrichtenRegelPrädikate | Bedingungen, die bei Erfüllung die entsprechenden Aktionen für diese Regel auslösen. | Ja |
Anzeigename | Zeichenfolge | Der Anzeigename der Regel. | Ja |
Ausnahmen | NachrichtenRegelPrädikate | Ausnahmebedingungen für die Regel. | Ja |
HatFehler | Boolesch | Gibt an, ob sich die Regel in einem Fehlerzustand befindet. | Nein |
IsEnabled | Boolesch | Gibt an, ob die Regel auf Nachrichten angewendet werden kann. | Ja |
IsReadOnly | Boolesch | Gibt an, ob die Regel schreibgeschützt ist und von der Regel-REST-API nicht geändert oder gelöscht werden kann. | Ja |
Sequenz | Int32 | Gibt die Reihenfolge an, in der die Regel zusammen mit anderen Regeln ausgeführt wird. | Ja |
OutlookCategory (Vorschau)
Typ: Microsoft.OutlookServices.OutlookCategory
Eine Kategorie, anhand der ein Benutzer Outlook-Elemente, z. B. Nachrichten und Ereignisse, in seinem Postfach gruppieren kann.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Anzeigename | Zeichenfolge | Ein eindeutiger Name für diese Kategorie im Postfach des Benutzers. | Nein | Ja |
Farbe | CategoryColor | Eine voreingestellte Konstante, die die zugeordnete Farbe für diese Kategorie rpräsentiert. | Ja | Ja |
Foto
Typ: Microsoft.OutlookServices.Photo
Ein Foto, auf das von Exchange Online aus zugegriffen werden kann. Es sind Binärdaten, die nicht in base-64 kodiert sind.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Höhe | int | Die Höhe des Fotos | Nein | Nein |
ID | Zeichenfolge | Der eindeutige Bezeichner des Fotos. | Nein | Nein |
Breite | int | Die Breite des Fotos. | Nein | Nein |
ReferenzAnhang
Typ: Microsoft.OutlookServices.ReferenceAttachment
Basistyp: Microsoft.OutlookServices.Attachment
Eine Verknüpfung zu einer Datei oder einem Ordner, der einer Nachricht, einem Ereignis oder einer Aufgabe angefügt ist. Mögliche Speicherorte für die Datei oder den Ordner sind OneDrive, OneDrive for Business und DropBox. Abgeleitet von der Anlagen-Entität.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
Inhaltsart | Zeichenfolge | Der MIME-Typ der Anlage. Optional. | Ja | Nein |
ID | Zeichenfolge | Der eindeutige Bezeichner der Verweisanlage. | Nein | Nein |
IsFolder | Boolesch | Gibt an, ob die Anlage ein Verknüpfung zu einem Ordner ist. Muss auf wahr eingstellt werden, wenn SourceUrl eine Verknüpfung zu einem Ordner ist. Optional. | Ja | Nein |
IsInline | Boolesch | true , wenn die Anlage eine Inlineanlage ist, andernfalls false . Optional. |
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''. Optional. | Nein | Ja |
Name | Zeichenfolge | Der Anzeigename der Anlage. Dies muss nicht der aktuelle Dateiname sein. Erforderlich. | Ja | Ja |
Berechtigung | ReferenceAttachmentPermissions | Gibt die Berechtigungen an, die für die Anlage vom Anbietertyp in ProviderType vergeben werden. Mögliche Werte sind: Other , View , Edit , AnonymousView , AnonymousEdit , OrganizationView und OrganizationEdit . Optional. |
Ja | Nein |
Vorschau-URL | Zeichenfolge | Gilt nur für eine Verweisanlage eines Bildes - URL, um ein Vorschaubild zu erhalten. Verwenden Sie ThumbnailUrl und PreviewUrl nur, wenn SourceUrl eine Bilddatei identifiziert. Optional. | Ja | Nein |
ProviderType | ReferenceAttachmentProviders | Der Typ des Anbieters, der eine Anlage dieses ContentType unterstützt. Mögliche Werte: sind Other , OneDriveBusiness , OneDriveConsumer und Dropbox . Optional. |
Ja | Ja |
Schriftgrad | Int32 | Die Länge der Anlage in Byte. Optional. | Nein | Nein |
SourceUrl | Zeichenfolge | URL, um den Inhalt der Anlage abzurufen. Wenn dies eine URL zu einem Ordner ist, dann stellen Sie IsFolder auf wahr ein, damit der Ordner in Outlook oder in Outlook im Web korrekt angezeigt wird. Erforderlich. | Ja | Nein |
ThumbnailUrl | Zeichenfolge | Gilt nur für eine Verweisanlage eines Bildes - URL, um ein Minaturansichtsbild zu erhalten. Verwenden Sie ThumbnailUrl und PreviewUrl nur, wenn SourceUrl eine Bilddatei identifiziert. Optional. | Ja | Nein |
Aufgabe
Typ: Microsoft.OutlookServices.Task
Ein Outlook-Element, das eine Arbeitsaufgabe nachverfolgen kann. Sie können mit einer Aufgabe den Start, die fälligen und tatsächliche Fertigstellungstermine und -zeiten, ihren Fortschritt oder Status nachzuverfolgen, unabhängig davon, ob es sich um eine periodische Aufgabe handelt, die eine Erinnerung erfordert.
Für jede der folgenden datumsbezogenen Eigenschaften:
- CompletedDateTime
- CreatedDateTime
- DueDateTime
- LastModifiedDateTime
- ReminderDateTime
- StartDateTime
Wenn die Eigenschaft eingestellt ist, gibt die Aufgaben-REST-API sie standardmäßig in UTC in einer REST-Antwort zurück. Weitere Informationen zu Einstellung von StartDateTime und DueDateTime und Rückgabe von datumsbezogenen Eigenschaften in einer benutzerdefinierten Zeitzone.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
AssignedTo | Zeichenfolge | Der Name der Person, der die Aufgabe zugwiesen wurde. | Nein | Ja |
Anlagen | Sammlung (Anlage) | Die Sammlung von FileAttachment-, ItemAttachment- und ReferenceAttachment-Anlagen für die Aufgabe. Navigationseigenschaft. | Nein | Nein |
Text | ItemBody | Der Aufgabentext, der typischerweise Informationen über die Aufgabe enthält. Beachten Sie, dass nur der HTML-Typ unterstützt wird. | Ja | Nein |
Kategorien | Sammlung (Zeichenfolge) | Die der Aufgabe zugeordneten Kategorien. | Ja | Ja |
ChangeKey | Zeichenfolge | Die Version der Aufgabe. | Nein | Nein |
CompletedDateTime | DateTimeTimeZone | Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beendet wurde. | Ja | Ja |
CreatedDateTime | DateTimeOffset | Das Datum und die Uhrzeit der Erstellung der Aufgabe. Standardmäßig ist es in UTC. Sie können eine benutzerdefinierte Zeitzone im Anforderungsheader angeben. | Nein | Ja |
DueDateTime | DateTimeTimeZone | Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beendet werden soll. | Ja | Ja |
HasAttachments | boolesch | Wird auf wahr eingestellt, wenn die Aufgabe Anhänge hat. | Nein | Ja |
ID | Zeichenfolge | Der eindeutige Bezeichner der Aufgabe. | Nein | Nein |
Wichtigkeit | Wichtigkeit | Die Wichtigkeit des Ereignisses: Low , Normal , High . |
Ja | Ja |
IsReminderOn | boolesch | Auf "True" setzen, wenn eine Warnung eingerichtet ist, um den Benutzer an die Aufgabe zu erinnern. | Ja | Nein |
LastModifiedDateTime | DateTimeOffset | Das Datum und die Uhrzeit der letzten Änderung der Aufgabe. Standardmäßig ist es in UTC. Sie können eine benutzerdefinierte Zeitzone im Anforderungsheader angeben. | Nein | Ja |
Besitzer | Zeichenfolge | Der Name der Person, die die Aufgabe erstellt hat. | Nein | Ja |
ParentFolderId | Zeichenfolge | Der eindeutige Bezeichner für den übergeordneten Ordner der Aufgabe. | Nein | Nein |
Serie | PatternedRecurrence | Das Serienmuster für die Aufgabe. | Ja | Nein |
ReminderDateTime | DateTimeTimeZone | Das Datum und die Uhrzeit für das Auftreten einer Erinnerungsbenachrichtigung der Aufgabe. | Ja | Nein |
Vertraulichkeit | Vertraulichkeit | Gibt die Datenschutzebene für das Ereignis an: Normal , Personal , Private , Confidential . |
Ja | Ja |
StartDateTime | DateTimeTimeZone | Das Datum in der angegebenen Zeitzone, an dem die Aufgabe beginnen soll. | Ja | Ja |
Status | AufgabeStatus | Zeigt den Status oder Fortschritt der Aufgabe an: NotStarted , InProgress , Completed , WaitingOnOthers , Deferred . |
Ja | Ja |
Betreff | Zeichenfolge | Eine kurze Beschreibung oder ein Titel der Aufgabe. | Ja | Ja |
AufgabeOrdner
Typ: Microsoft.OutlookServices.TaskFolder
Ein Ordner, der Aufgaben enthält. In Outlook enthält die Standardaufgabengruppe My Tasks
einen Standardaufgabenordner, Tasks
, für das Postfach des Benutzers. Sie können diese Standardaufgabengruppe und diesen Standardaufgabenordner nicht umbenennen oder löschen, aber Sie können weitere Aufgabengruppen und -ordner erstellen.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
ChangeKey | Zeichenfolge | Die Version des Aufgabenordners. | Nein | Nein |
ID | Zeichenfolge | Der eindeutige Bezeichner des Aufgabenordners. | Nein | Nein |
IstStandardOrdner | Boolesch | Wahr, wenn der Ordner der Standardaufgabenordner ist. | Nein | Ja |
Name | Zeichenfolge | Der Name des Aufgabenordners. | Ja | Ja |
ParentGroupKey | Edm.Guid | Der eindeutige GUID-Bezeichner für die übergeordnete Gruppe des Aufgabenordners. | Nein | Nein |
Aufgaben | Sammlung (Aufgabe) | Die Aufgaben in dieser Aufgabenordner. Navigationseigenschaft. | Nein | Nein |
AufgabenGruppe
Typ: Microsoft.OutlookServices.TaskGroup
Eine Gruppe von Ordnern, die Aufgaben enthalten. In Outlook gibt es eine My Tasks
-Standardaufgabengruppe, die Sie nicht umbenennen oder löschen können. Sie können jedoch weitere Aufgabengruppen erstellen.
Eigenschaft | Typ | Beschreibung | Beschreibbar? | Filterbar? |
---|---|---|---|---|
ChangeKey | Zeichenfolge | Die Version der Aufgabengruppe. | Nein | Nein |
GruppenSchlüssel | Edm.Guid | Der eindeutige GUID-Bezeichner für die Aufgabengruppe. | Nein | Nein |
ID | Zeichenfolge | Die eindeutige Kennung der Aufgabengruppe. | Nein | Nein |
IstStandardGruppe | Boolesch | Wahr, wenn die Aufgabengruppe die Standardaufgabengruppe ist. | Nein | Ja |
Name | Zeichenfolge | Der Name der Aufgabengruppe. | Ja | Ja |
AufgabenOrdner | Sammlung (TaskFolder) | Die Aufgabenordner in dieser Aufgabengruppe. Navigationseigenschaft. | Nein | Nein |
Benutzer
Ein Benutzer im System. Der Me-Endpunkt wird als Verknüpfung zur Angabe des aktuellen Benutzers über die SMTP-Adresse ( users/sadie@contoso.com
) bereitgestellt.
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
Die Benutzer 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 |
KalenderGruppen | 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 |
KontaktOrdner | Sammlung (ContactFolder) | Die Kontaktordner des Benutzers. Navigationseigenschaft. | Nein | Nein |
Kontakte | Sammlung (Kontakt) | Die Kontakte des Benutzers. Navigationseigenschaft. | Nein | Nein |
Anzeigename | 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 |
ID | Zeichenfolge | Die eindeutige ID des Benutzers. | Nein | Nein |
InferenceClassification | InferenceClassification | Relevanzklassifizierung von Nachrichten des Benutzers basierend auf expliziten Kennzeichnungen, die die abgeleitete Relevanz oder Wichtigkeit außer Kraft setzen. Navigationseigenschaft. | Ja | Ja |
MailboxGuid | GUID | Die dem Postfach des Benutzers zugeordnete GUID. | Nein | Ja |
MailboxSettings | MailboxSettings | Einstellungen für das primäre Postfach des angemeldeten Benutzers. | Ja | Nein |
MailOrdner | Sammlung (MailFolder) | Die Ordner in einem Postfach. Navigationseigenschaft. | Nein | Nein |
MasterCategories | Sammlung (OutlookCategory) | Die Masterliste der Kategorien des Benutzers. Navigationseigenschaft. | Ja | Ja |
Nachrichten | Sammlung (Message) | Die Nachrichten in einem Postfach oder Ordner. Navigationseigenschaft. | Nein | Nein |
RootFolder | MailOrdner | Der Stammordner des Postfachs des Benutzers. Navigationseigenschaft. | Nein | Nein |
Komplexe Typen
- Teilnehmer
- AttendeeAvailability
- AttendeeBase
- AutomaticRepliesMailTips (Vorschau)
- AutomaticRepliesSetting
- DateTimeTimeZone
- EmailAddress
- Fehler (Vorschau)
- FollowUpFlag (Vorschau)
- GeoCoordinates
- InternetMessageHeader (Vorschau)
- ItemBody
- LocaleInfo
- Ort
- LocationConstraint
- LocationConstraintItem
- MailboxSettings
- E-Mail-Infos (Vorschau)
- MeetingTimeSuggestion
- MeetingTimeSuggestionsResult
- MentionsPreview (Vorschau)
- MessageRuleActions (Vorschau)
- MessageRulePredicates (Vorschau)
- PatternedRecurrence
- Telefon (Vorschau)
- PhysischeAdresse
- Empfänger
- WiederholungsMuster
- WiederholungsBereich
- ResponseStatus
- GrößenBereich (Vorschau)
- TimeConstraint
- ZeitFenster
- ZeitZonenInformation (Vorschau)
- Webseite (Vorschau)
- ArbeitsStunden (Vorschau)
Teilnehmer
Ein Teilnehmer eines Ereignisses.
Typ: Microsoft.OutlookServices.AttendeeBase
Eigenschaft | Typ | Beschreibung |
---|---|---|
Status | ResponseStatus | Die Antwort (keine, akzeptiert, abgelehnt usw.) und die Zeit. |
AttendeeAvailability
Typ und Verfügbarkeit eines Teilnehmers
Typ: Microsoft.OutlookServices.AttendeeAvailability
Eigenschaft | Typ | Beschreibung |
---|---|---|
Teilnehmer | AttendeeBase | Der Typ des Teilnehmers - ob es sich um eine Person oder eine Ressource handelt. |
Verfügbarkeit | FreeBusyStatus | Der Verfügbarkeitsstatus des Teilnehmers. |
AttendeeBase
Der Typ eines Teilnehmers.
Typ: Microsoft.OutlookServices.Recipient
Eigenschaft | Typ | Beschreibung |
---|---|---|
Typ | TeilnehmerTyp | Der Typ des Teilnehmers. Mögliche Werte sind: Required , Optional und Resource . Hinweis: Wenn der Teilnehmer eine Person ist, berücksichtigt FindMeetingTimes immer, dass die Person vom Typ Required ist. |
AutomaticRepliesMailTips (Vorschau)
Mail-Tipps zu automatischen Antworten, die auf einem Postfach eingerichtet sind.
Typ: Microsoft.OutlookServices.AutomaticRepliesMailTips
Eigenschaft | Typ | Beschreibung |
---|---|---|
Nachricht | Zeichenfolge | Die Nachricht der automatischen Antwort. |
NachrichtenSprache | LocaleInfo | Die Sprache der Nachricht der automatischen Antwort. |
ScheduledStartTime | DateTimeTimeZone | Datum und Uhrzeit, für die der Beginn der automatischen Antworten festgelegt wurde. |
ScheduledEndTime | DateTimeTimeZone | Das Datum und die Uhrzeit, die für das Ende der automatischen Antworten festgelegt wurde. |
AutomaticRepliesSetting
Konfigurationseinstellungen zum automatischen Benachrichtigen des Absenders bei eingehenden E-Mails mit einer Nachricht vom angemeldeten Benutzer. Beispiel: eine automatische Antwort, die darüber informiert, dass der angemeldete Benutzer zur Beantwortung von E-Mails nicht verfügbar ist.
Typ: Microsoft.OutlookServices.AutomaticRepliesSetting
Eigenschaft | Typ | Beschreibung |
---|---|---|
ExternalAudience | ExternalAudienceScope | Die Benutzergruppe außerhalb der Organisation des angemeldeten Benutzers, der ExternalReplyMessage erhält, wenn Status AlwaysEnabled oder Scheduled ist. Werte sind None = 0, ContactsOnly = 1 oder All = 2. |
ExternalReplyMessage | Zeichenfolge | Die automatische Antwort an die angegebene externe Zielgruppe, wenn Status AlwaysEnabled oder Scheduled ist. |
InternalReplyMessage | Zeichenfolge | Die automatische Antwort an die interne Zielgruppe in der Organisation des angemeldeten Benutzers, wenn Status AlwaysEnabled oder Scheduled ist. |
GeplantesEndDatum | DateTimeTimeZone | Datum und Uhrzeit, die zum Beenden der automatischen Antworten festgelegt werden, wenn Status auf Scheduled gesetzt ist. Sie können die Zeitzone mit dem Prefer: outlook.timezone -HTTP-Header im GET-Vorgang einstellen. |
ScheduledStartDateTime | DateTimeTimeZone | Datum und Uhrzeit, die für den Beginn der automatischen Antworten festgelegt werden, wenn Status auf Scheduled gesetzt ist. Sie können die Zeitzone mit dem Prefer: outlook.timezone -HTTP-Header im GET-Vorgang einstellen. |
Status | AutomaticRepliesStatus | Konfigurationsstatus für automatische Antworten: Disabled = 0, AlwaysEnabled = 1, Scheduled = 2. |
DateTimeTimeZone
Beschreibt das Datum, die Uhrzeit und Zeitzone eines Zeitpunkts.
Eigenschaft | Typ | Beschreibung |
---|---|---|
DateTime | DateTime | Ein bestimmter Zeitpunkt in einer kombinierten Datums- und Uhrzeitsdarstellung (<date>T<time> ) gemäß des ISO 8601Formats |
ZeitZone | Zeichenfolge | Einer der folgenden Zeitzonennamen. |
Die Eigenschaft TimeZone kann auf eine beliebige, von Windows unterstützte Zeitzone und auf einen der folgenden Zeitzonennamen eingestellt werden . Weitere Informationen finden Sie unter TimeZone.
Etc/GMT+12
Etc/GMT+11
Pazifik/Honolulu
Amerika/Anchorage
Amerika/Santa_Isabel
Amerika/Los_Angeles
Amerika/Phoenix
Amerika/Chihuahua
Amerika/Denver
Amerika/Guatemala
Amerika/Chicago
Amerika/Mexico_Stadt
Amerika/Regina
Amerika/Bogota
Amerika/New_York
Amerika/Indiana/Indianapolis
Amerika/Caracas
Amerika/Asuncion
Amerika/Halifax
Amerika/Cuiaba
Amerika/La_Paz
Amerika/Santiago
Amerika/St_Johns
Amerika/Sao_Paulo
Amerika/Argentinien/Buenos_Aires
Amerika/Cayenne
Amerika/Godthab
Amerika/Montevideo
Amerika/Bahia
Etc/GMT+2
Atlantik/Azoren
Atlantik/Kap_Verde
Afrika/Casablanca
Etc/GMT
Europa/London
Atlantik/Reykjavik
Europa/Berlin
Europa/Budapest
Europa/Paris
Europa/Warschau
Afrika/Lagos
Afrika/Windhoek
Europa/Bukarest
Asien/Beirut
Afrika/Kairo
Asien/Damaskus
Afrika/Johannesburg
Europa/Kiew
Europa/Istanbul
Asien/Jerusalem
Asien/Amman
Asien/Bagdad
Europa/Kaliningrad
Asien/Riad
Afrika/Nairobi
Asien/Teheran
Asien/Dubai
Asien/Baku
Europa/Moskau
Indisch/Mauritius
Asien/Tiflis
Asien/Eriwan
Asien/Kabul
Asien/Karatschi
Asien/Taschkent
Asien/Kolkata
Asien/Colombo
Asien/Katmandu
Asien/Almaty
Asien/Dhaka
Asien/Jekaterinburg
Asien/Rangun
Asien/Bangkok
Asien/Nowosibirsk
Asien/Shanghai
Asien/Krasnojarsk
Asien/Singapur
Australien/Perth
Asien/Taipeh
Asien/Ulan-Bator
Asien/Irkutsk
Asien/Tokio
Asien/Seoul
Australien/Adelaide
Australien/Darwin
Australien/Brisbane
Australien/Sydney
Pazifik/Port_Moresby
Australien/Hobart
Asien/Jakutsk
Pazifik/Guadalcanal
Asien/Wladiwostok
Pazifik/Auckland
Etc/GMT-12
Pazifik/Fidschi
Asien/Magadan
Pazifik/Tongatapu
Pazifik/Apia
Pazifik/Kiritimati
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 Organisation. |
Fehler (Vorschau)
Ein Fehler, der während einer Aktion auftritt.
Typ: Microsoft.OutlookServices.Error
Eigenschaft | Typ | Beschreibung |
---|---|---|
Nachricht | Zeichenfolge | Die Fehlermeldung. |
Code | Zeichenfolge | Der Fehlercode. |
FollowUpFlag (Vorschau)
Informationen über das Nachverfolgen einer Ressourceninstanz.
Typ: Microsoft.OutlookServices.FollowupFlag
Eigenschaft | Typ | Beschreibung |
---|---|---|
CompletedDateTime | DateTimeTimeZone | Datum und Uhrzeit, zu dem bzw. der die Nachverfolgung beendet wurde. |
DueDateTime | DateTimeTimeZone | Datum und Uhrzeit, zu dem bzw. der die Weiterverfolgung beendet sein muss. |
StartDateTime | DateTimeTimeZone | Datum und Uhrzeit, zu dem bzw. der die Weiterverfolgung beginnen soll. |
FlagStatus | FollowupFlagStatus | Repräsentiert, ob die übergeordnete Ressourceninstanz zur Nachverfolgung gekennzeichnet ist oder ob ihre Nachverfolgung abgeschlossen ist. |
GeoCoordinates
Die geografischen Koordinaten und die Erhebung 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. |
AltitudeGenauigkeit | doppelt | Die Genauigkeit des Sensors, der die Höhe liefert. |
InternetMessageHeader (Vorschau)
Ein Schlüssel / Wert-Paar, das einen Internet-Nachrichtenheader in dem von RFC2822 angegebenen Format darstellt, das Details zum Netzwerkpfad enthält, der von einer Nachricht vom Absender zum Empfänger verwendet wird.
Typ: Microsoft.OutlookServices.InternetMessageHeader
Eigenschaft | Typ | Beschreibung |
---|---|---|
Name | Zeichenfolge | Der Schlüssel im Schlüssel-Wert-Paar des Internet-Nachrichtenkopfs. |
Wert | Zeichenfolge | Der Wert im Schlüssel-Wert-Paar des Internet-Nachrichtenkopfs. |
ItemBody
Der Textinhalt einer Nachricht oder eines Ereignisses.
Typ: Microsoft.OutlookServices.ItemBody
Eigenschaft | Typ | Beschreibung |
---|---|---|
Inhaltsart | TextTyp | Der Inhaltstyp: Text = 0, HTML = 1. |
Inhalt | Zeichenfolge | Der Text- oder HTML-Inhalt. |
LocaleInfo
Die Gebietsschemainformationen, einschließlich der bevorzugten Sprache und Land/Region, des angemeldeten Benutzers.
Typ: Microsoft.OutlookServices.LocaleInfo
Eigenschaft | Typ | Beschreibung |
---|---|---|
Anzeigename | Zeichenfolge | Ein Name, der ein Gebietsschema durch seine natürliche Sprache repräsentiert, z. B. "Englisch (USA)". |
Gebietsschema | Zeichenfolge | Die Gebietsschemadarstellung, einschließlich der bevorzugten Sprache und des Lands/der Region. Zum Beispiel "en-us". Die Sprachkomponente besteht entsprechend der Definitionen in ISO 639-1 aus 2 Buchstaben, und die Länderkomponente besteht entsprechend der Definitionen in ISO 3166-1-Alpha-2 aus 2 Buchstaben. |
Ort (Vorschau)
Der Ort eines Ereignisses.
Typ: Microsoft.OutlookServices.Location
Eigenschaft | Typ | Beschreibung |
---|---|---|
Adresse | PhysischeAdresse | Die physische Adresse des Ortes. |
Koordinaten | GeoCoordinates | Die geografischen Koordinaten und die Erhebung des Orts. |
Anzeigename | Zeichenfolge | Der Name, der mit dem Ort verknüpft ist |
LocationEmailAddress | Zeichenfolge | Optionale E-Mail-Adresse des Orts |
LocationUri | Zeichenfolge | Optionaler URI, der den Ort darstellt. |
OrtsTyp | OrtsTyp | Der Typ des Ortes: Default , ConferenceRoom , HomeAddress , BusinessAddress ,GeoCoordinates , StreetAddress , Hotel , Restaurant , LocalBusiness , PostalAddress . |
LocationConstraint
Die vom Clienten definierten Bedingungen für den Ort eines Meetings.
Typ: Microsoft.OutlookServices.LocationConstraint
Eigenschaft | Typ | Beschreibung |
---|---|---|
IsRequired | boolesch | Der Client fordert vom Dienst, in die Antwort einen Besprechungsort für die Besprechung aufzunehmen. |
SuggestLocation | boolesch | Der Client fordert den Dienst auf, einen oder mehrere Besprechungsorte vorzuschlagen. |
Speicherorte | Sammlung (LocationConstraintItem) | Einer oder mehrere Orte, die der Client für ein Meeting anfordert. |
LocationConstraintItem
Die von einem Client angegebenen Bedingungen für die Überprüfung der Verfügbarkeit eines jeden Ortes einer Besprechung und andere Informationen über den Ort.
Typ: Microsoft.OutlookServices.Location
Eigenschaft | Typ | Beschreibung |
---|---|---|
ResolveAvailability | boolesch | Wenn wahr eingestellt ist und die angegebene Ressource gebucht ist, sucht FindMeetingTimes nach einer anderen, freien Ressource. Wenn dieser Wert auf "false" gesetzt ist und die angegebene Ressource ausgelastet ist, gibtFindMeetingTimes die Ressource zurück, die am besten im Cache des Benutzers platziert wurde, ohne zu überprüfen, ob sie frei ist. Der Standardwert ist „true“. |
E-Mail-Info (Vorschau)
Informative Nachrichten, die dem Benutzer während der Erstellung einer Nachricht angezeigt werden. Zum Beispiel eine Abwesenheitsnachricht als automatische Antwort für einen Nachrichtenempfänger.
Typ: Microsoft.OutlookServices.MailTips
Eigenschaft | Typ | Beschreibung |
---|---|---|
EmailAddress | EmailAddress | Die E-Mail-Adresse des Empfängers, für den Sie E-Mail-Info erhalten möchten. |
AutomatischeAntworten | AutomatischeAntwortenMailTipps | E-Mail-Info für die automatische Antwort, wenn sie vom Empfänger eingerichtet wurde. |
PostfachVoll | Boolesch | Der Status Postfach voll des Empfängers. |
CustomMailTip | Zeichenfolge | Eine benutzerdefinierte E-Mail-Info, die auf dem Postfach des Empfängers eingestellt werden kann. |
ExternalMemberCount | Int32 | Die Anzahl der externen Mitglieder, wenn der Empfänger eine Verteilerliste ist. |
TotalMemberCount | Int32 | Die Anzahl der Mitglieder, wenn der Empfänger eine Verteilerliste ist. |
DeliveryRestricted | Boolesch | Ob das Postfach des Empfängers eingeschränkt ist, z. B. nur Nachrichten von einer vordefinierten Liste von Absendern annehmen, Nachrichten von einer vordefinierten Liste von Absendern ablehnen oder nur Nachrichten von authentifizierten Absendern annehmen. |
IsModerated | Boolesch | Ob das Versenden von Nachrichten an den Empfänger eine Genehmigung benötigt. Zum Beispiel, wenn der Empfänger eine große Verteilerliste ist und ein Moderator eingerichtet wurde, um an diese Verteilerliste gesendete Nachrichten zu genehmigen, oder wenn das Senden von Nachrichten an einen Empfänger die Genehmigung des Managers des Empfängers benötigt. |
RecipientScope | RecipientScopeType | Der Bereich des Empfängers, z. B. intern, extern, Partner. Beispielsweise kann ein Administrator eine andere Organisation als "Partner" festlegen. Der Bereich ist nützlich, wenn ein Administrator möchte, dass bestimmte E-Mail-Info für bestimmte Bereiche zugänglich sind. Es ist auch nützlich, die Absender darüber zu informieren, dass ihre Nachricht die Organisation verlassen kann, um ihnen bei den richtigen Entscheidungen über Wortlaut, Ton und Inhalt zu helfen. |
EmpfängerVorschläge | Sammlung (Empfänger) | Empfänger, die auf der Grundlage früherer Kontexte vorgeschlagen werden, in denen sie in der gleichen Nachricht erscheinen. |
MaxNachrichtenGröße | Int32 | Die maximale Nachrichtengröße, die für die Organisation oder das Postfach des Empfängers konfiguriert wurde. |
Fehler | Fehler | Fehler, die während der Aktion GetMailTips auftreten. |
MailboxSettings
Einstellungen für das primäre Postfach des Benutzers.
Typ: Microsoft.OutlookServices.MailboxSettings
Eigenschaft | Typ | Beschreibung |
---|---|---|
AutomaticRepliesSetting | AutomaticRepliesSetting | Einstellungen, um das automatische Senden von Antworten auf eingehende Nachrichten zu konfigurieren. |
ZeitZone | Zeichenfolge | Die Standardzeitzone für das Postfach des Benutzers. |
Sprache | LocaleInfo | Die Gebietsschemainformationen des Benutzers, einschließlich der bevorzugten Sprache und Land/Region. |
ArbeitsStunden | ArbeitsStunden | Die Wochentage und Zeiten in einer bestimmten Zeitzone, an bzw. zu denen der Benutzer arbeitet. |
MeetingTimeSuggestion
Ein Meetingvorschlag, der Informationen wie Meetingzeit, Anwesenheitswahrscheinlichkeit, individuelle Teilnehmerverfügbarkeit und verfügbare Meetingsorte enthält.
Typ: Microsoft.OutlookServices.MeetingTimeSuggestion
Eigenschaft | Typ | Beschreibung |
---|---|---|
MeetingZeitFenster | ZeitFenster | Ein für die Besprechung vorgeschlagenes Zeitfenster |
Zuverlässigkeit | doppelt | Ein Prozentwert, der angibt, wie hoch die Wahrscheinlichkeit ist, dass alle Teilnehmer teilnehmen können. |
OrganizerAvailability | FreeBusyStatus | Die Verfügbarkeit des Besprechungsorganisators für diesen Besprechungsvorschlag: Free , Tentative , Busy , Oof , WorkingElsewhere und Unknown . |
AttendeeAvailability | Sammlung (AttendeeAvailability) | Ein Array, das den Verfügbarkeitsstatus jedes Teilnehmers für den betreffenden Besprechungsvorschlag anzeigt |
Speicherorte | Sammlung (Ort) | Ein Array, das den Namen und den geografischen Ort jedes Besprechungsorts für den betreffenden Besprechungsvorschlag angibt |
SuggestionReason | Zeichenfolge | Beschreibt die Gründe für den Vorschlag der Besprechungszeit. |
Die Gewissheit eines Meetings
Die Eigenschaft Conficence eines MeetingZeitVorschlags liegt in einem Bereich von 0 % bis 100 %. Sie gibt an, wie wahrscheinlich es ist, dass alle Teilnehmer an der Besprechung teilnehmen können, und basiert auf dem Frei-/Beschäftigt-Status der einzelnen Teilnehmer:
- Für jeden Teilnehmer gilt: Ist der Status für eine Besprechung „Frei“, liegt die Teilnahmewahrscheinlichkeit bei 100 %. Beim Status „Unbekannt“ liegt sie bei 49 %, beim Status „Gebucht“ bei 0 %.
- Zur Berechnung der Gewissheit eines Kandidaten für einen Meetingtermin wird der Mittelwert aus den individuellen Teilnahmewahrscheinlichkeiten aller Meetingteilnehmer für das betreffende Meeting gebildet.
- Sie können den Parameter MinimumAttendeePercentage optional für FindMeetingTimes verwenden, um nur ein Besprechungszeitfenster mit mindestens einem bestimmten Konfidenzniveau anzugeben. Beispielsweise können Sie eine MinimumAttendeePercentage von 80 % angeben, wenn Sie nur Vorschläge wünschen, die eine Wahrscheinlichkeit von 80 % oder mehr haben, dass alle Teilnehmer teilnehmen. Wenn Sie MinimumAttendeePercentage nicht angeben, nimmt FindMeetingTimes einen Wert von 50 % an.
- Wenn es mehrere Kandidaten für den Meetingtermin gibt, ordnet die FindMeetingTimes-Aktion die Kandidaten zunächst nach ihrem berechneten Konfidenzwert ein, beginnend mit dem Kandidaten mit dem höchsten Wert. Wenn es Kandidaten mit dem gleichen Konfidenzwert gibt, ordnet die Aktion diese Kandidaten chronologisch.
Hier ein Beispiel für ein Meetingzeitfenster für drei Teilnehmer mit folgendem Frei-/Beschäftigt-Status:
Teilnehmer | Frei/Gebucht-Status | Teilnahmewahrscheinlichkeit in % |
---|---|---|
Dana | Frei | 100 % |
John | Unbekannt | 49 % |
Fanny | Gebucht | 0 % |
Die Konfidenz des Besprechungs-Zeitfensters (durchschnittliche Teilnahmewahrscheinlichkeit) liegt hier bei (100 % + 49 % + 0 %) ÷ 3 = 49,66 %.
Wenn Sie eine MinimumAttendeePercentage von 80 % in einer Operation des Typs FindMeetingTimes festlegen, wird die Operation dieses Zeitfenster nicht in der Antwort vorschlagen, da 49,66 % < 80 % ist.
MeetingTimeSuggestionsResult
Dieser Ressourcentyp listet eine Sammlung von Besprechungsvorschlägen auf, sofern Vorschläge zurückgegeben werden, oder den Grund, aus dem keine Vorschläge zurückgegeben werden.
Typ: Microsoft.OutlookServices.MeetingTimeSuggestionsResult
Eigenschaft | Typ | Beschreibung |
---|---|---|
MeetingZeitVorschläge | Sammlung (MeetingTimeSuggestion) | Ein Array von Besprechungsvorschlägen |
LeererVorschlagsGrund | Zeichenfolge | Ein Grund, aus dem keine Besprechungsvorschläge zurückgegeben wurden. Mögliche Werte sind: AttendeesUnavailable , LocationsUnavailable , OrganizerUnavailable , AttendeesUnavailableOrUnknown und Unknown . |
Gründe dafür, dass keine Besprechungsvorschläge zurückgegeben werden
Die Eigenschaft EmptySuggestionsReason gibt einen der folgenden Gründe an, warum die FindMeetingTimes-Aktion keine Besprechungsvorschläge zurückgibt. Die Eigenschaft ist eine leere Zeichenfolge, wenn FindMeetingTimes alle Besprechungsvorschläge zurückgibt.
Wert | Gründe |
---|---|
AttendeesUnavailable | Die Verfügbarkeit aller Teilnehmer ist bekannt, die Zahl der verfügbaren Teilnehmer liegt jedoch unter dem Schwellenwert für die Besprechungskonfidenz. Dieser ist standardmäßig auf 50 % festgelegt. |
TeilnehmerUnverfügbarOderUnbekannt | Die Verfügbarkeit einiger oder aller Teilnehmer ist unbekannt, sodass die Besprechungskonfidenz unter dem definierten Schwellenwert liegt. Dieser ist standardmäßig auf 50 % gesetzt. Die Verfügbarkeit eines Teilnehmers kann unbekannt sein, wenn der Teilnehmer nicht zur Organisation gehört oder ein Fehler beim Abruf der Frei-/Gebucht-Informationen auftritt. |
OrteNichtVerfügbar | Die Eigenschaft isRequired des Parameters LocationConstraint ist als obligatorisch festgelegt, aber es sind während der berechneten Zeitfenster keine Orte verfügbar. |
OrganizerUnavailable | Der Parameter IsOrganizerOptional ist auf falsch eingestellt, der Organisator ist aber während des angefragten Zeitfensters nicht verfügbar. |
Unbekannt | Der Grund, aus dem keine Besprechungsvorschläge zurückgegeben wurden, ist nicht bekannt. |
MentionsPreview (Vorschau)
Stellt Informationen über Erwähnungen in einer Ressourceninstanz dar.
Typ: Microsoft.OutlookServices.MentionsPreview
Eigenschaft | Typ | Beschreibung |
---|---|---|
IsMentioned | Boolesch | Wahr, wenn der angemeldete Benutzer in der übergeordneten Ressourceninstanz erwähnt wird. Schreibgeschützt. Unterstützt Filter. |
MessageRuleActions (Vorschau)
Stellt die Reihe von Aktionen dar, die für eine Regel verfügbar sind.
Typ: Microsoft.OutlookServices.MessageRuleActions
Eigenschaft | Typ | Beschreibung |
---|---|---|
KategorienZuweisen | Sammlung (Zeichenfolge) | Eine Liste von Kategorien, die einer Nachricht zugewiesen werden sollen. |
CopyToFolder | Zeichenfolge | Die ID eines Ordners, in den eine Nachricht kopiert werden soll. |
Löschen | Boolesch | Gibt an, ob eine Nachricht in den Ordner „Gelöschte Elemente“ verschoben werden soll. |
ForwardAsAttachmentTo | Sammlung (Empfänger) | Die E-Mail-Adressen der Empfänger, an die eine Nachricht als Anlage weitergeleitet werden soll. |
ForwardTo | Sammlung (Empfänger) | Die E-Mail-Adressen der Empfänger, an die eine Nachricht weitergeleitet werden soll. |
MarkAsRead | Boolesch | Gibt an, ob eine Nachricht als gelesen markiert werden soll. |
MarkImportance | Wichtigkeit | Legt die Wichtigkeit der Nachricht fest. Die folgenden Einstellungen sind möglich: Low , Normal , High . |
MoveToFolder | Zeichenfolge | Die ID des Ordners, in den eine Nachricht verschoben wird. |
PermanentLöschen | Boolesch | Gibt an, ob eine Nachricht dauerhaft gelöscht und nicht im Ordner „Gelöschte Elemente“ gespeichert werden soll. |
UmleitenAn | Empfänger | Die E-Mail-Adresse, an die eine Nachricht umgeleitet werden soll. |
StopProcessingRules | Boolesch | Gibt an, ob nachfolgende Regeln ausgewertet werden sollen. |
MessageRulePredicates (Vorschau)
Steht für die Gruppe von Bedingungen und Ausnahmen, die für eine Regel zur Verfügung stehen.
Typ: Microsoft.OutlookServices.MessageRulePredicates
Eigenschaft | Typ | Beschreibung |
---|---|---|
TextEnthält | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die im Textkörper einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
TextOderBetreffEnthält | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die im Textkörper oder Betreff einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
Kategorien | Sammlung (Zeichenfolge) | Steht für die Kategorien, mit denen eine eingehende Nachricht gekennzeichnet werden sollte, damit die Bedingung oder Ausnahme zutrifft. |
VonAdresse | Sammlung (Empfänger) | Steht für die speziellen Absender-E-Mail-Adressen einer eingehenden Nachricht, damit die Bedingung oder Ausnahme zutrifft. |
HasAttachments | Boolesch | Gibt an, ob eine eingehende Nachricht Anlagen aufweisen muss, damit eine Bedingung oder Ausnahme zutrifft. |
KopfzeileEnthält | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die in den Kopfzeilen einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
Wichtigkeit | Wichtigkeit | Die Wichtigkeit einer eingehenden Nachricht, damit die Bedingung oder Ausnahme zutrifft: Low , Normal , High . |
IsApprovalRequest | Boolesch | Gibt an, ob eine eingehende Nachricht eine Genehmigungsanforderung sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsAutomaticForward | Boolesch | Gibt an, ob eine eingehende Nachricht automatisch weitergeleitet werden muss, damit die Bedingung oder Ausnahme zutrifft. |
IsAutomaticReply | Boolesch | Gibt an, ob eine eingehende Nachricht eine automatische Antwort sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsEncrypted | Boolesch | Gibt an, ob eine eingehende Nachricht verschlüsselt sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsMeetingRequest | Boolesch | Gibt an, ob eine eingehende Nachricht eine Besprechungsanfrage sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsMeetingResponse | Boolesch | Gibt an, ob eine eingehende Nachricht eine Besprechungsantwort sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsNonDeliveryReport | Boolesch | Gibt an, ob eine eingehende Nachricht ein Unzustellbarkeitsbericht sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsPermissionControlled | Boolesch | Gibt an, ob eine eingehende Nachricht berechtigungsgesteuert (RMS-geschützt) sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsReadReceipt | Boolesch | Gibt an, ob eine eingehende Nachricht eine Lesebestätigung sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsSigned | Boolesch | Gibt an, ob eine eingehende Nachricht S/MIME-signiert sein muss, damit die Bedingung oder Ausnahme zutrifft. |
IsVoicemail | Boolesch | Gibt an, ob eine eingehende Nachricht eine Voicemail sein muss, damit die Bedingung oder Ausnahme zutrifft. |
MessageActionFlag | MessageActionFlag | Steht für den flag-for-action-Wert, der in einer eingehenden Nachricht angezeigt wird, damit die Bedingung oder Ausnahme zutrifft. |
NotSentToMe | Boolesch | Gibt an, ob der Besitzer des Postfachs kein Empfänger einer eingehenden Nachrichten sein darf, damit die Bedingung oder Ausnahme zutrifft. |
ReceipentContains | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die in den Eigenschaften toRecipients oder ccRecipients einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
SenderContains | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die in der From-Eigenschaft einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
Vertraulichkeit | Vertraulichkeit | Steht für die Vertraulichkeitsstufe, mit der eine eingehende Nachricht gekennzeichnet werden sollte, damit die Bedingung oder Ausnahme zutrifft. Mögliche Werte: sind Normal , Personal , Private und Confidential . |
SentCcMe | Boolesch | Gibt an, ob sich der Besitzer des Postfachs in der CcRecipients-Eigenschaft einer eingehenden Nachrichten befinden muss, damit die Bedingung oder Ausnahme zutrifft. |
SentOnlyToMe | Boolesch | Gibt an, ob der Besitzer des Postfachs der einzige Empfänger in einer eingehenden Nachrichten sein muss, damit die Bedingung oder Ausnahme zutrifft. |
SentToAddresses | Sammlung (Empfänger) | Steht für die E-Mail-Adressen, an die eine eingehenden Nachricht gesendet werden muss, damit die Bedingung oder Ausnahme zutrifft. |
SentToMe | Boolesch | Gibt an, ob sich der Besitzer des Postfachs in der ToRecipients-Eigenschaft einer eingehenden Nachrichten befinden muss, damit die Bedingung oder Ausnahme zutrifft. |
SentToOrCcMe | Boolesch | Gibt an, ob sich der Besitzer des Postfachs in der ToRecipients-Eigenschaft oder in der CcRecipients-Eigenschaft einer eingehenden Nachrichten befinden muss, damit die Bedingung oder Ausnahme zutrifft. |
SubjectContains | Sammlung (Zeichenfolge) | Steht für die Zeichenfolgen, die im Betreiff einer eingehenden Nachricht angezeigt werden sollten, damit die Bedingung oder Ausnahme zutrifft. |
WithinSizeRange | GrössenBereich | Gibt die maximale und minimale Größe (in Kilobyte) an, zwischen der eine eingehende Nachricht liegen muss, damit eine Bedingung oder Ausnahme zutrifft. |
PatternedRecurrence
Serienmuster und -bereich.
Typ: Microsoft.OutlookServices.PatternedRecurrence
Eigenschaft | Typ | Beschreibung |
---|---|---|
Muster | WiederholungsMuster | Die Häufigkeit eines Ereignisses. |
RecurrenceTimeZone | Zeichenfolge | Die Zeitzone der Start- und Endzeiten. Eine Liste der unterstützten Zeitzonen finden Sie unter dem komplexen Typ DateTimeTimeZone. |
Bereich | WiederholungsBereich | Die Dauer eines Ereignisses. |
Telefon
Gibt eine Telefonnummer an.
Typ: Microsoft.OutlookServices.Phone
Eigenschaft | Typ | Beschreibung |
---|---|---|
Zahl | Zeichenfolge | Die Telefonnummer |
Typ | Zeichenfolge | Der Typ der Telefonnummer. Mögliche Werte sind: Home , Business , Mobile , Other , Assistant , HomeFax , BusinessFax , OtherFax , Pager , Radio . |
PhysischeAdresse
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. |
PostleitZahl | 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. |
WiederholungsMuster
Die Häufigkeit eines Ereignisses.
Typ: Microsoft.OutlookServices.RecurrencePattern
Eigenschaft | Typ | Beschreibung |
---|---|---|
Typ | WiederholungsMusterTyp | 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 - Weekly. Muss dieDaysOfWeek und den FirstDayOfWeek festlegen - Daily. Keine zusätzlichen Musterinformationen benötigt. |
Intervall | Int32 | Die Anzahl von Einheiten eines bestimmten Serientyps zwischen Vorkommen. |
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. |
WiederholungsBereich
Die Dauer eines Ereignisses.
Typ: Microsoft.OutlookServices.RecurrenceRange
Eigenschaft | Typ | Beschreibung |
---|---|---|
Typ | WiederholungsBereichTyp | 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, an dem bzw. der die Antwort zurückgegeben wurde. |
SizeRange (Vorschau)
Gibt die maximale und minimale Größe (in Kilobyte) an, die eine eingehende Nachrichten aufweisen muss, damit eine Bedingung oder Ausnahme zutrifft.
Typ: Microsoft.OutlookServices.SizeRange
Eigenschaft | Typ | Beschreibung |
---|---|---|
MaximumSize | Int32 | Die maximale Größe (in Kilobyte), die eine eingehende Nachrichten aufweisen muss, damit eine Bedingung oder Ausnahme zutrifft. |
MinimumSize | Int32 | Die minimale Größe (in Kilobyte), die eine eingehende Nachrichten aufweisen muss, damit eine Bedingung oder Ausnahme zutrifft. |
TimeConstraint
Schränkt Vorschläge für Besprechungstermine entsprechend der angegebenen Art der Aktivität und der offenen Zeitfenster auf bestimmte Stunden und Tage der Woche ein.
Typ: Microsoft.OutlookServices.TimeConstraint
Eigenschaft | Typ | Beschreibung |
---|---|---|
ActivityDomain | ActivityDomain | Optional, die Art der Aktivität: Work , Personal , Unrestricted oder Unknown . |
Zeitfenster | Sammlung (TimeSlot) | Ein Array von Zeitfenstern |
ZeitFenster
Ein Zeitfenster
Typ: Microsoft.OutlookServices.TimeSlot
Eigenschaft | Typ | Beschreibung |
---|---|---|
Start | DateTimeTimeZone | Die Startzeit des betreffenden Zeitfensters |
Ende | DateTimeTimeZone | Die Endzeit des betreffenden Zeitfensters |
TimeZoneInformation (Vorschau)
Stellt eine Zeitzone dar. Die unterstützten Formate sind Windows und IANA-Zeitzone (Internet Assigned Numbers Authority) (auch bekannt als Olson-Zeitzone).
Typ: Microsoft.OutlookServices.TimeZoneInformation
Eigenschaft | Typ | Beschreibung |
---|---|---|
Alias | Zeichenfolge | Ein Bezeichner für die Zeitzone. |
Anzeigename | Zeichenfolge | Eine Anzeigezeichenfolge, die die Zeitzone darstellt. |
Website (Vorschau)
Stellt eine Website dar.
Typ: Microsoft.OutlookServices.Website
Eigenschaft | Typ | Beschreibung |
---|---|---|
Adresse | Zeichenfolge | Die URL der Website. |
Anzeigename | Zeichenfolge | Der Anzeigename der Website. |
Typ | WebsiteTyp | Der Typ der Website, die üblicherweise einem Kontakt zugeordnet wird. Mögliche Werte sind: Blog , Home , Other , Profile und Work . |
WorkingHours (Vorschau)
Stellt die Wochentage und Zeiten in einer bestimmten Zeitzone dar, an bzw. zu denen der Benutzer arbeitet.
Typ: Microsoft.OutlookServices.WorkingHours
Eigenschaft | Typ | Beschreibung |
---|---|---|
DaysOfWeek | Sammlung (DayOfWeek) | Eine Sammlung von Wochentagen, an denen der Benutzer arbeitet: Sonntag = 0, Montag = 1, Dienstag = 2, Mittwoch = 3, Donnerstag = 4, Freitag = 5, Samstag = 6. |
StartZeit | Edm.TimeOfDay | Die Tageszeit, zu der der Benutzer zu arbeiten beginnt. |
EndZeit | Edm.TimeOfDay | Die Tageszeit, zu der der Benutzer zu arbeiten aufhört. |
ZeitZone | Zeichenfolge | Die Zeitzone, für die die Arbeitszeiten gelten. Eine Liste der gültigen Zeitzonen finden Sie unter DateTimeTimeZone. |
Enumerationen
- ActivityDomain
- AutomaticRepliesStatus
- KategorieFarbe (Vorschau)
- DayOfWeek
- ExternalAudienceScope
- FolgeFlaggenStatus (Vorschau)
- FreeBusyStatus
- InferenceClassificationType
- OrtsTyp (Vorschau)
- MailTipsType (Vorschau)
- MessageActionFlag (Vorschau)
- TelefonTyp (Vorschau)
- RecipientScopeType (Vorschau)
- ReferenceAttachmentPermissions
- ReferenceAttachmentProviders
- AufgabeStatus
- ZeitZonenStandard
- WebsiteTyp
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
ActivityDomain
Die Art einer Aktivität.
Unterstützte Werte:
- Arbeit
- Persönlich
- Uneingeschränkt
- Unbekannt
AutomaticRepliesStatus
Der Konfigurationsstatus für das automatische Senden einer Antwort, wenn das Postfach des Benutzers eine Nachricht erhält.
Unterstützte Werte:
- ImmerAktiviert
- Deaktiviert
- Geplant
CategoryColor (Vorschau)
Die Farbe, die eine Kategorie im Postfach des Benutzers kennzeichnet. Die tatsächliche Farbe, die jede voreingestellte Konstante repräsentiert, hängt von dem Outlook-Client ab, der für die Anzeige der Kategorien verwendet wird.
Unterstützte Werte | Im Outlook-Desktop-Client zugeordnete Farbe |
---|---|
Preset0 | Rot |
Voreinstellung1 | Orange |
Voreinstellung2 | Braun |
Voreinstellung3 | Gelb |
Voreinstellung4 | Grün |
Voreinstellung5 | Blaugrün |
Voreinstellung 6 | Olivgrün |
Voreinstellung 7 | Blau |
Voreinstellung 8 | Lila |
Voreinstellung 9 | Preiselbeere |
Voreinstellung10 | Stahlgrau |
Voreinstellung11 | DarkSteel |
Voreinstellung 12 | Grau |
Voreinstellung13 | DarkGray |
Voreinstellung14 | Schwarz |
Voreinstellung15 | DarkRed |
Preset16 | DarkOrange |
Preset17 | DarkBrown |
Preset18 | DarkYellow |
Preset19 | DarkGreen |
Preset20 | DarkTeal |
Preset21 | DarkOlive |
Preset22 | DarkBlue |
Preset23 | DarkPurple |
Preset24 | DarkCranberry |
Keine | Keine Farbe zugeordnet |
ExternalAudienceScope
Die Menge der externen Benutzergruppen, an die die ExternalReplyMessage gesendet werden soll.
Unterstützte Werte:
- Alle
- ContactsOnly
- Keine
FollowupFlagStatus (Vorschau)
Stellt den Status des Nachverfolgungs-Kennzeichens für eine Ressourceninstanz dar.
Unterstützte Werte:
- Abgeschlossen
- Gekennzeichnet
- NotFlagged
InferenceClassificationType
Stellt die abgeleitete Relevanz einer Nachricht für einen Benutzer dar, auf die er sich konzentrieren kann.
Unterstützte Werte:
- Relevant
- Sonstiges
LocationType (Vorschau)
Die möglichen Arten von Orten.
Unterstützte Werte:
- Standard
- ConferenceRoom
- HomeAddress
- BusinessAddress
- GeoCoordinates
- StreetAddress
- Hotel
- Restaurant
- LocalBusiness
- PostAdresse
MailTipsType (Vorschau)
Eine Enumeration von Kennzeichen, die die angeforderte E-Mail-Info repräsentiert.
Unterstützte Werte:
- AutomatischeAntworten
- CustomMailTip
- DeliveryRestriction
- ExternalMemberCount
- MailboxFullStatus
- MaxNachrichtenGröße
- ModerationStatus
- RecipientScope
- EmpfängerVorschläge
- TotalMemberCount
MessageActionFlag (Vorschau)
Gibt die Aktion an, die für eine Nachricht durchgeführt werden soll.
Unterstützte Werte:
- Jede
- Aufruf
- NichtWeiterleiten
- FollowUp
- Zur Kenntnisnahme
- Weiterleiten
- NoResponseNotwendig
- Lesen
- Antworten
- AllenAntworten
- Prüfung
PhoneType (Vorschau)
Die Art der Telefonnummern, die üblicherweise einem Kontakt zugeordnet sind.
Unterstützte Werte:
- Assistent
- Unternehmen
- BusinessFax
- Privat
- HomeFax
- Mobil
- Sonstiges
- AnderesFax
- Pager
- Radio
RecipientScopeType (Vorschau)
Eine Enumeration von Kennzeichen, die die Typen von Empfängerbereiche repräsentiert. Empfängerbereiche werden von Administratoren verwendet, um bestimmte E-Mail-Infos anzugeben, die nur für einen bestimmten Bereich zugänglich sind.
Unterstützte Werte:
- Keine
- Intern
- Extern
- ExternerPartner
- ExternalNonPartner
ReferenceAttachmentPermissions
Zugriffsberechtigungen für die Datei oder den Ordner der Verweisanlage.
Unterstützte Werte:
- Sonstiges
- Ansicht
- Bearbeiten
- AnonymeAnsicht
- AnonymousEdit
- OrganizationView
- OrganizationEdit
ReferenceAttachmentProviders
Mögliche Dateispeicheranbieter für Verweisanlagen.
Unterstützte Werte:
- Dropbox
- OneDriveBusiness
- OneDriveVerbraucher
- Sonstiges
Vertraulichkeit
Zeigt die Datenschutzebene an.
Unterstützte Werte:
- Standard
- Persönlich
- Privat
- Vertraulich
AufgabeStatus
Gibt den Status oder Fortschritt einer Aufgabe an.
Unterstützte Werte:
- Abgeschlossen
- Zurückgestellt
- In Bearbeitung
- NotStarted
- Auf Andere warten
TimeZoneStandard (Vorschau)
Das Format, um Zeitzonen auszudrücken.
Unterstützte Werte:
- Windows
- Iana
WebsiteType (Vorschau)
Gibt den Typ der Website an, die üblicherweise einem Kontakt zugeordnet wird.
Unterstützte Werte:
- Blog
- Privat
- Sonstiges
- Profil
- Arbeit
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 spezielle Bedeutungen in einem URI reserviert sind, entsprechend kodiert werden.
$search
Um nach bestimmten Kriterien zu suchen$filter
Um nach bestimmten Kriterien zufiltern$select
Um bestimmte Eigenschaften anzufordern$orderby
Um Ergebnisse zu sortieren$top
und um Ergebnisse$skip
zu pagen$expand
, um Nachrichtenanlagen und Ereignisanlagen zu erweitern$count
, um die Anzahl der 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. Such-Zeichenfolgen 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 $search
Anforderung 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. |
Auszahlung | 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 das An-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 in einer der drei Standardeigenschaften das Wort "Pizza" 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/beta/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/beta/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/beta/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/beta/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/beta/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/beta/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 | ReceivedDateTime gt 2014-09-01T00:00:00Z |
ge | Größer oder gleich | LastModifiedDateTime ge 2014-09-01T00:00:00Z |
lt | Kleiner als | ReceivedDateTime lt 2014-09-01T00:00:00Z |
le | Kleiner oder gleich | LastModifiedDateTime le 2014-09-01T00:00:00Z |
Verwenden Sie einfache Anführungszeichen ('), um einen beliebigen Zeichenfolgenwert innerhalb des Filterkriteriums 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 Start filtern, um alle Ereignisse im Standardkalender des Benutzers zu erhalten, die an oder nach einem bestimmten Datum beginnen.
GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'
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/beta/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/beta/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/beta/me/messages?$filter=HasAttachments eq true
Sie können nach der Eigenschaft ReceivedDateTime filtern, um alle Nachrichten im Posteingang seit dem 1. September 2014 zu erhalten.
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime 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/beta/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/beta/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/beta/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/beta/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 EigenschaftenBetreff, Absender und ReceivedDateTime für alle Nachrichten im Posteingang.
GET https://outlook.office.com/api/beta/me/messages?$select=Subject,Sender,ReceivedDateTime
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
nicht mit $search
verwenden können.
Das folgende Beispiel ohne URL-Codierung sortiert alle Nachrichten im Posteingang nach der Eigenschaft ReceivedDateTime in absteigender Reihenfolge.
GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime desc
Das gleiche Beispiel mit URL-Codierung:
GET https://outlook.office.com/api/beta/me/messages?$orderby=ReceivedDateTime%20desc
Seitenergebnisse
Standardmäßig gibt eine GET-Anforderung für eineNachrichten- oder Unterordner-Eigenschaft, eine Sammlung oder für eineKalenderAnsichtzehn 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/beta/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/beta/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/beta/me/messages/$count
Und dieses Beispiel ohne URL-Codierung liefert die Anzahl der ungelesenen Nachrichten im Posteingang.
GET https://outlook.office.com/api/beta/me/messages/$count?$filter=IsRead eq false
Das gleiche Beispiel mit URL-Codierung.
GET https://outlook.office.com/api/beta/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 ReceivedDateTime zurü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/beta/me/messages?
$filter=Importance eq 'High'
&$select=Subject,Sender,ReceivedDateTime
&$top=5
Wenn Sie $filter
angeben, leitet der Server eine Sortierreihenfolge für die Ergebnisse ab. Wenn Sie beide$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/beta/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/beta/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,ReceivedDateTime&$top=5
https://outlook.office.com/api/beta/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender
Siehe auch
- Outlook-REST-API im Outlook-Dev-Center
- Überblick über die Entwicklung auf der Office 365-Plattform
- Office 365 App-Authentifizierung und Ressourcen-Autorisierung
- Registrieren Sie Ihre App manuell bei Azure AD, damit sie auf Office 365-APIs zugreifen kann
- Outlook-Mail-REST-API-Referenz
- Outlook Kalender REST API Referenz
- Outlook-Kontakte – REST-API-Referenz
- Outlook-Aufgaben - REST API-Verweis