Outlook-Mail-REST-API-Verweis (Version 2.0)
Gilt für: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Mit der Outlook Mail-API können Sie Nachrichten und Anhänge lesen, erstellen und senden, Ereignisnachrichten anzeigen und beantworten sowie Ordner verwalten, die durch Azure Active Directory in Office 365 geschützt sind. Sie bietet die gleiche Funktionalität in Microsoft-Konten speziell in diesen Domänen: Hotmail.com, Live.com, MSN.com, Outlook.com und Passport.com.
Hinweis
Zur Vereinfachung des Verweises verwendet der Rest dieses Artikels Outlook.com, um diese Microsoft-Kontodomänen einzuschließen.
Kein Interesse an v2.0 der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365 REST-API-Verweis und wählen Sie die gewünschte Version aus.
Alle Mail-API-Operationen
Nachrichtenvorgänge
Nachrichten werden in Postfachordnern gespeichert, so dass Nachrichten-Endpunkte oft den Ordner enthalten, der die Nachricht enthält. Ein Ordner wird durch eine ID oder einen bekannten Ordnernamen angegeben, wie Inbox
, Drafts
, SentItems
, oder DeletedItems
.
- Nachrichten abrufen
- Nachrichten synchronisieren
- Nachrichten erstellen und versenden
- Auf Nachrichten antworten oder alle beantworten
- Neue oder entworfene Nachrichten weiterleiten
- Nachricht aktualisieren
- Nachrichten löschen
- Nachrichten verschieben oder kopieren
- Posteingang mit Relevanz verwalten
- Verwalten von @ Erwähnungen (Vorschau)
- Regeln verwalten (Vorschau)
- Abbestellen (Vorschau)
- Sprachauswahl abrufen (Vorschau)
- Zeitzonenauswahl abrufen (Vorschau)
- Postfacheinstellungen abrufen
- Automatische Antworteinstellungen abrufen
- Automatische Antworteinstellungen aktualisieren
- Abrufen von E-Mail-Infos (Vorschau)
- Anlagen abrufen
- Anlagen erstellen
- Anlagen löschen
Ordnervorgänge
Postfach-Ordner können Nachrichten und andere Ordner enthalten. Sie können Ordner abrufen, erstellen, ändern, löschen und verwalten. Sie können die folgenden bekannten Ordnernamen anstelle der ID verwenden, um den entsprechenden Ordner anzugeben: Inbox
, SentItems
, Drafts
, oder DeletedItems
.
- Ordner abrufen
- Synchronisieren von Ordnern
- Ordner erstellen
- Ordner aktualisieren
- Ordner löschen
- Ordner verschieben oder kopieren
Siehe auch
Verwenden der Mail-REST-API
Authentifizierung
Wie andere Outlook-REST-API, sollten Sie für jede Anforderung an die Mail-API ein gültiges Zugriffstoken angeben. Um ein Zugriffstoken zu erhalten, müssen Sie sich registriert und Ihre App identifiziert und die entsprechende Autorisierung erhalten haben.
Sie können mehr über einige optimierte Registrierungs- und Autorisierungsoptionen für Sie herausfinden. Beachten Sie dies, wenn Sie mit den spezifischen Operationen in der Mail-API fortfahren.
Version der API
Die Mail-REST-API wird in allen Versionen der Outlook-REST-API unterstützt. Die Funktionalität kann je nach spezifischer Version unterschiedlich sein.
Ziel-Benutzer
Alle Mail-API-Anfragen werden im Namen des angemeldeten Benutzers ausgeführt, sofern nicht anders angegeben. Einige API-Teilmengen, wie z.B. die Posteingang mit Relevanz-API, können für den angemeldeten Benutzer oder einen durch eine Benutzer-ID spezifizierten Benutzer mit den entsprechenden Berechtigungen ausgeführt werden.
Weitere Informationen, die allen Untergruppen von Outlook-REST-API gemeinsam sind, finden Sie unter Outlook-REST-API verwenden.
Nachrichten abrufen
Sie können eine Nachrichtensammlung oder eine einzelne Nachricht aus einem Postfachordner abrufen.
Jede Nachricht in der Antwort enthält mehrere Eigenschaften, darunter auch die Text-Eigenschaft. Der Nachrichtentext kann entweder Text oder HTML sein. Wenn der Textkörper im HTML-Format vorliegt, werden standardmäßig alle potenziell unsicheren HTML-Elemente (z. B. JavaScript), die in der body Eigenschaft eingebettet sind, vor dem Zurückgeben des Textkörperinhalts in einer REST-Antwort entfernt.
Fügen Sie den gesamten, ursprünglichen HTML-Inhalt ein, um den folgenden HTTP-Anforderungs-Header abzurufen:
Prefer: outlook.allow-unsafe-html
Um das gewünschte Format in den Eigenschaften Text und UniqueBody in einer GET-Anforderungen anzugeben, verwenden Sie den Prefer: outlook.body-content-type
Header:
- Geben Sie
Prefer: outlook.body-content-type="text"
an, um einen Nachrichtentext im Textformat zu erhalten. - Geben Sie
Prefer: outlook.body-content-type="html"
an oder überspringen Sie einfach den Header, um den Nachrichtentext im HTML-Format zurückzugeben.
Wenn Sie einen der beiden Header angeben, enthält die Antwort den entsprechenden Preference-Applied
Header als Bestätigung:
- Für Textformat-Anforderungen:
Preference-Applied: outlook.body-content-type="text"
- Für Anforderungen im HTML-Format:
Preference-Applied: outlook.body-content-type="html"
Eine Nachrichtensammlung abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Hinweis
Das Verhalten der Vorgänge in diesem Abschnitt hängt von der Version ab. Weitere Informationen erhalten Sie, wenn Sie im Inhaltsverzeichnis auf der linken Seite eine Version unter REST-API für Office 365 Referenz auswählen.
Rufen Sie eine Nachrichtensammlung aus dem gesamten Postfach des angemeldeten Benutzers (einschließlich der Ordner Gelöschte Elemente und Clutter) ab.
GET https://outlook.office.com/api/v2.0/me/messages
Sie können auch einen Ordner im Postfach des Benutzers angeben und die Nachrichtensammlung aus diesem Ordner abrufen.
GET https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/messages
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die Ordner-ID oder die Inbox , Drafts , SentItems , oder DeletedItems bekannter Ordnername, wenn Sie Nachrichten aus einem bestimmten Ordner erhalten. Die Angabe von AllItems würde alle Nachrichten aus dem gesamten Postfach zurückgeben |
Hinweis
Standardmäßig umfasst jede Nachricht in der Antwort alle ihre Eigenschaften. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Das folgende Beispiel zeigt, wie man $select
verwendet, um nur die Eigenschaften Sender und Thema jeder Nachricht in der Antwort anzugeben. Lesen Sie die Beispielantwort Eine Nachricht abrufen für eine vollständige Liste der Eigenschaften, die für eine Nachricht zurückgegeben werden würden, wenn Sie nicht $select
verwenden.
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/MailFolders/sentitems/messages/?$select=Sender,Subject
Beispielantwort
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('sentitems')/Messages(Sender,Subject)",
"value": [
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIzAAAA=')",
"@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqS\"",
"Id": "AAMkAGI2TIzAAAA=",
"Subject": "Meeting Notes",
"Sender": {
"EmailAddress": {
"Name": "Alex D",
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
}
}
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy-AAA=')",
"@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
"Id": "AAMkAGI2TIy-AAA=",
"Subject": "Contract Signing",
"Sender": {
"EmailAddress": {
"Name": "Alex D",
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
}
}
},
{
"@odata.type": "#Microsoft.OutlookServices.EventMessage",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2TIy9AAA=')",
"@odata.etag": "W/\"CwAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqJ\"",
"Id": "AAMkAGI2TIy9AAA=",
"Subject": "Rob:Alex 1:1",
"Sender": {
"EmailAddress": {
"Name": "Alex D",
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
}
}
}
]
}
Antworttyp
Die angeforderte Nachrichten-Sammlung.
Abrufen einer Nachricht
Mindestens erforderlicher Bereich
Einer der folgenden:
Eine Nachricht nach ID abrufen.
GET https://outlook.office.com/api/v2.0/me/messages/{message_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGI2THVSAAA=
Beispielantwort
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2THVSAAA=')",
"@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz\"",
"Id": "AAMkAGI2THVSAAA=",
"CreatedDateTime": "2014-10-20T00:41:57Z",
"LastModifiedDateTime": "2014-10-20T00:41:57Z",
"ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIKz",
"Categories": [],
"ReceivedDateTime": "2014-10-20T00:41:57Z",
"SentDateTime": "2014-10-20T00:41:53Z",
"HasAttachments": true,
"Subject": "Re: Meeting Notes",
"Body": {
"ContentType": "Text",
"Content": "\n________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP\n"
},
"BodyPreview": "________________________________________\nFrom: Alex D\nSent: Sunday, October 19, 2014 5:28 PM\nTo: Katie Jordan\nSubject: Meeting Notes\n\nPlease send me the meeting notes ASAP",
"Importance": "Normal",
"ParentFolderId": "AAMkAGI2AAEMAAA=",
"Sender": {
"EmailAddress": {
"Name": "Katie Jordan",
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
}
},
"From": {
"EmailAddress": {
"Name": "Katie Jordan",
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Name": "Alex D",
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGI2yEto=",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": false,
"IsDraft": false,
"WebLink": "https://outlook.office365.com/owa/?ItemID=AAMkAGI2THVSAAA%3D&exvsurl=1&viewmodel=ReadMessageItem"
}
Antworttyp
Die gewünschte Nachricht.
Hinweis
Standardmäßig enthält die Antwort alle Eigenschaften der angegebenen Nachricht. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Das folgende Beispiel zeigt, wie man $select
verwendet, um nur die Eigenschaften Sender und Thema jeder Nachricht in der Antwort anzugeben.
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGE1I5MTAAA=?$select=Sender,Subject
Nachrichten synchronisieren
Mindestens erforderlicher Bereich
Einer der folgenden:
Sie können Ihren lokalen Datenspeicher mit den Nachrichten auf dem Server synchronisieren. Die Nachrichtensynchronisation ist ein Vorgang pro Ordner, z.B. können Sie alle Nachrichten in Ihrem Posteingang synchronisieren. Um die Nachrichten in einer Ordnerhierarchie zu synchronisieren, müssen Sie jeden Ordner einzeln synchronisieren.
Die API unterstützt sowohl die vollständige Synchronisation, die alle Nachrichten in einem Ordner abruft, als auch die inkrementelle Synchronisation, die alle Nachrichten abruft, die seit der letzten vollständigen Synchronisation geändert wurden.
Die Synchronisation eines Nachrichtenordners erfordert in der Regel zwei oder mehr GET-Anforderungen. Sie führen die GET-Anforderung sehr ähnlich aus, wie Sie Nachrichten abrufen, außer dass Sie bestimmte Anforderungs-Header und ein deltaToken oder skipToken mit einschließen, falls erforderlich.
Kopfzeilen von Anfragen
Sie müssen den Header Prefer: odata.track-changes in allen Synchronisierungs-Anforderungen angeben, außer in denen, die eine
skipToken
enthalten, die von einer vorherigen Synchronisierungs-Anforderung zurückgegeben wird. Suchen Sie in der ersten Antwort nach dem Header Preference-Applied: odata.track-changes, um vor dem Fortfahren zu bestätigen, dass die Ressource die Synchronisierung unterstützt.Sie können den Header Prefer: odata.maxpagesize={x} angeben, um die maximale Anzahl der in einer Anfrage zurückgegebenen Nachrichten festzulegen.
Dies ist eine typische Nachrichten-Synchronisierungsrunde:
Stellen Sie die erste GET-Anforderung mit dem erforderlichen Header Prefer: odata.track-changes. Die erste Antwort auf eine Synchronisierungsanforderung liefert immer ein deltaToken. (Die zweite und nachfolgende GET-Anforderungen unterscheiden sich von der ersten GET-Anforderung, indem sie entweder ein deltaToken oder ein skipToken enthalten, das in einer früheren Antwort empfangen wurde.)
Wenn die erste Antwort den Header Preference-Applied: odata.track-changes zurückgibt, können Sie mit der Synchronisierung des Ordners fortfahren.
Stellen Sie eine zweite GET-Anforderung. Geben Sie den Header Prefer: odata.track-changes und das deltaToken vom ersten GET zurück, um festzustellen, ob es zusätzliche Nachrichten gibt. Die zweite Anforderung gibt zusätzliche Nachrichten zurück und entweder ein skipToken, wenn mehr Nachrichten verfügbar sind oder ein deltaToken, wenn die letzte Nachricht synchronisiert wurde, in diesem Fall ist die Synchronisationsrunde abgeschlossen und Sie können aufhören.
Setzen Sie die Synchronisierung fort, indem Sie einen GET-Aufruf senden und ein skipToken einfügen, das vom vorherigen Aufruf zurückgegeben wird. Hören Sie auf, wenn Sie eine endgültige Antwort erhalten, die einen @odata.deltaLink-Header mit einem deltaToken enthält. Dies zeigt an, dass die Synchronisierung abgeschlossen ist.
Speichern Sie das letzte Delta-Token, das in der vollständigen Synchronisationsrunde empfangen wurde. Benutzen Sie es, um eine inkrementelle Synchronisationsrunde zu starten.
Dies ist eine inkrementelle Synchronisationsrunde:
Führen Sie die erste GET-Anforderung mit dem obligatorischen Header Prefer: odata.track-changes und dem gespeicherten deltaToken durch, das in der letzten Antwort einer vollständigen Synchronisationsrunde empfangen wurde.
Der zweite und die folgenden Schritte folgen dem für eine vollständige Synchronisation verwendeten Muster.
So synchronisieren Sie Nachrichten in einem bestimmten Ordner
Ursprüngliche Anforderung
GET https://outlook.office365.com/api/v2.0/me/MailFolders('{folder_id}')/messages
Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde
GET https://outlook.office365.com/api/v2.0/me/MailFolders('{folder_id}')/messages/?$deltaToken={delta_token}
Dritte oder nachfolgende Anforderung in der gleichen Runde
Fahren Sie mit dem Senden der nächsten Synchronisations-Anforderung fort, wenn die vorherige Antwort skipToken
enthält. Hören Sie auf, wenn Sie eine Antwort erhalten, die wieder einen Header @odata.deltaLink
mit deltaToken
enthält.
GET https://outlook.office365.com/api/v2.0/me/MailFolders('{folder_id}')/messages/?$skipToken={skip_token}
Parameter | Typ | Beschreibung |
---|---|---|
Header-Parameter | ||
Bevorzugen | odata.track-Änderungen | Zeigt an, dass es sich bei der Anforderung um eine Synchronisierungsanforderung handelt. Erforderlich für die ersten 2 GET-Anforderungen in einer Runde. |
Bevorzugen | odata.maxpagesize | Legt die Anzahl der in jeder Antwort zurückgegebenen Nachrichten fest. Optional. |
URL-Parameter | ||
folder_id | Zeichenfolge | Die Ordner-ID oder die Inbox , Drafts , SentItems oder DeletedItems der Name des Ordners, der zu synchronisieren ist. Erforderlich. |
deltaToken | Zeichenfolge | Das Token, das die letzte Synchronisierungsanforderung für diesen Ordner identifiziert. Es wird als Teil des Wertes für @odata.deltaLink in der vorherigen Synchronisations-Antwort zurückgegeben. Erforderlich für die zweite GET-Anforderung. |
skipToken | Zeichenfolge | Das Token, das anzeigt, dass mehr Nachrichten heruntergeladen werden müssen. Erforderlich, wenn es als Teil des Wertes für @odata.nextLink in der vorherigen Synchronisations-Antwort zurückgegeben wird. |
Standardmäßig gibt die Synchronisation alle Eigenschaften und alle Nachrichten in einem Ordner zurück. Verwenden Sie den Auswahl-Abfrageausdruck $select, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben.
Die Synchronisation unterstützt die Abfrageausdrücke $select, $top, $expand. Es gibt begrenzten Support für $filter und $orderby und keinen Support für $search.
- Die einzigen unterstützten $filter-Ausdrücke sind "$filter=ReceivedDateTime+ge+{value}" oder "$filter=ReceivedDateTime+gt+{value}".
- Der einzige unterstützte $orderby-Ausdruck ist "$orderby=ReceivedDateTime+desc". Wenn Sie keinen $ orderby-Ausdruck angeben, ist die Rückgabe-Anordnung nicht garantiert.
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Antworttyp
Eine Sammlung mit den angeforderten Nachrichten und einem deltaToken oder skipToken, mit der Sie für eine inkrementelle Synchronisation zusätzliche Seiten von Nachrichtendaten vom Server anfordern.
Beispiel
Das folgende Beispiel zeigt eine Reihe von Anforderungen zum Synchronisieren eines bestimmten Ordners, der sieben Nachrichten enthält. Die erste Synchronisations-Anforderung gibt 2 Nachrichten gleichzeitig zurück (odata.maxpagesize ist 2) und nur die Eigenschaften Sender und Thema für jede Nachricht.
- Die erste Antwort gibt zwei Nachrichten zurück,
deltaLink
unddeltaToken
. - Die zweite Anforderung verwendet
deltaToken
. Die zweite Antwort gibt zwei Nachrichten zurück,nextLink
undskipToken
. - Um die Synchronisation abzuschließen, verwenden die dritte und die vierte Anforderung
skipToken
, was von der vorherigen Synchronisationsanforderung zurückgegeben wird, bis die SynchronisationsantwortdeltaLink
unddeltaToken
zurückgibt, in diesem Fall ist diese Runde der Synchronisation abgeschlossen. Speichern SiedeltaToken
für die nächste Synchronisierungsrunde.
Beispiel für ursprüngliche Anforderung
GET https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages?$select=Subject,Sender HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes
Beispieldaten für die anfängliche Antwort
Die erste Antwort enthält einen Preference-Applied: odata.track-changes
Header, der anzeigt, dass dieser Ordner die Synchronisation unterstützt. Die Antwort enthält auch zwei Nachrichten und deltaToken
.
Preference-Applied: odata.track-changes
{
"@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)",
"value":[
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADPAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS9+\"",
"Id":"AAMkAGI5MAAAwXADPAAA=",
"Subject":"Updates from All Company",
"Sender":{
"EmailAddress":{
"Name":"Contoso Demo on Yammer",
"Address":"noreply@yammer.com"
}
}
},
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADVAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+E\"",
"Id":"AAMkAGI5MAAAwXADVAAA=",
"Subject":"RE: Latin American Ad Campaign - XT Series",
"Sender":{
"EmailAddress":{
"Name":"Alex Darrow",
"Address":"AlexD@contoso.onmicrosoft.com"
}
}
}
],
"@odata.deltaLink":"https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=MfzCBD5nm2dcGAFGk5qypL1PSyEAADFmX28BAAAA"
}
Beispiel für zweite Anforderung
Die zweite Anforderung gibt deltaToken
aus der vorherigen Antwort zurück.
GET https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=MfzCBD5nm2dcGAFGk5qypL1PSyEAADFmX28BAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes
Beispieldaten für die zweite Antwort
Die zweite Antwort enthält zwei weitere Nachrichten und einskipToken
, was anzeigt, dass mehr Nachrichten im Ordner zu synchronisieren sind.
{
"@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADQAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS9/\"",
"Id":"AAMkAGI5MAAAwXADQAAA=",
"Subject":"International Launch Planning for XT2000",
"Sender":{
"EmailAddress":{
"Name":"Engineering",
"Address":"engineering@contoso.onmicrosoft.com"
}
}
},
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADUAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+D\"",
"Id":"AAMkAGI5MAAAwXADUAAA=",
"Subject":"RE: Latin American Ad Campaign - XT Series",
"Sender":{
"EmailAddress":{
"Name":"Anne Wallace",
"Address":"AnneW@contoso.onmicrosoft.com"
}
}
}
],
"@odata.nextLink":"https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28CAAAA"
}
Beispiel für dritte Anforderung
Die dritte Anforderung enthält das skipToken
aus der vorherigen Antwort.
GET https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28CAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Beispieldaten für die dritte Antwort
Die dritte Antwort gibt zwei weitere Nachrichten und eine weitere skipToken
zurück, was anzeigt, dass sich noch Nachrichten im Ordner befinden, die synchronisiert werden müssen.
{
"@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADTAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+C\"",
"Id":"AAMkAGI5MAAAwXADTAAA=",
"Subject":"RE: Latin American Ad Campaign - XT Series",
"Sender":{
"EmailAddress":{
"Name":"Pavel Bansky",
"Address":"PavelB@contoso.onmicrosoft.com"
}
}
},
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADSAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+B\"",
"Id":"AAMkAGI5MAAAwXADSAAA=",
"Subject":"Latin American Ad Campaign - XT Series",
"Sender":{
"EmailAddress":{
"Name":"Engineering",
"Address":"engineering@contoso.onmicrosoft.com"
}
}
}
],
"@odata.nextLink":"https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28DAAAA"
}
Vierte Beispielanforderung
Die vierte Anforderung enthält skipToken
aus der vorherigen Antwort.
GET https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24skipToken=MfzCAj5nm2dcGAFGk5qypL1PSyEAADFmX28DAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Beispieldaten für die vierte und letzte Antwort
Die vierte Antwort gibt die einzige im Ordner verbleibende Nachricht zurück sowie deltaToken
, was bedeutet, dass die Synchronisierung für diesen Ordner abgeschlossen ist. Speichern Sie deltaToken
für die nächste Synchronisationsrunde für diesen Ordner.
{
"@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/v2.0/Users('f97adce1-d718-4a0e-9af8-b10167e3a346@0d76cf04-f6a0-46cc-947b-d2e1bdd98d11')/Messages('AAMkAGI5MAAAwXADRAAA=')",
"@odata.etag":"W/\"CQAAABYAAAA+Z5tnXBgBRpOasqS9T0shAAAwYS+A\"",
"Id":"AAMkAGI5MAAAwXADRAAA=",
"Subject":"Data sheets for the XT2000 ",
"Sender":{
"EmailAddress":{
"Name":"Engineering",
"Address":"engineering@contoso.onmicrosoft.com"
}
}
}
],
"@odata.deltaLink": "https://outlook.office365.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24deltaToken=0_zCBD5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA"
}
Beispiel einer inkrementellen Synchronisationsanforderung
Die erste Anforderung enthält deltaToken
aus der letzten vollständigen Synchronisationsantwort.
GET https://outlook.office.com/api/v2.0/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=0_zCBD5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes
Die Antwort auf die inkrementelle Synchronisationsanforderung enthält alle Änderungen im Set der Ordnernachricht.
Beispiel einer inkrementellen Synchronisationsantwort
Die Antwort zeigt, dass eine Änderung am Nachrichten-Set vorgenommen wurde. Eine Nachricht wird gelöscht.
{
"@odata.context":"https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value": [
{
"id": "Messages('AAMkAGY5MDFjNTQyLWI3NzItNGE4My04ZWE4LWQ4YmMwNTJkYTg1YwBGAAAAAAD7fYH1FVR1TayS78jtGGehBwDB1GgBNTpbT6Qe-PzdAR4YAh7cdimCAADwOTzPjXdMTKEex95TwbKkAACLEykWAAA=')",
"reason": "deleted"
}
]
,
"@odata.deltaLink": "https://outlook.office365.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24deltaToken=4_zRDV5nm2dcGAFGk5qypL1PSyEAADBb9RkEAAAA"
}
Nachrichten erstellen und versenden
Sie können eine neue Nachricht spontan versenden oder eine Entwurfsnachricht erstellen und dann versenden. Sie können Entwürfe in einem beliebigen Ordner erstellen.
- Eine neue Nachricht zur Laufzeit versenden
- Einen Nachrichtenentwurf erstellen
- Einen Nachrichtenentwurf versenden
Eine neue Nachricht zur Laufzeit versenden
Mindestens erforderlicher Bereich
Einer der folgenden:
Senden Sie die Nachricht, die Sie im Anforderungstext erhalten haben, indem Sie die Methode SendMail verwenden. Sie können einen oder mehrere Anlagen in denselben Aktionsaufruf aufnehmen, indem Sie sie in der Sammlungseigenschaft Attachments angeben. Sie können auch die Nachricht im Ordner „Gesendete Elemente“ speichern.
POST https://outlook.office.com/api/v2.0/me/sendmail
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
Text-Parameter | ||
Nachricht | Nachricht | Die zu sendende Nachricht. |
SaveToSentItems | boolesch | Gibt an, ob die Nachricht in Gesendete Objekte gespeichert werden soll. Der Standardwert ist True. |
Geben Sie den Parameter Message mit der erforderlichen Eigenschaft ToRecipients und allen beschreibbaren Eigenschaften Message im Anforderungstext an. Der Parameter SaveToSentItems wird nur benötigt, wenn false.
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/sendmail
{
"Message": {
"Subject": "Meet for lunch?",
"Body": {
"ContentType": "Text",
"Content": "The new cafeteria is open."
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
}
}
],
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"Name": "menu.txt",
"ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
}
]
},
"SaveToSentItems": "false"
}
Beispielantwort
Status code: 202
Einen Nachrichtenentwurf erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellt einen Entwurf einer neuen Nachricht. Entwürfe können in einem beliebigen Ordner erstellt und vor dem Versand optional aktualisiert werden. Um in den Ordner Entwürfe zu speichern, verwenden Sie die Verknüpfung /me/messages
.
POST https://outlook.office.com/api/v2.0/me/messages
POST https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/messages
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die Zielordner-ID oder Inbox oder Drafts oder der bekannte Ordnername. |
Geben Sie alle beschreibbaren Nachrichten-Eigenschaften im Anforderungstext an.
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/MailFolders/inbox/messages
Content-Type: application/json
{
"Subject": "Did you see last night's game?",
"Importance": "Low",
"Body": {
"ContentType": "HTML",
"Content": "They were <b>awesome</b>!"
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
}
}
]
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k0AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
"Id": "AAMkAGE0Mz7k0AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
"Categories": [],
"CreatedDateTime": "2014-10-18T20:06:51Z",
"LastModifiedDateTime": "2014-10-18T20:06:51Z",
"Subject": "Did you see last night's game?",
"BodyPreview": "They were awesome!",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nThey were <b>awesome</b>!\r\n</body>\r\n</html>\r\n"
},
"Importance": "Low",
"HasAttachments": false,
"ParentFolderId": "AAMkAGE0MAAEPAAA=",
"From": null,
"Sender": null,
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Katie Jordan"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGE0Mpv2hisc=",
"ReceivedDateTime": "2014-10-18T20:06:51Z",
"SentDateTime": "2014-10-18T20:06:51Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": true,
"IsRead": true
}
Antworttyp
Der Entwurf der Nachricht.
Einen Nachrichtenentwurf versenden
Mindestens erforderlicher Bereich
Einer der folgenden:
Versenden Sie einen neuen Nachrichtenentwurf, einen Antwortentwurf, einen Allen antworten-Entwurf oder einen Weiterleitungsentwurf unter Verwendung der Senden-Methode. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/send
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID des zu sendenden Nachrichtenentwurfs. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz7k0AAA=/send
Beispielantwort
Status code: 202
Auf Nachrichten antworten oder alle beantworten
Hinweis
Das Verhalten der Vorgänge in diesem Abschnitt hängt von der Version ab. Weitere Informationen erhalten Sie, wenn Sie im Inhaltsverzeichnis auf der linken Seite eine Version unter REST-API für Office 365 Referenz auswählen.
Sie können mit einem Kommentar zur Laufzeit antworten, oder Sie können zuerst einen Antwortentwurf erstellen, dann den Entwurf aktualisieren und versenden.
Sie können nur an den Absender der Nachricht oder an alle Empfänger gleichzeitig antworten.
- Dem Absender zur Laufzeit antworten
- Zur Laufzeit allen antworten
- Einen Entwurf einer Antwortnachricht erstellen
- Einen Entwurf einer Antwortnachricht an alle erstellen
Dem Absender zur Laufzeit antworten
Mindestens erforderlicher Bereich
Einer der folgenden:
Antworten Sie dem Absender einer Nachricht, indem Sie einen Kommentar angeben und die Methode Reply verwenden. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ können Sie, wenn Sie aktualisierbare Eigenschaften für die Antwort ändern müssen, zuerst einen Entwurf einer Antwortnachricht erstellen, die Nachrichteneigenschaften aktualisieren und dann die Antwort versenden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/reply
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, auf die geantwortet werden soll. |
Text-Parameter | ||
Kommentar | Zeichenfolge | Ein Kommentar, der eingefügt werden kann. Kann eine leere Zeichenfolge sein. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8DmAAA=/reply
Content-Type: application/json
{
"Comment": "Sounds great! See you tomorrow."
}
Beispielantwort
Status code: 202
Zur Laufzeit allen antworten
Mindestens erforderlicher Bereich
Einer der folgenden:
Antworten Sie allen Empfängern einer Nachricht durch Angabe eines Kommentars und Verwendung der Methode ReplyAll. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ können Sie, wenn Sie irgendwelche aktualisierbare Eigenschaften für die Antwort ändern müssen, zuerst einen Entwurf einer Antwortnachricht an alle erstellen, die Nachrichteneigenschaften aktualisieren und dann die Antwort versenden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/replyall
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, auf die geantwortet werden soll. |
Text-Parameter | ||
Kommentar | Zeichenfolge | Ein Kommentar, der eingefügt werden kann. Kann eine leere Zeichenfolge sein. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0MSz8DmAAA=/replyall
Content-Type: application/json
{
"Comment": "Thanks for the heads up."
}
Beispielantwort
Status code: 202
Einen Entwurf einer Antwortnachricht erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellen Sie einen Antwort-Entwurf auf die angegebene Nachricht. Anschließend können Sie den Entwurf aktualisieren, um den Antwortinhalt zum Text hinzuzufügen oder andere Nachrichteneigenschaften ändern. Sie können den Entwurf auch einfach versenden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/createreply
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, auf die geantwortet werden soll. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKoAAA=')",
"@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO\"",
"Id": "AAMkADA1MTAAAH5JKoAAA=",
"CreatedDateTime": "2016-03-15T08:33:43Z",
"LastModifiedDateTime": "2016-03-15T08:33:43Z",
"ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DO",
"Categories": [ ],
"ReceivedDateTime": "2016-03-15T08:33:43Z",
"SentDateTime": "2016-03-15T08:33:43Z",
"HasAttachments": false,
"InternetMessageId": "<DM2PR00MB00571796B16132601E1F286CF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
"Subject": "RE: Let's start a group",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n<body>Fanny, would you name the group if the project is approved, please?\r\n<b>From:</b> Fanny Downs<br>\r\n<b>Sent:</b> Friday, March 4, 2016 12:23:35 AM<br>\r\n<b>To:</b> Admin<br>\r\n<b>Subject:</b> Re: Let's start a group</font>\r\n<p>That's a great idea!<br>\r\n</body>\r\n</html>"
},
"BodyPreview": "Fanny, would you name the group if the project is approved, please?\r\n________________________________\r\nFrom: Fanny Downs\r\nSent: Friday, March 4, 2016 12:23:35 AM\r\nTo: Admin\r\nSubject: Re: Let's start a group\r\n\r\n\r\nThat's a gre",
"Importance": "Normal",
"ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
"Sender": {
"EmailAddress": {
"Name": "Admin",
"Address": "admin@contoso.onmicrosoft.com"
}
},
"From": null,
"ToRecipients": [
{
"EmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@contoso.onmicrosoft.com"
}
}
],
"CcRecipients": [ ],
"BccRecipients": [ ],
"ReplyTo": [ ],
"ConversationId": "AAQkADA1MTVGjIwpLvWmGtIo-aFE=",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": true,
"WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKoAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"MentionedMe": null,
"AppliedHashtagsPreview": null,
"LikesPreview": null,
"MentionsPreview": null,
"Mentioned": [ ],
"InferenceClassification": "Focused",
"UnsubscribeData": [ ],
"UnsubscribeEnabled": false,
"Flag": { "FlagStatus": "NotFlagged" }
}
Antworttyp
Die Nachricht des Antwortentwurfs mit den Eigenschaften ToRecipient, IsDraft und anderen geeigneten Eigenschaften ist vorausgefüllt.
Einen Entwurf einer Antwortnachricht an alle erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellen Sie einen Entwurf, um dem Absender und allen Empfängern der angegebenen Nachricht zu antworten. Anschließend können Sie den Entwurf aktualisieren, um den Antwortinhalt zum Text hinzuzufügen oder andere Nachrichteneigenschaften ändern. Sie können den Entwurf auch einfach versenden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/createreplyall
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, auf die geantwortet werden soll. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8DmAAA=/createreplyall
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k5AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF\"",
"Id": "AAMkAGE0Mz7k5AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhF",
"Categories": [],
"CreatedDateTime": "2014-10-18T21:21:06Z",
"LastModifiedDateTime": "2014-10-18T21:21:06Z",
"Subject": "RE: Check out the new Office 365 APIs",
"BodyPreview": "If the project gets approved, please decide on the name.\r\n_________________________________\r\nFrom: Alex D\r\nSent: Saturday, October 18, 2014 9:18:18 PM\r\nTo: Katie Jordan; Garth Fort\r\nSubj",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n...</html>\r\n"
},
"Importance": "Normal",
"HasAttachments": false,
"ParentFolderId": "AAMkAGE0MAAEPAAA=",
"From": null,
"Sender": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Katie Jordan"
}
},
{
"EmailAddress": {
"Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Garth Fort"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGE0M3HbTkEU=",
"ReceivedDateTime": "2014-10-18T21:21:06Z",
"SentDateTime": "2014-10-18T21:21:06Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": true,
"IsRead": true
}
Antworttyp
Die Nachricht des Antwortentwurfs mit den Eigenschaften ToRecipient, IsDraft und anderen geeigneten Eigenschaften ist vorausgefüllt.
Neue oder entworfene Nachrichten weiterleiten
Hinweis
Das Verhalten der Vorgänge in diesem Abschnitt hängt von der Version ab. Weitere Informationen erhalten Sie, wenn Sie im Inhaltsverzeichnis auf der linken Seite eine Version unter REST-API für Office 365 Referenz auswählen.
Sie können eine Nachricht direkt weiterleiten oder Sie können einen Entwurf einer Weiterleitungsnachricht erstellen, aktualisieren und dann versenden.
Eine Nachricht direkt weiterleiten
Mindestens erforderlicher Bereich
Einer der folgenden:
Leiten Sie eine Nachricht mit der Methode Forward weiter und geben Sie optional einen Kommentar an. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ, wenn Sie irgendwelche aktualisierbare Eigenschaften in der zu übermittelnden Nachricht ändern müssen, können Sie zuerst einen Entwurf einer Weiterleitungsnachricht erstellen, die Nachrichteneigenschaften aktualisieren und dann die Antwort versenden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/forward
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, die weitergeleitet werden soll. |
Text-Parameter | ||
Kommentar | Zeichenfolge | Ein Kommentar, der eingefügt werden kann. Kann eine leere Zeichenfolge sein. |
ToRecipients | Sammlung (Empfänger) | Die Liste der Empfänger. |
Geben Sie die Parameter Comment und ToRecipients im Anforderungstext an.
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8DmAAA=/forward
Content-Type: application/json
{
"Comment": "FYI",
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
}
},
{
"EmailAddress": {
"Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
}
}
]
}
Beispielantwort
Status code: 202
Entwurf für eine Weiterleitungsnachricht erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellen Sie einen Entwurf, um die angegebene Nachricht weiterzuleiten. Anschließend können Sie den Entwurf aktualisieren, um dem Text Inhalte hinzuzufügen oder andere Nachrichteneigenschaftenzu ändern. Sie können den Entwurf auch einfach senden.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/createforward
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, die weitergeleitet werden soll. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8DmAAA=/createforward
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k6AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG\"",
"Id": "AAMkAGE0Mz7k6AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AhG",
"Categories": [],
"CreatedDateTime": "2016-03-15T08:42:10Z",
"LastModifiedDateTime": "2016-03-15T08:42:10Z",
"Subject": "FW: Let's start a group",
"BodyPreview": "Dana, just want to make sure you get this.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:47:54 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubject: RE: Let's st",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n...</html>\r\n"
},
"Importance": "Normal",
"HasAttachments": false,
"ParentFolderId": "AAMkAGE0MAAEPAAA=",
"From": null,
"Sender": {
"EmailAddress": {
"Address": "'alexd@contoso.onmicrosoft.com'",
"Name": "Alex D"
}
},
"ToRecipients": [],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGE0M3HbTkEU=",
"ReceivedDateTime": "2016-03-15T08:42:10Z",
"SentDateTime": "2016-03-15T08:42:10Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": true,
"IsRead": true
}
Antworttyp
Die Nachricht des Antwortentwurfs ist mit IsDraft und entsprechenden Eigenschaften vorausgefüllt.
Nachricht aktualisieren
Ändern Sie die beschreibbaren Eigenschaften in einer Nachricht und speichern Sie die Änderungen.
Eine Nachricht aktualisieren
Mindestens erforderlicher Bereich
Einer der folgenden:
Ändern Sie beschreibbare Eigenschaften in einem Entwurf oder einer bestehenden Nachricht. Nur die Eigenschaften, die Sie angeben, werden geändert.
PATCH https://outlook.office.com/api/v2.0/me/messages/{message_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der zu aktualisierenden Nachricht. |
Geben Sie im Anforderungstext eine oder mehrere beschreibbare Nachrichten Eigenschaften an.
Beispielanfrage
PATCH https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8S-AAA=
Content-Type: application/json
{
"Categories": [
"Orange category",
"Green category"
],
"IsRead": true
}
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8S-AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
"Id": "AAMkAGE0Mz8S-AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
"Categories": [
"Orange category",
"Green category"
],
"CreatedDateTime": "2014-10-17T17:12:15Z",
"LastModifiedDateTime": "2014-10-19T03:24:35Z",
"Subject": "Meeting notes from today",
"BodyPreview": "See attached",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n...</html>\r\n"
},
"Importance": "Normal",
"HasAttachments": true,
"ParentFolderId": "AAMkAGE0MAAEMAAA=",
"From": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"Sender": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Katie Jordan"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGE0Mip-qvhs=",
"ReceivedDateTime": "2014-10-17T17:12:15Z",
"SentDateTime": "2014-10-17T17:12:12Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": false,
"IsRead": true
}
Antworttyp
Die aktualisierte Nachricht.
Nachrichten löschen
Hinweis
Seien Sie vorsichtig, wenn Sie Nachrichten löschen. Gelöschte Inhalte können möglicherweise nicht wiederhergestellt werden. Weitere Informationen finden Sie unter Elemente löschen.
Eine Nachricht löschen
Mindestens erforderlicher Bereich
Einer der folgenden:
DELETE https://outlook.office.com/api/v2.0/me/messages/{message_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der zu löschenden Nachricht. |
Beispielanfrage
DELETE https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8TBAAA=
Beispielantwort
Status code: 204
Nachrichten verschieben oder kopieren
Sie können eine Nachricht in einen Ordner verschieben oder kopieren.
Eine Nachricht verschieben
Mindestens erforderlicher Bereich
Einer der folgenden:
Verschiebt eine Nachricht in einen Ordner. Dadurch wird eine neue Kopie der Nachricht im Zielordner erstellt.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/move
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der zu verschiebenden Nachricht. |
Text-Parameter | ||
DestinationId | Zeichenfolge | Die ID des Zielordners oder der bekannte Ordnername Inbox , Drafts , SentItems oder DeletedItems . |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGI2TIy-AAA=/move
Content-Type: application/json
{
"DestinationId": "AAMkAGI2AAEJAAA="
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0MGz_vSAAA=')",
"@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
"Id": "AAMkAGI2shBhAAA=",
"ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
"Categories": [],
"CreatedDateTime": "2014-10-20T00:13:21Z",
"LastModifiedDateTime": "2014-10-20T00:13:23Z",
"Subject": "Contract Signing",
"BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
"Body": {
"ContentType": "Text",
"Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
},
"Importance": "Normal",
"HasAttachments": false,
"ParentFolderId": "AAMkAGI2AAEJAAA=",
"From": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"Sender": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Katie Jordan"
}
},
{
"EmailAddress": {
"Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Garth Fort"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGI2NGWgitxag=",
"ReceivedDateTime": "2014-10-20T00:13:21Z",
"SentDateTime": "2014-10-20T00:13:21Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": false,
"IsRead": true
}
Antworttyp
Die Nachricht, die verschoben wurde.
Eine Nachricht kopieren
Mindestens erforderlicher Bereich
Einer der folgenden:
Mit dieser API können Sie Nachrichten in Ordner kopieren.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/copy
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der zu kopierenden Nachricht. |
Text-Parameter | ||
DestinationId | Zeichenfolge | Die ID des Zielordners oder der bekannte Ordnername Inbox , Drafts , SentItems oder DeletedItems . |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGI2TIy-AAA=/copy
Content-Type: application/json
{
"DestinationId": "inbox"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8TDAAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
"Id": "AAMkAGI2T8DtAAA=",
"ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
"Categories": [],
"CreatedDateTime": "2014-10-20T00:13:21Z",
"LastModifiedDateTime": "2014-10-20T00:13:23Z",
"Subject": "Contract Signing",
"BodyPreview": "There will be a detailed legal review of Project Falcon once the contract is ready.",
"Body": {
"ContentType": "Text",
"Content": "There will be a detailed legal review of Project Falcon once the contract is ready."
},
"Importance": "Normal",
"HasAttachments": false,
"ParentFolderId": "AAMkAGE0MAAEMAAA=",
"From": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"Sender": {
"EmailAddress": {
"Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Alex D"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "katiej@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Katie Jordan"
}
},
{
"EmailAddress": {
"Address": "garthf@a830edad9050849NDA1.onmicrosoft.com",
"Name": "Garth Fort"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"ConversationId": "AAQkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAQAKjRc0YJSUBJpofjWgitxag=",
"ReceivedDateTime": "2014-10-20T00:13:21Z",
"SentDateTime": "2014-10-20T00:13:21Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": false,
"IsRead": true
}
Antworttyp
Die neue Kopie der Nachricht.
Posteingang mit Relevanz verwalten
Mit dem Posteingang mit Relevanz können Sie wichtige Nachrichten auf der Registerkarte Focused
des Posteingangs und die restlichen Posteingangsnachrichten auf der Registerkarte Other
verwalten. Das Klassifizierungssystem organisiert anfänglich Nachrichten im Posteingang mit einer Standardmethode. Sie können das System mit der Zeit über die Benutzeroberfläche oder programmgesteuert korrigieren und trainieren. Je häufiger Sie das System verwenden, desto besser kann es schließen, welche eingehenden Nachrichten wichtig sind.
Auf programmgesteuerter Ebene funktioniert der Posteingang mit Relevanz-REST-API mit den Nachrichten des angegebenen Benutzers und unterstützt eine InferenceClassification-Eigenschaft für jede Nachricht. Die möglichen Werte sind Focused
und Other
, die angeben, ob der Benutzer diese Nachricht für wichtiger bzw. weniger wichtig hält. Um das Nachrichtenklassifikationssystem zu korrigieren und zu trainieren, verwenden Sie die PATCH-Operation in der Eigenschaft InferenceClassification auf Nachrichtenebene.
Mit der Posteingang mit Relevanz-REST-API können Sie auch Overrides erstellen. Jede Außerkraftsetzung, durch eine InferenceClassificationOverride-Instanz dargestellt, ist eine Anweisung an das Klassifizierungssystem, Nachrichten von einem bestimmten Sender immer konsistent (d. h. immer als „Relevant“ oder immer als „Sonstige“) zu kennzeichnen, unabhängig von einem zuvor erlernten Ansatz. Sie können Außerkraftsetzungen für den angegebenen Benutzer erstellen, abrufen, aktualisieren und löschen. Die Außerkraftsetzungen dieses Benutzers, falls vorhanden, sind in einer NavigationseigenschaftInferenceClassification zugänglich, die eine Sammlung von InferenceClassificationOverride-Instanzen ist. Außerkraftsetzungen ermöglichen dem Benutzer mehr Kontrolle über die Klassifizierung eingehender Nachrichten und erhöhen das Vertrauen in das Klassifizierungssystem.
Beachten Sie, dass das Klassifizierungssystem die Klassifizierung nur bei eingehenden Nachrichten im Posteingang lernt und anwendet. Nachrichten in anderen Ordnern sind standardmäßig "Relevant". Das Einrichten einer Außerkraftsetzung wirkt sich auf zukünftige Nachrichten im Posteingang aus; die Außerkraftsetzung ändert nicht die Eigenschaft InferenceClassification in bestehenden Nachrichten in einem beliebigen Ordner, einschließlich dem Posteingang.
Trainieren des Nachrichten-Klassifizierungssystems
Verwenden von Außerkraftsetzungen, um einheitlich nach Absender zu klassifizieren
- Eine Außerkraftsetzung für einen Absender erstellen
- Alle Benutzer-Außerkraftsetzungen abrufen
- Aktualisieren einer Außerkraftsetzung für einen Absender
- Die Außerkraftsetzung eines Absenders löschen
Nachrichtenklassifizierung aktualisieren
Mindestens erforderlicher Bereich
Einer der folgenden:
Ändert die Eigenschaft InferenceClassification der angegebenen Nachricht. Wenn sich die Nachricht im Posteingang befindet, sieht der Benutzer diese Nachricht unter dem entsprechenden Reiter Focused
oder Other
. Diese Art der Korrektur trainiert auch das Nachrichtenklassifikationssystem, um die zukünftige Klassifikation für den angegebenen Benutzer anzupassen.
PATCH https://outlook.office.com/api/v2.0/me/messages('{message_id}')
PATCH https://outlook.office.com/api/v2.0/Users('{user_id}')/messages('{message_id}')
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID des zu sendenden Nachrichtenentwurfs. |
user_id | Zeichenfolge | Die E-Mail-Adresse des Benutzers. |
Antworttyp
Die aktualisierte Nachricht.
Beispielanfrage
Dieses Beispiel ändert die Eigenschaft InferenceClassification in Other
für die angegebene Nachricht des angemeldeten Benutzers.
PATCH https://outlook.office.com/api/v2.0/me/messages('AAMkADA1MTQBAAA=')
{
"InferenceClassification": "Other"
}
Beispielantwort
Das hier gezeigte Antwort-Objekt zeigt die aktualisierte Eigenschaft InferenceClassification und wird zur besseren Lesbarkeit gekürzt. Eine aktuelle PATCH-Anforderung gibt alle Eigenschaften der Nachricht zurück.
Status code: 200 OK
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTQBAAA=')",
"@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAffAsD\"",
"Id": "AAMkADA1MTQBAAA=",
"Importance": "Normal",
"Sender": {
"EmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@adatum.onmicrosoft.com"
}
},
"From": {
"EmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@adatum.onmicrosoft.com"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Name": "Admin",
"Address": "admin@adatum.onmicrosoft.com"
}
}
],
"InferenceClassification": "Other"
}
Eine Außerkraftsetzung für einen Absender erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellen einer Außerkraftsetzung für einen Absender, der durch eine SMTP-Adresse identifiziert wird. Künftige Nachrichten von dieser SMTP-Adresse werden durchgängig klassifiziert wie in der Außerkraftsetzung angegeben.
Hinweis
- Wenn bereits eine Überschreibung mit derselben STMP-Adresse existiert, werden die Felder ClassifyAs und Name dieser Überschreibung mit den angegebenen Werten aktualisiert.
- Die maximale Anzahl von Überschreibungen, die für ein Postfach unterstützt werden, ist 1000, basierend auf eindeutigen SMTP-Absenderadressen.
- Im Rahmen des POST-Vorgangs kann immer nur eine Außerkraftsetzung gleichzeitig definiert werden. Um mehrere Außerkraftsetzungen zu erzeugen, können Sie mehrere POST-Anforderungen senden oder sie batchen.
POST https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides
POST https://outlook.office.com/api/v2.0/Users('{user_id}')/InferenceClassification/Overrides
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
user_id | Zeichenfolge | Die E-Mail-Adresse des Benutzers. |
Antworttyp
Die neu erstellte Instanz InferenceClassificationOverride, oder die aktualisierte Instanz InferenceClassificationOverride, wenn bereits eine Instanz mit der gleichen SMTP-Adresse existiert.
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides
{
"ClassifyAs": "Focused",
"SenderEmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@adatum.onmicrosoft.com"
}
}
Beispielantwort
Status code: 201 Created
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/InferenceClassification/Overrides/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf11a9b9')",
"Id": "98f5bdef-576a-404d-a2ea-07a3cf11a9b9",
"ClassifyAs": "Focused",
"SenderEmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@adatum.onmicrosoft.com"
}
}
Alle Benutzer-Außerkraftsetzungen abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Dient zum Abrufen der Außerkraftsetzungen, die ein Benutzer eingerichtet hat, um Nachrichten von bestimmten Absendern immer auf eine bestimmte Art und Weise zu klassifizieren.
Jede Außerkraftsetzung entspricht einer SMTP-Adresse eines Absenders. Zu Beginn hat ein Benutzer keine Außerkraftsetzungen.
GET https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides
GET https://outlook.office.com/api/v2.0/Users('{user_id}')/InferenceClassification/Overrides
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
user_id | Zeichenfolge | Die E-Mail-Adresse des Benutzers. |
Antworttyp
Eine Sammlung von InferenceClassificationOverride-Instanzen. Eine leere Sammlung wird zurückgegeben, wenn der Benutzer keine Überschreibungen eingerichtet hat.
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides
Beispielantwort
Status code: 200 OK
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/InferenceClassification/Overrides",
"value": [
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf11a9b9')",
"Id": "98f5bdef-576a-404d-a2ea-07a3cf11a9b9",
"ClassifyAs": "Focused",
"SenderEmailAddress": {
"Name": "Fanny Downs",
"Address": "fannyd@adatum.onmicrosoft.com"
}
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')",
"Id": "98f5bdef-576a-404d-a2ea-07a3cf34af4r",
"ClassifyAs": "Other",
"SenderEmailAddress": {
"Name": "Randi Welch",
"Address": "randiw@adatum.onmicrosoft.com"
}
}
]
}
Aktualisieren einer Außerkraftsetzung für einen Absender
Mindestens erforderlicher Bereich
Einer der folgenden:
Ändern Sie das Feld classifyAs einer Überschreibung wie angegeben.
Sie können PATCH nicht zum Ändern von anderen Feldern in einer inferenceClassificationOverride-Instanz verwenden.
Wenn eine Überschreibung für einen Absender vorhanden ist und der Absender den Anzeigenamen ändert, können Sie POST zum Erzwingen einer Aktualisierung des Namensfelds in der vorhandenen Überschreibung verwenden.
Wenn eine Außerkraftsetzung für einen Absender vorhanden ist und der Absender die SMTP-Adresse ändert, können Sie die Außerkraftsetzung für diesen Absender nur „aktualisieren“, indem Sie die vorhandene Außerkraftsetzung löschen und eine neue Außerkraftsetzung mit der neuen SMTP-Adresse erstellen.
PATCH https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides('{override_id}')
PATCH https://outlook.office.com/api/v2.0/Users('{user_id}')/InferenceClassification/Overrides('{override_id}')
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
override_id | Zeichenfolge | Die ID der zu aktualisierenden Außerkraftsetzung |
user_id | Zeichenfolge | Die E-Mail-Adresse des Benutzers. |
Antworttyp
Die aktualisierte Instanz InferenceClassificationOverride.
Beispielanfrage
Das folgende Beispiel ändert eine Außerkraftsetzung für den angemeldeten Benutzer. Die Außerkraftsetzung ist für den Absender mit der SMTP-Adresse randiw@adatum.onmicrosoft.com von Other
auf Focused
.
PATCH https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')
{
"ClassifyAs": "Focused"
}
Beispielantwort
Status code: 200 OK
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/InferenceClassification/Overrides/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/InferenceClassificationOverrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')",
"Id": "98f5bdef-576a-404d-a2ea-07a3cf34af4r",
"ClassifyAs": "Focused",
"SenderEmailAddress": {
"Name": "Randi Welch",
"Address": "randiw@adatum.onmicrosoft.com"
}
}
Die Außerkraftsetzung eines Absenders löschen
Mindestens erforderlicher Bereich
Einer der folgenden:
Löscht eine Außerkraftsetzung, die durch ihre ID angegeben ist.
DELETE https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides('{override_id}')
DELETE https://outlook.office.com/api/v2.0/Users('{user_id}')/InferenceClassification/Overrides('{override_id}')
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
override_id | Zeichenfolge | Die ID des zu sendenden Nachrichtenentwurfs. |
user_id | Zeichenfolge | Die E-Mail-Adresse des Benutzers. |
Beispielanfrage
DELETE https://outlook.office.com/api/v2.0/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')
Beispielantwort
Status code: 204 No Content
@-Menüs verwalten (Vorschauversion)
Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Regeln verwalten (Vorschauversion)
Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Abbestellen (Vorschauversion)
Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Sprachauswahl abrufen (Vorschauversion)
Dieses Feature ist derzeit nur in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Zeitzonenauswahl abrufen (Vorschauversion)
Dieses Feature ist derzeit nur in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Postfacheinstellungen abrufen
Mindestens erforderlicher Bereich
Einstellungen für das Hauptpostfach des angemeldeten Benutzers. Beispiele für Einstellungen sind die bevorzugte Sprache und die Standardzeitzone des Benutzers sowie alle automatischen Antworteinstellungen.
GET https://outlook.office.com/api/v2.0/me/MailboxSettings
Antworttyp
Um nur die bevorzugte Spracheinstellung unter allen Postfach-Einstellungen zu erhalten:
GET https://outlook.office.com/api/beta/me/MailboxSettings/Language
Antworttyp
Um nur die bevorzugte Zeitzoneneinstellung unter allen Postfach-Einstellungen zu erhalten:
GET https://outlook.office.com/api/beta/me/MailboxSettings/TimeZone
Antworttyp
Eine Zeichenkette, die die bevorzugte Zeitzone im Windows-Zeitzonenformat darstellt.
Sie können auch die Einstellungen für die automatische Antwort abrufen.
Beispielanfrage
Im folgenden Beispiel werden alle Postfacheinstellungen für den angemeldeten Benutzer abgerufen.
GET https://outlook.office.com/api/v2.0/me/MailboxSettings
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailboxSettings",
"AutomaticRepliesSetting": {
"Status": "Scheduled",
"ExternalAudience": "All",
"ScheduledStartDateTime": {
"DateTime": "2016-03-14T07:00:00.0000000",
"TimeZone": "UTC"
},
"ScheduledEndDateTime": {
"DateTime": "2016-03-28T07:00:00.0000000",
"TimeZone": "UTC"
},
"InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
"ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
},
"TimeZone": "Pacific Standard Time",
"Language":{
"Locale":"en-US",
"DisplayName":"English (United States)"
}
}
Automatische Antworteinstellungen abrufen
Mindestens erforderlicher Bereich
Rufen Sie die automatischen Antworteinstellungen des Postfachs des angemeldeten Benutzers ab.
Automatische Antworten ermöglichen es Ihnen, Personen automatisch mit einer Nachricht zu benachrichtigen, wenn sie Ihnen eine E-Mail senden. Beispielsweise können Sie sie benachrichtigen, wenn Sie nicht verfügbar sind und nicht darauf reagieren können.
Da automatische Antworten Teil der Postfach-Einstellungen des Benutzers sind (dargestellt durch MailboxSettings), können Sie die Einstellungen für automatische Antworten anzeigen, indem Sie alle Mailbox-Einstellungen abrufen, die Einstellungen für automatische Antworten enthalten, oder indem Sie speziell die Einstellungen für automatische Antworten abrufen.
Sie können den HTTP-Header Prefer: outlook.timezone
verwenden, um die bevorzugte Zeitzone für die Anzeige der Werte ScheduledStartDateTime und ScheduledEndDateTime anzugeben.
GET https://outlook.office.com/api/v2.0/me/MailboxSettings/AutomaticRepliesSetting
Antworttyp
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/MailboxSettings/AutomaticRepliesSetting
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailboxSettings/AutomaticRepliesSetting",
"Status": "AlwaysEnabled",
"ExternalAudience": "None",
"ScheduledStartDateTime": {
"DateTime": "2016-03-19T02:00:00.0000000",
"TimeZone": "UTC"
},
"ScheduledEndDateTime": {
"DateTime": "2016-03-20T02:00:00.0000000",
"TimeZone": "UTC"
},
"InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
"ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
}
Automatische Antworteinstellungen aktualisieren
Mindestens erforderlicher Bereich
Automatische Antworten sind Teil der Postfach-Einstellungen des Benutzers (dargestellt durch MailboxSettings). Sie können automatische Antworten aktivieren, konfigurieren oder deaktivieren, indem Sie die entsprechenden Postfacheinstellungen aktualisieren.
Hinweis
Sie können keine Postfacheinstellungen erstellen oder löschen.
PATCH https://outlook.office.com/api/v2.0/me/MailboxSettings
Antworttyp
Beispielanfrage
Nach dem vorherigen Beispiel, das automatische Antworteinstellungen liefert, ändert das nächste Beispiel den Status von AlwaysEnabled
in Scheduled
, und das Start- und Enddatum in einen anderen Datumsbereich.
PATCH https://outlook.office.com/api/v2.0/me/MailboxSettings
Content-Type: application/json
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailboxSettings",
"AutomaticRepliesSetting": {
"Status": "Scheduled",
"ScheduledStartDateTime": {
"DateTime": "2016-03-20T18:00:00.0000000",
"TimeZone": "UTC"
},
"ScheduledEndDateTime": {
"DateTime": "2016-03-28T18:00:00.0000000",
"TimeZone": "UTC"
}
}
}
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailboxSettings",
"AutomaticRepliesSetting": {
"Status": "Scheduled",
"ExternalAudience": "None",
"ScheduledStartDateTime": {
"DateTime": "2016-03-20T02:00:00.0000000",
"TimeZone": "UTC"
},
"ScheduledEndDateTime": {
"DateTime": "2016-03-28T02:00:00.0000000",
"TimeZone": "UTC"
},
"InternalReplyMessage": "<html>\n<body>\n<p>I'm at our company's worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n",
"ExternalReplyMessage": "<html>\n<body>\n<p>I'm at the Contoso worldwide reunion and will respond to your message as soon as I return.<br>\n</p></body>\n</html>\n"
},
"TimeZone": "Pacific Standard Time",
"Language":{
"Locale":"en-US",
"DisplayName":"English (United States)"
}
}
E-Mail-Info abrufen (Vorschauversion)
Dieses Feature ist derzeit in der Beta-Version verfügbar. Um mehr zu erfahren wechseln Sie im Inhaltsverzeichnis auf der linken Seite zum Abschnitt Office 365-REST-API-Referenz und wählen Sie beta.
Anlagen abrufen
Sie können eine Anlagensammlung oder einen Anhang abrufen.
Eine Anlagen-Sammlung abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Die Anhänge einer bestimmten Nachricht abrufen.
GET https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Hinweis
Standardmäßig enthält jede Anlage in der Antwort alle ihre Eigenschaften, die diesem Anlagentyp entsprechen. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Antworttyp
Eine Anlagensammlung, die vom Typ FileAttachment oder ItemAttachment sein kann.
Beispiel-Anforderungen und -Antworten
Das folgende Beispiel zeigt, wie man $select
verwendet, um nur die Eigenschaft Name jeder Dateianlage in der Antwort zurückzugeben. Siehe die erste Beispielantwort in Eine Anlage abrufen für eine vollständige Liste der Eigenschaften, die für eine Anlage zurückgegeben würden, wenn Sie nicht $select
verwenden.
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGI2THVSAAA=/attachments?$select=Name
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages('AAMkAGI2THVSAAA%3D')/Attachments(Name)",
"value": [
{
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2THVSAAA=')/Attachments('AAMkAGI2j4kShdM=')",
"Id": "AAMkAGI2j4kShdM=",
"Name": "minutes.docx"
}
]
}
Das folgende Beispiel zeigt den Abruf der einzigen Anlage, die ein Outlook-Mail-Element ist. Die Antwort enthält eine Anlagen-ID, die gleichzeitig die ID der angehängten Nachricht ist.
GET https://outlook.office.com/api/v2.0/me/messages('AAMkADFiNTPAAA=')/attachments
Content-Type: application/json
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
"value": [
{
"@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-20075df800e5@1717622f-1d94-4d0c-9d74-f907ad6677b4')/Messages('AAMkADFiNTPAAA=')/Attachments('AAMkADFiNTAUhhYuYi0=')",
"Id": "AAMkADFiNTAUhhYuYi0=",
"Name": "How to retrieve item attachment using Outlook REST API",
"ContentType": message/rfc822,
"Size": 71094,
"IsInline": false,
"LastModifiedDateTime": "2015-09-24T05:57:59Z",
}
]
}
Eine Anlage abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Rufen Sie eine Anlage von einer bestimmten Nachricht ab.
GET https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments/{attachment_id}
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
attachment_id | Zeichenfolge | Die Anlagen-ID. |
Hinweis
Standardmäßig enthält die Antwort alle Eigenschaften des Anhangs. Verwenden Sie $select
, um nur die Eigenschaften anzugeben, die Sie für die beste Leistung benötigen. Ein Beispiel findet sich unter Eine Anlagensammlung abrufen. Die ID-Eigenschaft wird immer zurückgegeben. Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Antworttyp
Die angeforderte Dateianlage oder Elementanlage.
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGI2THVSAAA=/attachments/AAMkAGI2j4kShdM=
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Messages('AAMkAGI2THVSAAA%3D')/Attachments/$entity",
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGI2THVSAAA=')/Attachments('AAMkAGI2j4kShdM=')",
"Id": "AAMkAGI2j4kShdM=",
"LastModifiedDateTime": "2014-10-20T00:41:52Z",
"Name": "minutes.docx",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"Size": 11585,
"IsInline": false,
"ContentId": null,
"ContentLocation": null,
"ContentBytes": "UEsDBBQABgAIAAAAIQDCAAA4KQAAAAA="
}
Beispielanforderung (Verweisanlage)
Das folgende Beispiel liefert die Verweisanlage einer Nachricht.
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments/AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments/$entity",
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
"LastModifiedDateTime": "2016-03-12T06:04:38Z",
"Name": "Koala picture",
"ContentType": null,
"Size": 382,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
"ProviderType": "OneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "Edit",
"IsFolder": false
}
Beispielanforderung ($expand für Anlagen)
Das folgende Beispiel erweitert alle 3 Verweisanlagen inline mit den Nachrichteneigenschaften und ruft diese ab.
GET https://outlook.office.com/api/v2.0/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/?$expand=attachments
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages/$entity",
"@odata.etag": "W/\"CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZsPav\"",
"Id": "AAMkAGE1Mbs88AADUv0uFAAA=",
"CreatedDateTime": "2016-03-08T01:01:57Z",
"LastModifiedDateTime": "2016-03-12T06:18:54Z",
"ChangeKey": "CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZsPav",
"Categories": [ ],
"ReceivedDateTime": "2016-03-08T01:01:57Z",
"SentDateTime": "2016-03-08T01:01:51Z",
"HasAttachments": true,
"InternetMessageId": "<SN2SR0101MB00299F0D7D22EE5D380104ED84B20@SN2SR0101MB0029.namsdf01.sdf.exchangelabs.com>",
"Subject": "RE: New year activity",
"Body": {
"ContentType": "html",
"Content": "<html>\r\n<<body>Let's gather to celebrate the new year! </body>\r\n</html>\r\n"
},
"BodyPreview": "What about the tulips?\r\n________________________________\r\nFrom: Dana Swope <danas@contoso.onmicrosoft.com>\r\nSent: Monday, March 7, 2016 10:51:39 PM\r\nTo: Dana Swope; Culinary Expert Group\r\nSubject: RE: New year activity\r\n\r\nLet's gather to celebrate the new year! ",
"Importance": "Normal",
"ParentFolderId": "AQMkAGE1MQN7j5uzzwAAAIBDAAAAA==",
"Sender": {
"EmailAddress": {
"Name": "Dana Swope",
"Address": "danas@contoso.onmicrosoft.com"
}
},
"From": {
"EmailAddress": {
"Name": "Dana Swope",
"Address": "danas@contoso.onmicrosoft.com"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Name": "Dana Swope",
"Address": "danas@contoso.onmicrosoft.com"
}
},
{
"EmailAddress": {
"Name": "Culinary Expert Group",
"Address": "Chefs@contoso.onmicrosoft.com"
}
}
],
"CcRecipients": [ ],
"BccRecipients": [ ],
"ReplyTo": [ ],
"ConversationId": "AAQkAGE1MMM2SaRFsKgx7BKVfig=",
"ConversationIndex": "AQHRaThgdSG4wzZJpEWwqDHsEpV+KJ9OtWGUgAAkYLI=",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": false,
"WebLink": "https://outlook.office.com/owa/?ItemID=AAMkAGE1Mbs88AADUv0uFAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"InferenceClassification": "Focused",
"UnsubscribeData": [ ],
"UnsubscribeEnabled": false,
"Flag": { "FlagStatus": "NotFlagged" },
"Attachments@odata.context": "https://outlook.office.com/api/beta/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments",
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=",
"LastModifiedDateTime": "2016-03-12T05:54:31Z",
"Name": "Personal pictures",
"ContentType": null,
"Size": 362,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics",
"ProviderType": "OneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "edit",
"IsFolder": true
},
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
"LastModifiedDateTime": "2016-03-12T06:04:38Z",
"Name": "Koala picture",
"ContentType": null,
"Size": 382,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
"ProviderType": "OneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "edit",
"IsFolder": false
},
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAO3wkFiM3KlCpn81m8qS1W0=",
"LastModifiedDateTime": "2016-03-12T06:18:54Z",
"Name": "Hydrangea picture",
"ContentType": null,
"Size": 412,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg",
"ProviderType": "OneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "edit",
"IsFolder": false
}
]
}
Beispielanforderung ($expand bei verschachtelten Anlagen)
Das folgende Beispiel ruft ein verschachteltes Anlage-Element ab.
GET https://outlook-sdf.office.com/api/v2.0/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments/AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=$expand=Microsoft.OutlookServices.ItemAttachment/Item
Beispielantwort
Status code: 200
{
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAL53d0u3BKBJmCxKVxZKBZ8=",
"LastModifiedDateTime": "2017-04-25T20:05:55Z",
"Name": "RE: Changes to GetConditionMetadata handler",
"ContentType": null,
"Size": 78927,
"IsInline": false,
"Item": {
"Id": "",
"Name": "How to retrieve item attachment using Outlook REST API",
"ContentType": message/rfc822,
"Size": 71094,
"IsInline": false,
"LastModifiedDateTime": "2015-09-24T05:57:59Z",
}
}
Anlagen erstellen
Sie können einen Dateianhang erstellen oder für eine Nachricht eine Elementanlage erstellen.
Eine Dateianlage erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Fügen Sie einer Nachricht eine Dateianlage hinzu.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Text-Parameter | ||
@odata.type | Zeichenfolge | #Microsoft.OutlookServices.FileAttachment |
Name | Zeichenfolge | Der Name der Anlage. |
ContentBytes | Binär | Die Datei, die angehängt werden soll. |
Geben Sie die Parameter Name und ContentBytes und alle beschreibbaren Dateianlagen Eigenschaften im Anforderungstext an.
Antworttyp
Die neue Dateianlage.
Eine Elementanlage erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Fügen Sie einer Nachricht eine Elementanlage hinzu.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Text-Parameter | ||
@odata.type | Zeichenfolge | #Microsoft.OutlookServices.ItemAttachment |
Name | Zeichenfolge | Der Name der Anlage. |
Element | Eine Nachricht oder Ereignis-Entität. | Das anzufügende Element. |
Geben Sie die Parameter Name und Item und alle beschreibbaren Elementanlagen Eigenschaften im Anforderungstext an.
Antworttyp
Die neue Elementanlage.
Eine Verweisanlage erstellen
Mindestens erforderlicher Bereich
Einer der folgenden:
Fügen Sie einer Nachricht eine Verweisanlage hinzu.
POST https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Text-Parameter | ||
@odata.type | Zeichenfolge | #Microsoft.OutlookServices.ReferenceAttachment |
Name | Zeichenfolge | Der Anzeigename der Anlage. Erforderlich. |
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. |
Geben Sie die Parameter Name und SourceUrl und alle beschreibbaren Verweisanlagen Eigenschaften im Anforderungstext an.
Antworttyp
Die Verweisanlage.
Beispielanfrage
Das folgende Beispiel fügt eine Verweisanlage einer bestehenden Nachricht hinzu. Die Anlage ist eine Verknüpfung mit einer Datei auf OneDrive for Business.
POST https://outlook.office.com/api/v2.0/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments
Content-Type: application/json
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Name": "Koala picture",
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
"ProviderType": "oneDriveBusiness",
"Permission": "Edit",
"IsFolder": "False"
}
Beispielantwort
Status code: 201 Created
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADUv0uFAAA%3D')/attachments/$entity",
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=",
"LastModifiedDateTime": "2016-03-12T06:04:38Z",
"Name": "Koala picture",
"ContentType": null,
"Size": 382,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/koala.jpg",
"ProviderType": "oneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "edit",
"IsFolder": false
}
Beispielanfrage
Das folgende Beispiel fügt eine Verweisanlage im gleichen Aufruf wie das Erstellen eines Nachrichtenentwurfs hinzu. Die Anlage ist eine Verknüpfung mit einer Datei auf OneDrive for Business.
POST https://outlook.office.com/api/v2.0/me/messages
Content-Type: application/json
{
"Subject": "Plan for dinner",
"Body": {
"ContentType": "HTML",
"Content": "Office anniversary is coming soon!"
},
"ToRecipients": [
{
"EmailAddress": {
"Address": "randiw@contoso.onmicrosoft.com"
}
}
],
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Name": "Hydrangea picture",
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg",
"ProviderType": "oneDriveBusiness",
"Permission": "Edit",
"IsFolder": "False"
}
]
}
Beispielantwort
Status code: 201 Created
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages/$entity",
"@odata.etag": "W/\"CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZ8qi1\"",
"Id": "AAMkAGE1Mbs88AADZ0CU9AAA=",
"CreatedDateTime": "2016-03-12T09:04:54Z",
"LastModifiedDateTime": "2016-03-12T09:04:54Z",
"ChangeKey": "CQAAABYAAACY4MQpaFz9SbqUDe4+bs88AADZ8qi1",
"Categories": [ ],
"ReceivedDateTime": "2016-03-12T09:04:54Z",
"SentDateTime": "2016-03-12T09:04:54Z",
"HasAttachments": true,
"InternetMessageId": "<BL2SR0101MB00188944566BDECE6EDE57F384B60@BL2SR0101MB0018.namsdf01.sdf.exchangelabs.com>",
"Subject": "Plan for dinner",
"Body": {
"ContentType": "html",
"Content": "<html>\r\n<body>\r\nOffice anniversary is coming soon!\r\n</body>\r\n</html>\r\n"
},
"BodyPreview": "Office anniversary is coming soon!",
"Importance": "normal",
"ParentFolderId": "AQMkAGE1MQN7j5uzzwAAAIBDwAAAA==",
"Sender": null,
"From": null,
"ToRecipients": [
{
"EmailAddress": {
"Name": "Randi Welch",
"address": "randiw@contoso.onmicrosoft.com"
}
}
],
"CcRecipients": [ ],
"BccRecipients": [ ],
"ReplyTo": [ ],
"ConversationId": "AAQkAGE1MMAAQAJk0cqqggzpKtIHErqyDkcU=",
"ConversationIndex": "AQHRfD4+mTRyqqCDOkq0gcSurIORxQ==",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": true,
"WebLink": "https://outlook.office.com/owa/?ItemID=AAMkAGE1Mbs88AADZ0CU9AAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"InferenceClassification": "focused",
"UnsubscribeData": [ ],
"UnsubscribeEnabled": false,
"Flag": { "flagStatus": "notFlagged" },
"Attachments@odata.context": "https://outlook.office.com/api/v2.0/$metadata#users('ddfcd489-628b-40d7-b48b-57002df800e5')/messages('AAMkAGE1Mbs88AADZ0CU9AAA%3D')/attachments",
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.ReferenceAttachment",
"Id": "AAMkAGE1Mbs88AADZ0CU9AAABEgAQAGe4H1iqXwtLsrCCLLkDxqo=",
"LastModifiedDateTime": null,
"Name": "Hydrangea picture",
"ContentType": null,
"Size": 0,
"IsInline": false,
"SourceUrl": "https://contoso-my.spoppe.com/personal/danas_contoso_onmicrosoft_com/Documents/Pics/hydrangea.jpg",
"ProviderType": "oneDriveBusiness",
"ThumbnailUrl": null,
"PreviewUrl": null,
"Permission": "edit",
"IsFolder": false
}
]
}
Anlagen löschen
Mindestens erforderlicher Bereich
Einer der folgenden:
Löscht die angegebene Anlage einer Nachricht. Die Anlage kann eine Dateianlage oder Elementanlage sein.
DELETE https://outlook.office.com/api/v2.0/me/messages/{message_id}/attachments/{attachment_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
attachment_id | Zeichenfolge | Die Anlagen-ID. |
Beispielanfrage
DELETE https://outlook.office.com/api/v2.0/me/messages/AAMkAGE0Mz8S-AAA=/attachments/AAMkAGE0Mg67gL7o=
Beispielantwort
Status code: 204
Ordner abrufen
Sie können eine Ordner-Sammlung oder einen Ordner im Postfach des Benutzers abrufen.
Eine Ordnersammlung abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Holen Sie sich die Ordner-Sammlung unter dem Stammordner des angemeldeten Benutzers (.../me/MailFolders
) oder unter dem angegebenen Ordner. Sie können die .../me/MailFolders
Verknüpfung zum Abrufen der Ordnersammlung auf oberster Ebene und zum Navigieren zu einem anderen Ordner verwenden.
GET https://outlook.office.com/api/v2.0/me/MailFolders
GET https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/childfolders
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die Ordner-ID oder die Inbox , Drafts , SentItems , oder DeletedItems bekannter Ordnername, wenn Sie Ordner aus einem bestimmten Ordner erhalten. |
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/MailFolders
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders",
"value": [
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEKAAA=')",
"Id": "AAMkAGI2AAEKAAA=",
"DisplayName": "Deleted Items",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 0,
"TotalItemCount": 1
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEPAAA=')",
"Id": "AAMkAGI2AAEPAAA=",
"DisplayName": "Drafts",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 0,
"TotalItemCount": 0
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEMAAA=')",
"Id": "AAMkAGI2AAEMAAA=",
"DisplayName": "Inbox",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 6,
"TotalItemCount": 6
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEeAAA=')",
"Id": "AAMkAGI2AAEeAAA=",
"DisplayName": "Junk Email",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 0,
"TotalItemCount": 0
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAELAAA=')",
"Id": "AAMkAGI2AAELAAA=",
"DisplayName": "Outbox",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 0,
"TotalItemCount": 0
},
{
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEJAAA=')",
"Id": "AAMkAGI2AAEJAAA=",
"DisplayName": "Sent Items",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 0,
"TotalItemCount": 3
}
]
}
Antworttyp
Die angeforderte Ordner-Sammlung.
Einen Ordner abrufen
Mindestens erforderlicher Bereich
Einer der folgenden:
Einen Ordner nach ID abrufen.
GET https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}
Einen Postfachordner abrufen, der von einem Benutzer freigegeben wurde:
GET https://outlook.office.com/api/v2.0/users/{user_id}/mailFolders/{folder_id}
Hinweis
Siehe OData Abfrage-Parameter für Filter-, Sortier- und Paging-Parameter.
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Beispielanfrage
GET https://outlook.office.com/api/v2.0/me/MailFolders/inbox
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGI2AAEMAAA=')",
"Id": "AAMkAGI2AAEMAAA=",
"DisplayName": "Inbox",
"ParentFolderId": "AAMkAGI2AAEIAAA=",
"ChildFolderCount": 0,
"UnreadItemCount": 6,
"TotalItemCount": 6
}
Beispielanfrage
Einen von einem anderen Benutzer freigegebenen Ordner abrufen
GET https://outlook.office.com/api/v2.0/users/8c14ebe1-e4ba-4232cd011db47/mailFolders/AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM
Beispielantwort
HTTP/1.1 200 OK
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM')",
"Id": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM",
"DisplayName": "Inbox",
"ParentFolderId": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4QCHGmLqkYhISaO_lSymODLQABa6L5YpAAA=",
"ChildFolderCount": 4,
"UnreadItemCount": 27962,
"TotalItemCount": 64420
}
Antworttyp
Der angeforderte Ordner.
Ordnerhierarchie synchronisieren
Sie können eine flache Tabelle aller Ordner in einem Postfach abrufen. Wenn Sie eine E-Mail-Ordnerhierarchie synchronisieren, fordern Sie diese Kategorie an.
Endpunkt | Ordnerkategorie |
---|---|
Ich/MailFolders | E-Mail-Ordner |
Sie können nur die oberste Ebene jeder Ordnerkategorie synchronisieren. Zum Beispiel können Sie Me/MailFolders, aber nicht Me/MailFolders('inbox') anfordern.
Die Synchronisation unterstützt sowohl die Vollsynchronisation, die alle Ordner in einer Hierarchie abruft, als auch die inkrementelle Synchronisation, die alle Ordner abruft, die sich seit der letzten Vollsynchronisation geändert haben.
Mindestens erforderlicher Bereich
Einer der folgenden:
GET https://outlook.office.com/api/v2.0/me/MailFolders
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
Headerparameter | ||
Bevorzugen | odata.trackchanges | Zeigt an, dass es sich bei der Anforderung um eine Synchronisierungsanforderung handelt. |
Text-Parameter | ||
odata.deltaLink | Zeichenfolge | Das Token, das das letzte Mal anzeigt, dass der Ordner synchronisiert wurde. |
Wenn einer der folgenden Abfrageparameter - $filter
, $orderby
, $search
, $top
- in der Anfrage enthalten sind, werden sie ignoriert.
Antworttyp
Eine flache Liste der Ordner in der gewünschten Kategorie.
Ordner erstellen
Fügen Sie einen neuen Ordner zu einer Ordner-Sammlung hinzu.
Erstellen eines Ordners
Mindestens erforderlicher Bereich
Einer der folgenden:
Erstellen Sie einen Unterordner mit dem in DisplayName angegebenen Namen. DisplayName ist die einzige beschreibbare Eigenschaft für einen Ordner.
POST https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/childfolders
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Text-Parameter | ||
Anzeigename | Zeichenfolge | Der Anzeigename des Ordners. |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/MailFolders/inbox/childfolders
Content-Type: application/json
{
"DisplayName": "Company"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders('inbox')/ChildFolders/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGE0Mz-l_AAA=')",
"Id": "AAMkAGE0Mz-l_AAA=",
"ParentFolderId": "AAMkAGE0MAAEMAAA=",
"DisplayName": "Company",
"ChildFolderCount": 0,
"UnreadItemCount": 2,
"TotalItemCount": 27
}
Antworttyp
Der neue Ordner.
Bemerkungen
Sie können keinen übergeordneten Ordner erstellen. Sie können nur einen Ordner zu einem childfolders
Endpunkt hinzufügen.
Ordner aktualisieren
Einen Ordnernamen ändern.
Aktualisieren eines Ordners
Mindestens erforderlicher Bereich
Einer der folgenden:
Ändern Sie den Ordnernamen auf den in DisplayNameangegebenen Namen. Der Name ist die einzige beschreibbare Eigenschaft für einen Ordner.
PATCH https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Text-Parameter | ||
Anzeigename | Zeichenfolge | Der neue Anzeigename des Ordners. |
Beispielanfrage
PATCH https://outlook.office.com/api/v2.0/me/MailFolders/AAMkAGE0Mz-l_AAA=
Content-Type: application/json
{
"DisplayName": "Business"
}
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGE0Mz-l_AAA=')",
"Id": "AAMkAGE0Mz-l_AAA=",
"ParentFolderId": "AAMkAGE0MAAEMAAA=",
"DisplayName": "Business",
"ChildFolderCount": 0,
"UnreadItemCount": 4,
"TotalItemCount": 38
}
Antworttyp
Der aktualisierte Ordner.
Ordner löschen
Einen Ordner und seinen gesamten Inhalt löschen.
Hinweis
Seien Sie vorsichtig, wenn Sie Ordner löschen. Gelöschte Inhalte können möglicherweise nicht wiederhergestellt werden. Weitere Informationen finden Sie unter Elemente löschen.
Löschen eines Ordners
Mindestens erforderlicher Bereich
Einer der folgenden:
Löschen Sie den in folder_id angegebenen Ordner.
DELETE https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Beispielanfrage
DELETE https://outlook.office.com/api/v2.0/me/MailFolders/AAMkAGE0Mz-l_AAA=
Beispielantwort
Status code: 204
Ordner verschieben oder kopieren
Sie können einen Ordner in einen anderen Ordner verschieben oder kopieren.
Einen Ordner verschieben
Mindestens erforderlicher Bereich
Einer der folgenden:
Verschieben Sie einen Ordner und seinen Inhalt in einen anderen Ordner mit der Methode Move.
POST https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/move
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Text-Parameter | ||
DestinationId | Zeichenfolge | Die ID des Zielordners oder der bekannte Ordnername Inbox , Drafts , SentItems oder DeletedItems . |
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/MailFolders/AAMkAGE0Mz-l_AAA=/move
Content-Type: application/json
{
"DestinationId": "AAMkAGE0MyxQ9AAA="
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGE0Mz-l_AAA=')",
"Id": "AAMkAGE0Mz-l_AAA=",
"ParentFolderId": "AAMkAGE0MyxQ9AAA=",
"DisplayName": "Business",
"ChildFolderCount": 0,
"UnreadItemCount": 4,
"TotalItemCount": 38
}
Antworttyp
Der Ordner, der verschoben wurde.
Einen Ordner kopieren
Mindestens erforderlicher Bereich
Einer der folgenden:
Kopieren Sie einen Ordner und seinen Inhalt in einen anderen Ordner mit der Methode Copy.
Beispielanfrage
POST https://outlook.office.com/api/v2.0/me/MailFolders/{folder_id}/copy
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die ID des Ordners oder dieInbox , Drafts , SentItems , oder DeletedItems der bekannte Ordnername. |
Text-Parameter | ||
DestinationId | Zeichenfolge | Die ID des Zielordners oder der bekannte Ordnername Inbox , Drafts , SentItems oder DeletedItems . |
POST https://outlook.office.com/api/v2.0/me/MailFolders/AAMkAGE0Mz-l_AAA=/copy
Content-Type: application/json
{
"DestinationId": "inbox"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/MailFolders('AAMkAGE0Mz-mAAAA=')",
"Id": "AAMkAGE0Mz-mAAAA=",
"ParentFolderId": "AAMkAGE0MAAEMAAA=",
"DisplayName": "Business",
"ChildFolderCount": 0,
"UnreadItemCount": 4,
"TotalItemCount": 38
}
Antworttyp
Die neue Kopie des Ordners.
Nächste Schritte
Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.
- Beginnen Sie mit den E-Mail-, Kalender- und Kontakte-REST-APIs.
- Möchten Sie Beispiele sehen? Wir haben sie.
Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform:
- 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 Anwendung manuell bei Azure AD, damit sie auf Office 365-APIs zugreifen kann
- Kalender-API-Verweis
- Kontakte-API-Verweis
- Aufgaben-REST-API (Vorschauversion)
- OneDrive-API
- Ermittlungsdienst REST-API-Operationen-Verweis
- Ressourcenversion für die REST-APIs E-Mail, Kalender und Kontakte