Outlook-Mail-REST-API-Referenz (Beta)
Gilt für: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com** **
Hinweis
Diese Dokumentation behandelt die API für @ -Bewertungen, das Abmelden von Nachrichten, schnelle Antworten sowie die Auswahl von Sprache und Zeitzone, die sich alle derzeit in der Vorschau befinden. Die Funktionen der Vorschauversion können vor der Fertigstellung geändert werden und können den Code, der sie verwendet, beschädigen. Aus diesem Grund sollten Sie in der Regel nur eine Produktionsversion einer API in Ihrem Produktionscode verwenden. Falls vorhanden, ist v2.0 derzeit die bevorzugte Version.
Sie interessieren sich nicht für die Beta-Version der API? Wechseln Sie im Inhaltsverzeichnis auf der linken Seite zu Office 365 REST API reference und wählen Sie die gewünschte Version aus.
Alle Mail-API-Operationen
Nachrichtenvorgänge
Nachrichten werden in Postfachordnern gespeichert, sodass Nachrichtenendpunkte häufig den Ordner enthalten, der die Nachricht enthält. Ein Ordner wird entweder durch die ID oder durch einen der folgenden bekannten Ordnernamen spezifiziert: 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
- Löschen von Nachrichten
- Nachrichten verschieben oder kopieren
- Verwalten des relevanten Posteingangs
- Verwalten von @ Erwähnungen (Vorschau)
- Regeln verwalten (Vorschau)
- Abmelden (Vorschau)
- Sprachauswahl abrufen (Vorschau)
- Zeitzonenauswahl abrufen (Vorschau)
- Postfacheinstellungen abrufen
- Automatische Antworteinstellungen abrufen
- Automatische Antworteinstellungen aktualisieren
- Abrufen von E-Mail-Infos (Vorschau)
- Anhänge abrufen
- Anhänge erstellen
- Anhänge löschen
Ordnervorgänge
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 Text HTML ist, wird standardmäßig jedes potentiell unsichere HTML (z. B. JavaScript), das in die Text-Eigenschaft eingebettet ist, entfernt, bevor der Inhalt des Textes in einer REST-Antwort zurückgegeben wird.
Fügen Sie den gesamten, ursprünglichen HTML-Inhalt ein, um den folgenden HTTP-Anforderungs-Header abzurufen:
Prefer: outlook.allow-unsafe-html
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
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.
Abrufen einer Nachrichtensammlung aus dem gesamten Postfach des angemeldeten Benutzers (einschließlich der Ordner Gelöschte Objekte und Clutter Ordner).
GET https://outlook.office.com/api/beta/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/beta/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/beta/me/MailFolders/sentitems/messages/?$select=Sender,Subject
Beispielantwort
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders('sentitems')/Messages(Sender,Subject)",
"value": [
{
"@odata.id": "https://outlook.office.com/api/beta/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/beta/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/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Eine Nachricht nach ID abrufen.
GET https://outlook.office.com/api/beta/me/messages/{message_id}
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Beispielanfrage
GET https://outlook.office.com/api/beta/me/messages/AAMkAGI2THVSAAA=
Beispielantwort
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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",
"InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
"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=",
"ConversationIndex": "AQHRh3zqrkAcds2kw==",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": false,
"IsDraft": false,
"WebLink": "https://outlook.office365.com/owa/?ItemID=AAMkAGI2THVSAAA%3D&exvsurl=1&viewmodel=ReadMessageItem"
}
Antworttyp
Die angefragte 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/beta/me/messages/AAMkAGE1I5MTAAA=?$select=Sender,Subject
Nachrichten synchronisieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
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.
Anforderungsheader
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 vollständige Nachrichtensynchronisationsrunde:
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/beta/me/MailFolders('{folder_id}')/messages
Zweite Anforderung oder erste Anforderung einer nachfolgenden Runde
GET https://outlook.office365.com/api/beta/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 eine@odata.deltaLink
Kopfzeile mit einem deltaToken
enthält.
GET https://outlook.office365.com/api/beta/me/MailFolders('{folder_id}')/messages/?$skipToken={skip_token}
Parameter | Typ | Beschreibung |
---|---|---|
Kopfzeilen-Parameter | ||
Bevorzugt | 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. |
Bevorzugt | 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 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 eine erste Anforderung
GET https://outlook.office.com/api/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages?$select=Subject,Sender HTTP/1.1
Prefer: odata.maxpagesize=2
Prefer: odata.track-changes
Beispiel für die anfänglichen Antwortdaten
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/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/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/beta/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/beta/Me/MailFolders('AAMkAGI5MAAAwW-j-AAA=')/messages/?%24select=Subject%2cSender&%24deltatoken=MfzCBD5nm2dcGAFGk5qypL1PSyEAADFmX28BAAAA"
}
Beispiel für eine zweite Anforderung
Die zweite Anforderung gibt deltaToken
aus der vorherigen Antwort zurück.
GET https://outlook.office.com/api/beta/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/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/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/beta/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/beta/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/beta/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/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/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/beta/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/beta/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/beta/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/beta/$metadata#Me/MailFolders('AAMkAGI5MAAAwW-j-AAA%3D')/Messages(Subject,Sender)/$delta",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/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/beta/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/beta/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/beta/$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.
- Spontan eine neue Nachricht versenden
- Einen Nachrichtenentwurf erstellen
- Einen Nachrichtenentwurf versenden
Spontan eine neue Nachricht versenden
Minimal benötigter Bereich
Eine der folgenden Varianten:
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 die Nachricht auch im Ordner Gesendete Objekte speichern.
POST https://outlook.office.com/api/beta/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/beta/me/sendmail
Content-Type: application/json
{
"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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellt einen Entwurf einer neuen Nachricht. Entwürfe können in einem beliebigen Ordner erstellt und vor dem Versand optional aktualisiert werden. Um den Ordner Entwürfe zu speichern, verwenden Sie die Verknüpfung /me/messages
.
POST https://outlook.office.com/api/beta/me/messages
POST https://outlook.office.com/api/beta/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/beta/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/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz7k0AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5\"",
"Id": "AAMkAGE0Mz7k0AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0Ag5",
"Categories": [],
"InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
"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=",
"ConversationIndex": "AQHRf4zqrkAcds2kw==",
"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
Minimal benötigter Bereich
Eine der folgenden Varianten:
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/beta/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/beta/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 in einem Aufruf auf eine Nachricht antworten, einen Kommentar hinzufügen oder Nachrichteneigenschaften aktualisieren, oder Sie können zuerst einen Antwortentwurf erstellen und alle Nachrichteneigenschaften in einem Aufruf aktualisieren und dann den Entwurf senden.
Sie können nur an den Absender der Nachricht oder an alle Empfänger gleichzeitig antworten.
- Antwort an den Absender im laufenden Betrieb
- Allen im laufenden Betrieb antworten
- Einen Entwurf einer Antwortnachricht erstellen
- Einen Entwurf einer Antwortnachricht an alle erstellen
Antwort an den Absender im laufenden Betrieb
Minimal benötigter Bereich
Eine der folgenden Varianten:
Sie können dem Absender einer Nachricht antworten, einen Kommentar hinzufügen oder beliebige aktualisierbare Eigenschaften ändern, alle in einem einzigen Antworten-Aufruf. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ können Sie zuerst einen Entwurf einer Antwortnachricht erstellen, um einen Kommentar einzufügen oder Nachrichteneigenschaften zu aktualisieren und dann die Antwort versenden.
POST https://outlook.office.com/api/beta/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. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Antwortnachricht aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Wenn ReplyTo per Internet Message Format (RFC 2822) in der ursprünglichen Nachricht angegeben ist, sollten Sie die Antwort an die Empfänger mit ReplyTo und nicht an den Empfänger in Fromsenden.
Beispielanfrage
Das folgende Beispiel enthält einen Kommentar und fügt der Antwortnachricht einen Empfänger hinzu.
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAAqldOAAA=/reply
Content-Type: application/json
{
"Message":{
"ToRecipients":[
{
"EmailAddress": {
"Address":"fannyd@contoso.onmicrosoft.com",
"Name":"Fanny Downs"
}
},
{
"EmailAddress":{
"Address":"randiw@contoso.onmicrosoft.com",
"Name":"Randi Welch"
}
}
]
},
"Comment": "Fanny, Randi, would you name the group please?"
}
Beispielantwort
Status code: 202
Allen im laufenden Betrieb antworten
Minimal benötigter Bereich
Eine der folgenden Varianten:
Antworten Sie allen Empfängern einer Nachricht, indem Sie einen Kommentar angeben und alle aktualisierbaren Eigenschaften für die Antwort ändern, und zwar alles mit der Methode ReplyAll. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ können Sie zuerst einen Entwurf einer Antwortnachricht erstellen, um einen Kommentar einzufügen oder jegliche Nachrichteneigenschaften zu aktualisieren, und dann die Antwort versenden.
POST https://outlook.office.com/api/beta/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. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Nachricht "Allen antworten" aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Wenn ReplyTo per Internet Message Format (RFC 2822) in der ursprünglichen Nachricht angegeben ist, sollten Sie die Antwort an die Empfänger mit ReplyTo und ToRecipients gesendet werden und nicht an die Empfänger in From und ToRecipients.
Beispielanfrage
Das folgende Beispiel enthält einen Kommentar und fügt eine Anlage zu der "Allen antworten"-Nachricht hinzu.
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaKAAA=/ReplyAll
Content-Type: application/json
{
"Message":{
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"Name": "guidelines.txt",
"ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
}
]
},
"Comment": "Please take a look at the attached guidelines before you decide on the name."
}
Beispielantwort
Status code: 202
Einen Entwurf einer Antwortnachricht erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellen Sie einen Entwurf der Antwortnachricht, um einen Kommentar einzufügen oder aktualisieren Sie Nachrichteneigenschaften, alles in einem CreateReply-Aufruf. Sie können den Nachrichtenentwurf dann versenden.
POST https://outlook.office.com/api/beta/me/messages/{message_id}/createreply
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. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Antwortnachricht aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Wenn ReplyTo per Internet Message Format (RFC 2822) in der ursprünglichen Nachricht angegeben ist, sollten Sie die Antwort an die Empfänger mit ReplyTo und nicht an den Empfänger in Fromsenden.
Beispielanfrage
Das folgende Beispiel erstellt einen Antwortentwurf, fügt einen Kommentar und fügt einen Empfänger in den Anforderungstext ein.
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAAqldOAAA=/createreply
Content-Type: application/json
{
"Message":{
"ToRecipients":[
{
"EmailAddress": {
"Address":"fannyd@contoso.onmicrosoft.com",
"Name":"Fanny Downs"
}
}
]
},
"Comment": "Fanny, would you name the group if the project is approved, please?"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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=",
"ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBHStBQ=",
"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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellen Sie einen Entwurf der Antwortnachricht an alle, um einen Kommentar einzufügen oder aktualisieren Sie alle Nachrichteneigenschaften, alles in einem CreateReplyAll-Anruf. Sie können den Nachrichtenentwurf dann versenden.
POST https://outlook.office.com/api/beta/me/messages/{message_id}/createreplyall
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der Nachricht, auf die allen geantwortet werden soll. |
Text-Parameter | ||
Kommentar | Zeichenfolge | Ein Kommentar, der eingefügt werden kann, kann eine leere Zeichenfolge sein. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Nachricht "Allen antworten" aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Wenn ReplyTo per Internet Message Format (RFC 2822) in der ursprünglichen Nachricht angegeben ist, sollten Sie die Antwort an die Empfänger mit den Eigenschaften ReplyTo und ToRecipients gesendet werden und nicht an die Empfänger in den Eigenschaften From und ToRecipients.
Beispielanfrage
Das folgende Beispiel erstellt einen Entwurf, um allen zu antworten und fügt eine Anlage und einen Kommentar direkt in einem CreateReplyAll-Aufruf hinzu.
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaKAAA=/createreplyall
Content-Type: application/json
{
"Message":{
"Attachments": [
{
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"Name": "guidelines.txt",
"ContentBytes": "bWFjIGFuZCBjaGVlc2UgdG9kYXk="
}
]
},
"Comment": "if the project gets approved, please take a look at the attached guidelines before you decide on the name."
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKpAAA=')",
"@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DP\"",
"Id": "AAMkADA1MTAAAH5JKpAAA=",
"CreatedDateTime": "2016-03-15T08:37:34Z",
"LastModifiedDateTime": "2016-03-15T08:37:34Z",
"ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DP",
"Categories": [ ],
"ReceivedDateTime": "2016-03-15T08:37:34Z",
"SentDateTime": "2016-03-15T08:37:34Z",
"HasAttachments": true,
"InternetMessageId": "<DM2PR00MB005732BE05BD669AC7CE056EF7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
"Subject": "RE: Let's start a group",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n<body dir=\"ltr\">\r\nif the project gets approved, please take a look at the attached guidelines before you decide on the name.\r\n<b>From:</b> Admin<br>\r\n<b>Sent:</b> Tuesday, March 15, 2016 6:36:32 AM<br>\r\n<b>To:</b> Fanny Downs; Randi Welch<br>\r\n<b>Subject:</b> RE: Let's start a group\r\n<div>Fanny, Randi, would you name the group 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</body>\r\n</html>"
},
"BodyPreview": "if the project gets approved, please take a look at the attached guidelines before you decide on the name.\r\n________________________________\r\nFrom: Admin\r\nSent: Tuesday, March 15, 2016 6:36:32 AM\r\nTo: Fanny Downs; Randi Welch\r\nSubj",
"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"
}
},
{
"EmailAddress": {
"Name": "Randi Welch",
"Address": "randiw@contoso.onmicrosoft.com"
}
}
],
"CcRecipients": [ ],
"BccRecipients": [ ],
"ReplyTo": [ ],
"ConversationId": "AAQkADA1MTLvWmGtIo-aFE=",
"ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBGx9qGAACHRQA==",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": true,
"WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKpAAA%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.
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 in einem Aufruf eine Nachricht weiterleiten, einen Kommentar hinzufügen oder Nachrichteneigenschaften aktualisieren, oder Sie können zuerst einen Entwurf erstellen und alle Nachrichteneigenschaften in einem Aufruf aktualisieren und dann den Entwurf senden.
Eine Nachricht direkt weiterleiten
Minimal benötigter Bereich
Eine der folgenden Varianten:
Sie können eine Nachricht weiterleiten, einen Kommentar hinzufügen oder beliebige aktualisierbare Eigenschaften ändern, alle in einem einzigen Weiterleiten-Aufruf. Eine Kopie der Nachricht wird im Ordner Gesendete Objekte gespeichert.
Alternativ können Sie zuerst einen Entwurf einer Weiterleitungsnachricht erstellen, um einen Kommentar einzufügen oder jegliche Nachrichteneigenschaften zu aktualisieren und dann den Nachrichtenentwurf versenden.
POST https://outlook.office.com/api/beta/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 | Collection(Recipient) | Die Liste der Empfänger. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Antwortnachricht aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Sie müssen entweder den Parameter
ToRecipients
oder die Eigenschaft ToRecipients des ParametersMessage
angeben. Die Angabe von beiden oder keine der beiden Parameter gibt einen Fehler HTTP 400 Ungültige Anforderung zurück.
Beispielanfrage
Das folgende Beispiel setzt die Eigenschaft IsDeliveryReceiptRequested auf true, fügt einen Kommentar hinzu und leitet die Nachricht weiter.
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/forward
Content-Type: application/json
{
"Message":{
"IsDeliveryReceiptRequested": true,
"ToRecipients":[
{
"EmailAddress": {
"Address":"danas@contoso.onmicrosoft.com",
"Name":"Dana Swope"
}
}
]
},
"Comment": "Dana, just want to make sure you get this."
}
Beispielantwort
Status code: 202
Entwurf für eine Weiterleitungsnachricht erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellen Sie einen Entwurf einer Weiterleitungsnachricht mit einem Kommentar oder aktualisieren Sie alle Nachrichteneigenschaften alle in einem CreateForward-Aufruf. Sie können den Nachrichtenentwurf dann versenden.
POST https://outlook.office.com/api/beta/me/messages/{message_id}/createforward
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 | Collection(Recipient) | Die Liste der Empfänger. |
Nachricht | Nachricht | Alle beschreibbaren Eigenschaften, die in der Antwortnachricht aktualisiert werden sollen. |
Hinweis
- Sie können entweder einen Kommentar oder die Eigenschaft Text des Parameters
Message
angeben. Die Angabe von beiden gibt einen Fehler HTTP 400 Ungültige Anforderung zurück. - Sie müssen entweder den Parameter
ToRecipients
oder die Eigenschaft ToRecipients des ParametersMessage
angeben. Die Angabe von beiden oder keine der beiden Parameter gibt einen Fehler HTTP 400 Ungültige Anforderung zurück.
Beispielanfrage
POST https://outlook.office.com/api/beta/me/messages/AAMkADA1MTAAAH5JaLAAA=/createforward
Content-Type: application/json
{
"Message":{
"IsDeliveryReceiptRequested": true,
"ToRecipients":[
{
"EmailAddress": {
"Address":"danas@contoso.onmicrosoft.com",
"Name":"Dana Swope"
}
}
]
},
"Comment": "Dana, just want to make sure you get this; you'll need this if the project gets approved."
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('86b6ceaf-57f7-4278-97c4-4da0a97f6cdb@70559e59-b378-49ea-8e53-07a3a3d27f5b')/Messages('AAMkADA1MTAAAH5JKqAAA=')",
"@odata.etag": "W/\"CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DQ\"",
"Id": "AAMkADA1MTAAAH5JKqAAA=",
"CreatedDateTime": "2016-03-15T08:42:10Z",
"LastModifiedDateTime": "2016-03-15T08:42:10Z",
"ChangeKey": "CQAAABYAAADX8oL1Wa7jQbcPAHouCzswAAAH5/DQ",
"Categories": [ ],
"ReceivedDateTime": "2016-03-15T08:42:10Z",
"SentDateTime": "2016-03-15T08:42:10Z",
"HasAttachments": true,
"InternetMessageId": "<DM2PR00MB0057E0EBC90EF37FC9233941F7890@DM2PR00MB0057.namprd00.prod.outlook.com>",
"Subject": "FW: Let's start a group",
"Body": {
"ContentType": "HTML",
"Content": "<html>\r\n<body>\r\nDana, just want to make sure you get this; you'll need this if the project gets approved.\r\n<b>From:</b> Admin<br>\r\n<b>Sent:</b> Tuesday, March 15, 2016 6:47:54 AM<br>\r\n<b>To:</b> Fanny Downs; Randi Welch<br>\r\n<b>Subject:</b> RE: Let's start a group</body>\r\n</html>\r\n"
},
"BodyPreview": "Dana, just want to make sure you get this; you'll need this if the project gets approved.\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",
"Importance": "Normal",
"ParentFolderId": "AQMkADA1MTAAAAIBDwAAAA==",
"Sender": {
"EmailAddress": {
"Name": "Admin",
"Address": "admin@contoso.onmicrosoft.com"
}
},
"From": null,
"ToRecipients": [
{
"EmailAddress": {
"Name": "Dana Swope",
"Address": "danas@contoso.onmicrosoft.com"
}
}
],
"CcRecipients": [ ],
"BccRecipients": [ ],
"ReplyTo": [ ],
"ConversationId": "AAQkADA1MTLvWmGtIo-aFE=",
"ConversationIndex": "AQHRdar6akFxUaMjCku9aYa0ij9oUZ9IbLr7gBGx9qGAAAMtlIAAH+3c",
"IsDeliveryReceiptRequested": true,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": true,
"WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADA1MTAAAH5JKqAAA%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 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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Ä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/beta/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
Die folgende Beispielanforderung setzt zwei Kategorien in einer E-Mail-Nachricht und kennzeichnet die Nachricht mit einem Start- und Fälligkeitsdatum.
Hinweis
Hinweis: Wenn der FlagStatus auf Flagged
gesetzt ist, darf die Eigenschaft Flag.CompletedDate nicht gesetzt werden.
PATCH https://outlook.office.com/api/beta/me/messages/AAMkAGE0Mz8S-AAA=
Content-Type: application/json
{
"Categories": [
"Orange category",
"Green category"
],
"IsRead": true,
"Flag": {
"FlagStatus": "Flagged",
DueDateTime": {
"DateTime": "2017-12-22T08:00:00.0000000",
"TimeZone": "UTC"
},
"StartDateTime": {
"DateTime": "2017-12-18T08:00:00.0000000",
"TimeZone": "UTC"
}
}
}
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8S-AAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP\"",
"Id": "AAMkAGE0Mz8S-AAA=",
"ChangeKey": "CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIP",
"InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
"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=",
"ConversationIndex": "AQHRh5tqrkAcds2kw==",
"ReceivedDateTime": "2014-10-17T17:12:15Z",
"SentDateTime": "2014-10-17T17:12:12Z",
"IsDeliveryReceiptRequested": false,
"IsReadReceiptRequested": false,
"IsDraft": false,
"IsRead": true,
"Flag": {
"FlagStatus": "Flagged",
"DueDateTime": {
"DateTime": "2017-12-22T08:00:00.0000000",
"TimeZone": "UTC"
},
"StartDateTime": {
"DateTime": "2017-12-18T08:00:00.0000000",
"TimeZone": "UTC"
}
}
}
Beispielanfrage
Folgende Beispielanforderungen kennzeichnen eine zuvor markierte E-Mail-Nachricht als vollständig
PATCH https://outlook.office.com/api/beta/me/messages/AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkSLkRkXbBznTvAAEwgCZNAAA=
Content-Type: application/json; charset=utf-8
Content-Length: 164
{
"Flag": {
"CompletedDateTime":{
"DateTime": "2018-02-05T18:00:00",
"TimeZone": "Pacific Standard Time"
},
"FlagStatus": "Complete"
}
}
Beispielantwort
HTTP/1.1 200 OK
{
"Id": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkSLkRkXbBznTvAAEwgCZNAAA=",
"CreatedDateTime": "2017-12-15T22:11:41Z",
"LastModifiedDateTime": "2017-12-16T00:49:44Z",
"ChangeKey": "CQAAABYAAABmngqUDhbeSLkRkXbBznTvAAEw/ThM",
"Categories": [],
"ReceivedDateTime": "2017-12-15T22:11:41Z",
"SentDateTime": "2017-12-15T22:11:36Z",
"HasAttachments": false,
"InternetMessageId": "<e711230d-d066-469e-a128-c429c5789d97@SINGMEHUB02.gme.gbl>",
"Subject": "An agent sent you a message in Microsoft Teams",
"BodyPreview": "Hi John,\r\nYou're missing all the action in Microsoft Teams\r\n\r\n\r\nAn agent\r\nSent a new message to your chat\r\n\r\n Open Microsoft Teams\r\n\r\nRather not receive these emails? Click your profile picture, select Options and then Notificatio",
"Importance": "Normal",
"ParentFolderId": "AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkNzQ0NWVlMgAuAAAAAAB79HWXBjsTRocnYZpOfEpCAQCHGmLqkYhISaO_lSymODLQABa6L5YsAAA=",
"ConversationId": "AAQkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM4NzJkNzQ0NWVlMgAQAPQcMVQTnE5Aql13YD1jbQw=",
"ConversationIndex": "AQHTdfGv9BwxVBOcTkCqXXdgPWNtDA==",
"IsDeliveryReceiptRequested": null,
"IsReadReceiptRequested": false,
"IsRead": true,
"IsDraft": false,
"WebLink": "https://outlook.office365.com/owa/?ItemID=AAMkADTvAAEwgCZNAAA%3D&exvsurl=1&viewmodel=ReadMessageItem",
"InferenceClassification": "Other",
"UnsubscribeData": [],
"UnsubscribeEnabled": false,
"Body": {
"ContentType": "HTML",
"Content": "<html style=\"font-family:'Segoe UI',Tahoma,Geneva,Verdana,sans-serif; font-size:18px\"></html>\r\n"
},
"Sender": {
"EmailAddress": {
"Name": "Microsoft Teams",
"Address": "noreply@email.teams.microsoft.com"
}
},
"From": {
"EmailAddress": {
"Name": "Microsoft Teams",
"Address": "noreply@email.teams.microsoft.com"
}
},
"ToRecipients": [
{
"EmailAddress": {
"Name": "John",
"Address": "john@contoso.com"
}
}
],
"CcRecipients": [],
"BccRecipients": [],
"ReplyTo": [],
"MentionsPreview": null,
"Flag": {
"FlagStatus": "Complete",
"CompletedDateTime": {
"DateTime": "2018-02-06T00:00:00.0000000",
"TimeZone": "UTC"
}
}
}
Antworttyp
Die aktualisierte Nachricht.
Löschen von Nachrichten
Hinweis
Hinweis Gehen Sie beim Löschen von Nachrichten sorgfältig vor. Gelöschte Inhalte können möglicherweise nicht wiederhergestellt werden. Weitere Informationen finden Sie unter Elemente löschen.
Eine Nachricht löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
DELETE https://outlook.office.com/api/beta/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/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Verschiebt eine Nachricht in einen Ordner. Dadurch wird eine neue Kopie der Nachricht im Zielordner erstellt.
POST https://outlook.office.com/api/beta/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/beta/me/messages/AAMkAGI2TIy-AAA=/move
Content-Type: application/json
{
"DestinationId": "AAMkAGI2AAEJAAA="
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0MGz_vSAAA=')",
"@odata.etag": "W/\"CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP\"",
"Id": "AAMkAGI2shBhAAA=",
"ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
"InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
"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=",
"ConversationIndex": "AQHRh6etrkAcds2kw==",
"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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Mit dieser API können Sie Nachrichten in Ordner kopieren.
POST https://outlook.office.com/api/beta/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/beta/me/messages/AAMkAGI2TIy-AAA=/copy
Content-Type: application/json
{
"DestinationId": "inbox"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Messages('AAMkAGE0Mz8TDAAA=')",
"@odata.etag": "W/\"CQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAS0AIS\"",
"Id": "AAMkAGI2T8DtAAA=",
"ChangeKey": "CQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTJqP",
"InternetMessageId": "SN2PR00M@SN2.namprd00.prod.outlook.com",
"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=",
"ConversationIndex": "AQHRh6sdrkAcds2kw==",
"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.
Verwalten des relevanten Posteingangs
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 Nachrichtenklassifizierungssystems
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Ä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/beta/me/messages('{message_id}')
PATCH https://outlook.office.com/api/beta/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/beta/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/beta/$metadata#Me/Messages/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
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 bestimmten 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/beta/me/InferenceClassification/Overrides
POST https://outlook.office.com/api/beta/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/beta/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/beta/$metadata#Me/InferenceClassification/Overrides/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
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/beta/me/InferenceClassification/Overrides
GET https://outlook.office.com/api/beta/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/beta/me/InferenceClassification/Overrides
Beispielantwort
Status code: 200 OK
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/InferenceClassification/Overrides",
"value": [
{
"@odata.id": "https://outlook.office.com/api/beta/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/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Ä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/beta/me/InferenceClassification/Overrides('{override_id}')
PATCH https://outlook.office.com/api/beta/Users('{user_id}')/InferenceClassification/Overrides('{override_id}')
Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
override_id | Zeichenfolge | Die ID der zu aktualisierenden Überschreibung. |
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, geändert von Other
auf Focused
.
PATCH https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')
{
"ClassifyAs": "Focused"
}
Beispielantwort
Status code: 200 OK
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/InferenceClassification/Overrides/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Löscht eine Außerkraftsetzung, die durch ihre ID angegeben ist.
DELETE https://outlook.office.com/api/beta/me/InferenceClassification/Overrides('{override_id}')
DELETE https://outlook.office.com/api/beta/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/beta/me/InferenceClassification/Overrides('98f5bdef-576a-404d-a2ea-07a3cf34af4r')
Beispielantwort
Status code: 204 No Content
@-Menüs verwalten (Vorschauversion)
Einen Empfänger aufzurufen, um die Aufmerksamkeit des Empfängers in einer Nachricht zu wecken, ist eine häufige soziale Geste. Die Ressource Erwähnung bietet einen leichten Mechanismus, um einen anderen Empfänger zu benachrichtigen oder eine Benachrichtigung von einem Absender in einer Nachricht zu erhalten.
Über die Benutzeroberfläche kann eine App eine Erwähnung in eine Nachricht einfügen, indem sie der Erwähnung mit @
vorangestellt wird (häufig verwendet für ähnliche Szenarien in anderen Anwendungen, daher der Begriff @-mention). Programmatisch kann die App die Erwähnung erzeugen durch Hinzufügen zur Eigenschaft Erwähnung im gleichen Aufruf POST
zum Erstellen der Nachricht.
Die App kann den Benutzer nachschlagen lassen, ob er/sie in einer Nachricht in ihrem Posteingang benachrichtigt wurden. Benutzer können Details jeder Erwähnung in einer Nachricht finden. Die Benutzer können auch eine Erwähnung in einer Nachricht löschen.
Erwähnungen in einer neuen Nachricht erstellen
- Erstellen und Versenden von Erwähnungen als Teil einer neuen Nachricht
- Erwähnungen als Teil eines Nachrichtenentwurfs erstellen
Informationen über Erwähnungen in einer Nachricht erhalten abrufen
- Alle Nachrichten abrufen, die den angemeldeten Benutzer erwähnen
- Details zu jeder Erwähnung in einer Nachricht abrufen
Löschen einer Erwähnung in einer Nachricht
Erstellen und Versenden von Erwähnungen als Teil einer neuen Nachricht
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellen und senden Sie eine Nachricht, die eine Sammlung von einer oder mehreren Erwähnungs-Instanzen enthält.
Dies verwendet die gleiche SendMail-Aktion, die in der Message-Ressource verfügbar ist; zusätzlich wird die Mentions Eigenschaft als Teil des Message Text-Parameters verwendet.
POST https://outlook.office.com/api/beta/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. Nur erforderlich, wenn false. |
Geben Sie den Parameter Message mit der erforderlichen Eigenschaft ToRecipients, die Eigenschaft Mentions und alle beschreibbaren Message-Eigenschaften im Anforderungstext an.
Und für jede Erwähnung in der Eigenschaft Mentions müssen Sie die Eigenschaften Mentioned und CreatedBy angeben.
Beispielanfrage
POST https://outlook.office.com/api/beta/me/sendmail
Content-Type: application/json
{
"Message": {
"Subject": "Project kickoff",
"ToRecipients":[
{
"EmailAddress":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com"
}
}
],
"Mentions":[
{
"Mentioned":{
"Name":"Dana Swope",
"Address":"danas@contoso.onmicrosoft.com"
},
"CreatedBy": {
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com"
}
}
]
}
}
Beispielantwort
Status code: 202 Accepted
Erwähnungen als Teil eines Nachrichtenentwurfs erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Erstellen Sie einen Entwurf einer neuen Nachricht, die eine Sammlung von einer oder mehreren Mention-Instanzen enthält. Sie können den Entwurf in einem beliebigen Ordner erstellen und ihn optional aktualisieren bevor sie ihn versenden.
Dies verwendet die gleiche POST-Methode, die in der Message-Ressource verfügbar ist; zusätzlich wird die Eigenschaft Mentions in den Anforderungstext aufgenommen.
POST https://outlook.office.com/api/beta/me/messages
POST https://outlook.office.com/api/beta/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 die Eigenschaft Mentions und alle beschreibbaren Message-Eigenschaften im Anforderungstext an.
Und für jede Erwähnung in der Eigenschaft Mentions müssen Sie die Eigenschaften Mentioned und CreatedBy angeben.
Antworttyp
Der Entwurf der Nachricht.
Beispielanfrage
POST https://outlook.office.com/api/beta/me/messages
Content-Type: application/json
{
"Subject": "Party planning",
"ToRecipients":[
{
"EmailAddress":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com"
}
}
],
"Mentions":[
{
"Mentioned":{
"Name":"Dana Swope",
"Address":"danas@contoso.onmicrosoft.com"
},
"CreatedBy": {
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com"
}
}
]
}
Beispielantwort
Im Folgenden sehen Sie den erstellten Nachrichtenentwurf.
Hinweis
Hinweis: Das hier gezeigte Antwortobjekt wurde aus Platzgründen gekürzt. Von einem tatsächlichen Aufruf werden alle Eigenschaften zurückgegeben.
Status code: 201 Created
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAW1fsAAAAA==')",
"@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAbYj7\"",
"Id":"AQMkADJmMTUAAAW1fsAAAAA==",
"Body":{
"ContentType":"Text",
"Content":""
},
"BodyPreview":"",
"Sender":null,
"From":null,
"ToRecipients":[
{
"EmailAddress":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com"
}
}
],
"MentionsPreview":{
"IsMentioned":false
},
"Mentions@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages('AQMkADJmMTUAAAW1fsAAAAA%3D%3D')/Mentions",
"Mentions":[
{
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAW1fsAAAAA==')/Mentions('4577bba4-b063-4cea-9073-6f7ca815fcec')",
"Id":"4577bba4-b063-4cea-9073-6f7ca815fcec",
"Mentioned":{
"Name":"Dana Swope",
"Address":"danas@contoso.onmicrosoft.com",
"ExternalId":"72137a84-1a8b-4b92-aa06-cca538e8616b"
},
"MentionText":null,
"ClientReference":null,
"CreatedBy":{
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com",
"ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
},
"CreatedDateTime":"2016-07-22T02:22:44Z",
"ServerCreatedDateTime":"2016-07-22T02:22:44.201Z",
"DeepLink":null,
"Application":null
}
]
}
Alle Nachrichten abrufen, die den angemeldeten Benutzer erwähnen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Rufen Sie alle Nachrichten im Postfach des angemeldeten Benutzers oder im angegebenen Ordner ab, die eine Erwähnung dieses Benutzers enthalten.
Dies verwendet die gleiche GET-Methode, die in der Message-Ressource verfügbar ist; zusätzlich wird ein $filter
Abfrageparameter in der Eigenschaft MentionsPreview hinzugefügt.
Standardmäßig gibt ein GET /me/messages
Aufruf nicht die Eigenschaft Mentions zurück. Verwenden Sie den Abfrageparameter $expand
um Details jeder Erwähnung in einer Nachricht zu finden.
Hinweis
Stellen Sie sicher, dass Ihr tatsächlicher Aufruf die Leerzeichen in der Zeichenfolge des Abfrageparameters entsprechend codiert.
GET https://outlook.office.com/api/beta/me/messages?$filter=MentionsPreview/IsMentioned eq true
GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}/messages?$filter=MentionsPreview/IsMentioned eq true
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
folder_id | Zeichenfolge | Die Zielordner-ID oder Inbox oder Drafts oder der bekannte Ordnername. |
Antworttyp
Die angeforderte Nachrichten-Sammlung.
Beispielanfrage
Das folgende Beispiel filtert alle Nachrichten im Postfach des angemeldeten Benutzers nach denjenigen, die den Benutzer erwähnen. Es verwendet $select
, um eine Teilmenge der Eigenschaften jeder Nachricht in der Antwort zurückzugeben. Es enthält auch die URL-Codierung für die Leerzeichen in der Abfrage-Parameter-Zeichenfolge.
GET https://outlook.office.com/api/beta/me/messages?$filter=MentionsPreview/IsMentioned%20eq%20true&$select=Subject,Sender,ReceivedDateTime,MentionsPreview
Beispielantwort
Die Antwort enthält 2 Nachrichten, die den angemeldeten Benutzer erwähnen.
Status code: 200 OK
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages(Subject,Sender,ReceivedDateTime,MentionsPreview)",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')",
"@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAATI\"",
"Id":"AQMkADJmMTUAAAgVZAAAA",
"ReceivedDateTime":"2016-07-21T07:40:21Z",
"Subject":"Re: Start planning soon",
"Sender":{
"EmailAddress":{
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com"
}
},
"MentionsPreview":{
"IsMentioned":true
}
},
{
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAjwVAAAA')",
"@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAEGj\"",
"Id":"AQMkADJmMTUAAAjwVAAAA",
"ReceivedDateTime":"2016-07-21T07:40:20Z",
"Subject":"Re: Start planning soon",
"Sender":{
"EmailAddress":{
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com"
}
},
"MentionsPreview":{
"IsMentioned":true
}
}
]
}
Details zu jeder Erwähnung in einer Nachricht abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Rufen Sie eine Nachricht mit den Details jeder einzelnen Erwähnung in der erweiterten Nachricht ab.
Dies verwendet die gleiche GET-Methode, die in der Message-Ressource verfügbar ist; zusätzlich wird ein $expand
Abfrageparameter in der Navigationseigenschaft Mentions hinzugefügt.
GET https://outlook.office.com/api/beta/me/messages('{message_id}')?$expand=Mentions
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID der angeforderten Nachricht. |
Antworttyp
Die angefragte Nachricht.
Beispielanfrage
Im folgenden Beispiel ist der angemeldete Benutzer Dana Swope. Das Beispiel zeigt den Abruf der Details aller Erwähnungen in der angegebenen Nachricht in Danas Mailbox.
GET https://outlook.office.com/api/beta/me/messages('AQMkADJmMTUAAAgVZAAAA')?$expand=Mentions
Beispielantwort
Die folgende Tabelle zeigt die angeforderte Nachricht mit Details zu jeder Erwähnung in der Eigenschaft Mentions. Diese Nachricht enthält 2 Erwähnungen, eine für die angemeldeten Benutzerin Dana und die andere für Randi Welch.
Hinweis
Das Antwortobjekt, das hier gezeigt wird, wird verkürzt, um sich auf die Eigenschaften zu konzentrieren, die sich auf die Unterstützung von Erwähnung beziehen.
Status code: 200 OK
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages/$entity",
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')",
"@odata.etag":"W/\"CQAAABYAAAAPFhK2FclcRbABBJhCde8iAAAAAATI\"",
"Id":"AQMkADJmMTUAAAgVZAAAA",
"Subject":"Start planning soon",
"Body":{
"ContentType":"HTML",
"Content":"<html><head></head><body"><p><a href=\"mailto:danas@contoso.onmicrosoft.com\">@Dana Swope</a>,<a href=\"mailto:randiw@contoso.onmicrosoft.com\">@Randi Welch</a>, forgot to mention, I will be away this weekend. I can start on Monday though.</p></body></html>"
},
"BodyPreview":"@Dana Swope<mailto:danas@contoso.onmicrosoft.com>, @Randi Welch, forgot to mention, I will be away this weekend. I can start on Monday though.",
"Sender":{
"EmailAddress":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com"
}
},
"From":{
"EmailAddress":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com"
}
},
"ToRecipients":[
{
"EmailAddress":{
"Name":"Dana Swope",
"Address":"danas@contoso.onmicrosoft.com"
}
},
{
"EmailAddress":{
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com"
}
}
],
"CcRecipients":[
],
"BccRecipients":[
],
"MentionsPreview":{
"IsMentioned":true
},
"Mentions@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions",
"Mentions":[
{
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions('138f4c0a-1130-4776-b780-bf79d73abb3f')",
"Id":"138f4c0a-1130-4776-b780-bf79d73abb3f",
"Mentioned":{
"Name":"Dana Swope",
"Address":"danas@contoso.onmicrosoft.com",
"ExternalId":"72137a84-1a8b-4b92-aa06-cca538e8616b"
},
"MentionText":null,
"ClientReference":null,
"CreatedBy":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com",
"ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
},
"CreatedDateTime":"2016-07-21T07:40:20.152Z",
"ServerCreatedDateTime":"2016-07-21T07:40:20.152Z",
"DeepLink":null,
"Application":null
},
{
"@odata.id":"https://outlook.office.com/api/beta/Users('266efe5a-0fd7-4edd-877b-b2d1e561f193@ae01a323-3934-4475-a32d-af1274312bb0')/Messages('AQMkADJmMTUAAAgVZAAAA')/Mentions('7b94df1a-0086-482a-b0da-e62fae12f983')",
"Id":"7b94df1a-0086-482a-b0da-e62fae12f983",
"Mentioned":{
"Name":"Randi Welch",
"Address":"randiw@contoso.onmicrosoft.com",
"ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
},
"MentionText":null,
"ClientReference":null,
"CreatedBy":{
"Name":"Fanny Downs",
"Address":"fannyd@contoso.onmicrosoft.com",
"ExternalId":"266efe5a-0fd7-4edd-877b-b2d1e561f193"
},
"CreatedDateTime":"2016-07-21T07:40:20.158Z",
"ServerCreatedDateTime":"2016-07-21T07:40:20.158Z",
"DeepLink":null,
"Application":null
}
]
}
Eine Erwähnung löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Löscht die angegebene Erwähnung in der angegebenen Nachricht im Postfach des angemeldeten Benutzers.
DELETE https://outlook.office.com/api/beta/me/messages('{message_id}')/mentions('{mention_id}')
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
mention_id | Zeichenfolge | Die ID der zu löschenden Erwähnung. |
message_id | Zeichenfolge | Die ID der Nachricht, die die Erwähnung enthält. |
Beispielanfrage
DELETE https://outlook.office.com/api/beta/me/messages('AAMkADA1MTk1ZAAAKXBQCAAA=')/mentions('7b94df1a-0086-482a-b0da-e62fae12f983')
Beispielantwort
Status code: 204 No Content
Regeln verwalten (Vorschauversion)
In Outlook können Sie Regeln für eingehende Nachrichten im Posteingang einrichten, um bestimmte Aktionen bei bestimmten Bedingungen auszuführen.
Programmgesteuert können Sie über die messageRules -Navigationseigenschaft des Posteingangsordners auf Regeln zugreifen. Jede Regel wird von dieser messageRule-Ressource dargestellt, verfügbare Regelaktionen werden von dem komplexen Typ messageRuleActions dargestellt, und verfügbare Regelbedingungen und -ausnahmen werden von dem komplexen Typ messageRulePredicates dargestellt.
Regeln erstellen (Vorschauversion)
Minimal benötigter Bereich
Erstellen Sie eine Regel, indem Sie eine Gruppe von Bedingungen und Aktionen angeben. Outlook führt diese Aktionen aus, wenn eine eingehende Nachricht im Posteingang des Benutzers die angegebenen Bedingungen erfüllt.
POST https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules
Die folgenden Text-Parameter werden typischerweise beim Erstellen von Regeln verwendet; Sie können alle anderen beschreibbaren MessageRule-Eigenschaften entsprechend im Anforderungstext angeben.
Text-Parameter | Typ | Beschreibung |
---|---|---|
Aktionen | MessageRuleActions | Aktionen, die auf eine Nachricht angewendet werden, wenn die entsprechenden Bedingungen (falls vorhanden) erfüllt sind. Erforderlich. |
Bedingungen | MessageRulePredicates | Bedingungen, die bei Erfüllung die entsprechenden Aktionen für diese Regel auslösen. Optional. |
Anzeigename | Zeichenfolge | Der Anzeigename der Regel. Erforderlich. |
Ausnahmen | MessageRulePredicates | Ausnahmebedingungen für die Regel. Optional. |
IsEnabled | Boolescher Wert | Gibt an, ob die Regel auf Nachrichten angewendet werden kann. Optional. |
Sequence | Int32 | Gibt die Reihenfolge an, in der die Regel zusammen mit anderen Regeln ausgeführt wird. Erforderlich. |
Beispielanfrage
Die folgende Regel leitet eine eingehende Nachricht an Alex Wilbur weiter, wenn der Name des Absenders den Begriff "adele" enthält.
POST https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules
Content-Type: application/json
{
"DisplayName": "From partner",
"Sequence": 2,
"IsEnabled": true,
"Conditions": {
"SenderContains": [
"adele"
]
},
"Actions": {
"ForwardTo": [
{
"EmailAddress": {
"Name": "Alex Wilbur",
"Address": "AlexW@MOD154847.onmicrosoft.com"
}
}
],
"StopProcessingRules": true
}
}
Beispielantwort
Status code: 201 Created
{
"Id":"AQAAAJ5dZqA=",
"DisplayName":"From partner",
"Sequence":2,
"IsEnabled":true,
"HasError":false,
"IsReadOnly":false,
"Conditions":{
"SenderContains":[
"ADELE"
]
},
"Actions":{
"StopProcessingRules":true,
"ForwardTo":[
{
"EmailAddress":{
"Name":"Alex Wilbur",
"Address":"AlexW@MOD154847.onmicrosoft.com"
}
}
]
}
}
Regeln abrufen (Vorschauversion)
Minimal benötigter Bereich
Sie können alle für den Posteingang des Benutzers definierten Regeln abrufen oder nur eine bestimmte Regel durch Angabe ihrer ID abrufen.
Alle Regeln für einen Posteingang abrufen
GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules
Beispielanfrage
GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules
Beispielantwort
Status code: 200 OK
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('inbox')/MessageRules",
"value":[
{
"@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZp8=')",
"Id":"AQAAAJ5dZp8=",
"DisplayName":"Remove spam",
"Sequence":1,
"IsEnabled":true,
"HasError":false,
"IsReadOnly":false,
"Conditions":{
"SubjectContains":[
"enter to win"
]
},
"Actions":{
"Delete":true,
"StopProcessingRules":true
}
},
{
"@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZqA=')",
"Id":"AQAAAJ5dZqA=",
"DisplayName":"From partner",
"Sequence":2,
"IsEnabled":true,
"HasError":false,
"IsReadOnly":false,
"Conditions":{
"SenderContains":[
"ADELE"
]
},
"Actions":{
"StopProcessingRules":true,
"ForwardTo":[
{
"EmailAddress":{
"Name":"Alex Wilbur",
"Address":"AlexW@MOD154847.onmicrosoft.com"
}
}
]
}
}
]
}
Eine bestimmte Regel abrufen
GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL-Parameter | Typ | Beschreibung |
---|---|---|
rule_id | Zeichenfolge | Die ID der abzurufenden Regel. |
Beispielanfrage
GET https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZqA=')
Beispielantwort
Status code: 200 OK
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Me/MailFolders('inbox')/MessageRules/$entity",
"@odata.id":"https://outlook.office.com/api/beta/Users('94447c6e-ea4c-494c-a9ed-d905e366c5cb@007e925e-fb5a-4f60-9cb6-58a21e692480')/MailFolders('inbox')/MessageRules('AQAAAJ5dZqA=')",
"Id":"AQAAAJ5dZqA=",
"DisplayName":"From partner",
"Sequence":2,
"IsEnabled":true,
"HasError":false,
"IsReadOnly":false,
"Conditions":{
"SenderContains":[
"ADELE"
]
},
"Actions":{
"StopProcessingRules":true,
"ForwardTo":[
{
"EmailAddress":{
"Name":"Alex Wilbur",
"Address":"AlexW@MOD154847.onmicrosoft.com"
}
}
]
}
}
Regeln aktualisieren (Vorschauversion)
Minimal benötigter Bereich
Ändern Sie die beschreibbaren Eigenschaften in einer Regel und speichern Sie die Änderungen.
PATCH https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL-Parameter | Typ | Beschreibung |
---|---|---|
rule_id | Zeichenfolge | Die ID der zu aktualisierenden Regel. |
Beispielanfrage
Im folgenden Beispiel werden der Name der Regel sowie die Aktionen, die für die Regel im letzten Beispiel ausgeführt werden sollen, von der Weiterleitung an eine Adresse zur Markierung ihrer Wichtigkeit in „Hoch“ geändert.
PATCH https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZqA=')
Content-Type: application/json
{
"DisplayName": "Important from partner",
"Actions": {
"MarkImportance": "High"
}
}
Beispielantwort
Status code: 200 OK
{
"Id":"AQAAAJ5dZqA=",
"DisplayName":"Important from partner",
"Sequence":2,
"IsEnabled":true,
"HasError":false,
"IsReadOnly":false,
"Conditions":{
"SenderContains":[
"ADELE"
]
},
"Actions":{
"MarkImportance": "High"
}
}
Regeln löschen (Vorschauversion)
Minimal benötigter Bereich
Die angegebene Regel löschen.
DELETE https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('{rule_id}')
URL-Parameter | Typ | Beschreibung |
---|---|---|
rule_id | Zeichenfolge | Die ID der zu löschenden Regel. |
Beispielanfrage
DELETE https://outlook.office.com/api/beta/me/mailfolders/inbox/messagerules('AQAAAJ5dZp8=')
Beispielantwort
Status code: 204 No Content
Abbestellen (Vorschauversion)
Minimal benötigter Bereich
Eine der folgenden Varianten:
Sendet eine E-Mail-Anforderung im Namen des angemeldeten Benutzers, um eine E-Mail-Verteilerliste abzubestellen. Verwendet die Informationen im List-Unsubscribe
Header.
POST https://outlook.office.com/api/beta/me/messages('{message_id}')/unsubscribe
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die ID des zu sendenden Nachrichtenentwurfs. |
Nachrichtenversender können Mailinglisten auf benutzerfreundliche Weise nutzen, indem sie die Möglichkeit haben, dass die Empfänger die Liste abbestellen können. Sie können dies tun, indem sie den List-Unsubscribe
Header in jeder Nachricht nach RFC-2369 angeben.
Hinweis
Insbesondere für die Aktion Abbestellen muss der Absender spezifizierenmailto:
und keine URL-basierte Abmeldeinformationen angeben.
Das Setzen dieses Headers würde auch die Eigenschaft UnsubscribeEnabled der Message-Instanz auf true
setzen und die Eigenschaft UnsubscribeData auf die Headerdaten.
Wenn die Eigenschaft UnsubscribeEnabled einer Nachricht true
ist, können Sie die Aktion Unsubscribe verwenden, um den Benutzer von ähnlichen zukünftigen Nachrichten abzumelden, die vom Absender der Nachricht verwaltet werden.
Eine erfolgreiche Unsubscribe-Aktion verschiebt die Nachricht in den Ordner Gelöschte Elemente. Der aktuelle Ausschluss des Benutzers von zukünftigen Nachrichten aus der Verteilerliste wird vom Absender verwaltet.
Beispielanfrage
POST https://outlook.office.com/api/beta/me/messages('AAMkADA1MTk1ZAAAKXBQCAAA=')/unsubscribe
Beispielantwort
Status code: 202 Accepted
Sprachauswahl abrufen (Vorschauversion)
Minimal benötigter Bereich
Eine der folgenden Varianten:
Abrufen der Liste von Gebietsschemas und Sprachen, die für den Benutzer unterstützt werden, wie auf dem Postfachserver des Benutzers konfiguriert.
Die bevorzugte Sprache des Benutzers wird aus dieser Liste ausgewählt. Sie können die bevorzugte Sprache abrufen, indem Sie die Postfacheinstellungen des Benutzers abrufen.
GET https://outlook.office.com/api/beta/me/SupportedLanguages
Antworttyp
Sammlung von LocaleInfo.
Beispielanfrage
GET https://outlook.office.com/api/beta/me/SupportedLanguages
Beispielantwort
Die folgende Beispielantwort wurde gekürzt, um das JSON-Format der Antwort hervorzuheben.
Status code: 200
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.LocaleInfo)",
"value":[
{
"Locale":"af-ZA",
"DisplayName":"Afrikaans (Suid-Afrika)"
},
{
"Locale":"en-US",
"DisplayName":"English (United States)"
},
{
"Locale":"en-CA",
"DisplayName":"English (Canada)"
}
]
}
Zeitzonenauswahl abrufen (Vorschauversion)
Minimal benötigter Bereich
Eine der folgenden Varianten:
Abrufen der Liste von Zeitzonen, die für den Benutzer unterstützt werden, wie auf dem Postfachserver des Benutzers konfiguriert.
Sie können optional angeben, dass Zeitzonen in der Windows-Zeitzone oder im IANA-Format (Internet Assigned Numbers Authority) (auch als Olson-Zeitzone bezeichnet) zurückgegeben werden. Wenn Sie kein Format angeben, werden die Zeitzonen im Windows Zeitzonenformat dargestellt.
Die bevorzugte Sprache des Benutzers wird aus dieser Liste ausgewählt. Sie können die bevorzugte Zeitzone abrufen, indem Sie die Postfacheinstellungen des Benutzers abrufen.
GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='{timezone_format}')
Optionaler Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
timezone_format | TimeZoneStandard | Ein Zeitzonenformat. Unterstützte Werte sind: Windows und Iana . |
Antworttyp
Sammlung von TimeZoneInformation.
Beispielanfrage
Das folgende Beispiel liefert die Liste der unterstützten Zeitzonen für den angemeldeten Benutzer im Windows-Format.
GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='Windows')
Beispielantwort
Die folgende Beispielantwort wurde gekürzt, um das JSON-Format der Antwort hervorzuheben.
Status code: 200
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.TimeZoneInformation)",
"value":[
{
"Alias":"Dateline Standard Time",
"DisplayName":"(UTC-12:00) International Date Line West"
},
{
"Alias":"Samoa Standard Time",
"DisplayName":"(UTC+13:00) Samoa"
},
{
"Alias":"UTC-11",
"DisplayName":"(UTC-11:00) Coordinated Universal Time-11"
},
{
"Alias":"Aleutian Standard Time",
"DisplayName":"(UTC-10:00) Aleutian Islands"
}
]
}
Beispielanfrage
Das folgende Beispiel liefert die Liste der unterstützten Zeitzonen im IANA-Format.
GET https://outlook.office.com/api/beta/me/SupportedTimeZones(TimeZoneStandard='Iana')
Beispielantwort
Die folgende Beispielantwort wurde gekürzt, um das JSON-Format der Antwort hervorzuheben.
Status code: 200
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.TimeZoneInformation)",
"value":[
{
"Alias":"Etc/GMT+12",
"DisplayName":"Etc/GMT+12"
},
{
"Alias":"US/Samoa",
"DisplayName":"US/Samoa"
},
{
"Alias":"Etc/GMT+11",
"DisplayName":"Etc/GMT+11"
},
{
"Alias":"US/Aleutian",
"DisplayName":"US/Aleutian"
}
]
}
Postfacheinstellungen abrufen
Minimal benötigter Bereich
Die Einstellungen für das primäre Postfach des Benutzers abrufen. Beispiele für Einstellungen sind die bevorzugte Sprache und die Standardzeitzone des Benutzers sowie alle automatischen Antworteinstellungen.
Die bevorzugte Sprache und Zeitzone des Benutzers gehören zu den Optionen, mit denen der Postfach-Server konfiguriert wurde. Sie können die Listen solcher unterstützten Sprachen und unterstützten Zeitzonen für den Benutzer abrufen.
GET https://outlook.office.com/api/beta/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/beta/me/MailboxSettings
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$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
Minimal benötigter Bereich
Rufen Sie sich 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/beta/me/MailboxSettings/AutomaticRepliesSetting
Antworttyp
Beispielanfrage
GET https://outlook.office.com/api/beta/me/MailboxSettings/AutomaticRepliesSetting
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$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
Minimal benötigter 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/beta/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/beta/me/MailboxSettings
Content-Type: application/json
{
"@odata.context": "https://outlook.office.com/api/beta/$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/beta/$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)
Minimal benötigter Bereich
Eine der folgenden Varianten:
Rufen Sie die E-Mail-Info für einen oder mehrere Empfänger als verfügbar für den angemeldeten Benutzer ab. Beachten Sie, dass dies als POST-Operation zur Aktion GetMailTips durchgeführt wird.
POST https://outlook.office.com/api/beta/me/GetMailTips
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
Text-Parameter | ||
EmailAddresses | Sammlung (Zeichenfolge) | Eine Sammlung von SMTP-Adressen von Empfängern, für die Sie E-Mail-Infos erhalten möchten. |
MailTipsOptions | MailTipsType | Die Arten von E-Mail-Infos für die angegebenen Empfänger. |
Antworttyp
Sammlung von E-Mail-Infos.
Beispielanfrage
Das folgende Beispiel liefert E-Mail-Infos für die angegebenen Empfänger, für alle automatischen Antworteinstellungen und den Vollstatus des Postfachs.
POST https://outlook.office.com/api/beta/me/GetMailTips
Content-Type: application/json
{
"EmailAddresses": [
"danas@contoso.onmicrosoft.com",
"fannyd@contoso.onmicrosoft.com"
],
"MailTipsOptions": "AutomaticReplies, MailboxFullStatus"
}
Beispielantwort
Status code: 200 OK
{
"@odata.context":"https://outlook.office.com/api/beta/$metadata#Collection(Microsoft.OutlookServices.MailTips)",
"value":[
{
"EmailAddress":{
"Name":"",
"Address":"danas@contoso.onmicrosoft.com"
},
"AutomaticReplies":{
"Message":"<style type=\"text/css\" style=\"\">\r\n<!--\r\np\r\n\t{margin-top:0;\r\n\tmargin-bottom:0}\r\n-->\r\n</style>\r\n<div dir=\"ltr\">\r\n<div id=\"x_divtagdefaultwrapper\" style=\"font-size:12pt; color:#000000; background-color:#FFFFFF; font-family:Calibri,Arial,Helvetica,sans-serif\">\r\n<p>Hi, I am on vacation right now. I'll get back to you after I return.<br>\r\n</p>\r\n</div>\r\n</div>",
"MessageLanguage":{
"Locale":"en-US",
"DisplayName":"English (United States)"
}
},
"MailboxFull":false
},
{
"EmailAddress":{
"Name":"",
"Address":"fannyd@contoso.onmicrosoft.com"
},
"AutomaticReplies":{
"Message":""
},
"MailboxFull":false
}
]
}
Anhänge abrufen
Sie können eine Anlagensammlung oder einen Anhang abrufen.
Eine Anhangsammlung abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Die Anhänge einer bestimmten Nachricht abrufen.
GET https://outlook.office.com/api/beta/me/messages/{message_id}/attachments
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
URL-Parameter | ||
message_id | Zeichenfolge | Die Nachrichten-ID. |
Hinweis
Standardmäßig enthält jeder Anhang in der Antwort alle ihre Eigenschaften, die diesem Anhangtyp 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, ItemAttachment, oder ReferenceAttachment sein kann.
Beispielanforderungen 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/beta/me/messages/AAMkAGI2THVSAAA=/attachments?$select=Name
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages('AAMkAGI2THVSAAA%3D')/Attachments(Name)",
"value": [
{
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"@odata.id": "https://outlook.office.com/api/beta/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/beta/me/messages('AAMkADFiNTPAAA=')/attachments
Content-Type: application/json
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages('AAMkADFiNTPAAA%3D')/Attachments",
"value": [
{
"@odata.type": "#Microsoft.OutlookServices.ItemAttachment",
"@odata.id": "https://outlook.office.com/api/beta/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",
}
]
}
Einen Anhang abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Rufen Sie eine Anlage von einer bestimmten Nachricht ab.
GET https://outlook.office.com/api/beta/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, Elementanlage oder Verweisanlage.
Beispielanforderung (Dateianlage)
Im folgenden Beispiel wird die Datei an eine bestimmte Nachricht angehängt.
GET https://outlook.office.com/api/beta/me/messages/AAMkAGI2THVSAAA=/attachments/AAMkAGI2j4kShdM=
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Messages('AAMkAGI2THVSAAA%3D')/Attachments/$entity",
"@odata.type": "#Microsoft.OutlookServices.FileAttachment",
"@odata.id": "https://outlook.office.com/api/beta/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/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/attachments/AAMkAGE1Mbs88AADUv0uFAAABEgAQAPSg72tgf7hJp0PICVGCc0g=
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$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/beta/me/messages/AAMkAGE1Mbs88AADUv0uFAAA=/?$expand=attachments
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$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/beta/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",
}
}
Anhänge erstellen
Sie können einen Dateianhang erstellen oder für eine Nachricht eine Elementanlage erstellen.
Eine Dateianlage erstellen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Fügen Sie einer Nachricht einen Dateianhang hinzu.
POST https://outlook.office.com/api/beta/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 des Anhangs. |
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Fügen Sie einen Elementanhang einer Nachricht hinzu.
POST https://outlook.office.com/api/beta/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 des Anhangs. |
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Fügen Sie einer Nachricht einen Referenzanhang hinzu.
POST https://outlook.office.com/api/beta/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/beta/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/beta/$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/beta/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/beta/$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/beta/$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
}
]
}
Anhänge löschen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Löscht die angegebene Anlage einer Nachricht. Die Anlage kann eine Dateianlage, Elementanlage oder Verweisanlage sein.
DELETE https://outlook.office.com/api/beta/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/beta/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Rufen Sie alle E-Mail-Ordner im Postfach des angemeldeten Benutzers (.../me/MailFolders
) oder die Ordner-Sammlung unter dem angegebenen Ordner ab.
GET https://outlook.office.com/api/beta/me/MailFolders
GET https://outlook.office.com/api/beta/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/beta/me/MailFolders
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders",
"value": [
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "deleteditems"
},
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "drafts"
},
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "inbox"
},
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "junkemail"
},
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "outbox"
},
{
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "sentitems"
}
]
}
Antworttyp
Die angeforderte Ordner-Sammlung.
Einen Ordner abrufen
Minimal benötigter Bereich
Eine der folgenden Varianten:
Einen Ordner nach ID abrufen.
Den Ordner des angemeldeten Benutzers abrufen:
GET https://outlook.office.com/api/beta/me/MailFolders/{folder_id}
Einen Postfachordner abrufen, der von einem Benutzer freigegeben wurde:
GET https://outlook.office.com/api/beta/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
Den Posteingang des angemeldeten Benutzers abrufen
GET https://outlook.office.com/api/beta/me/MailFolders/inbox
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": "inbox"
}
Beispielanfrage
Einen von einem anderen Benutzer freigegebenen Ordner abrufen
GET https://outlook.office.com/api/beta/users/8c14ebe1-e4ba-4232cd011db47/mailFolders/AAMkADk0MGFkODE3LWE4MmYtNDRhOS04OGQxLTM
Beispielantwort
HTTP/1.1 200 OK
{
"@odata.context": "https://outlook.office.com/api/beta/$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 |
---|---|
Me/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.
Minimal benötigter Bereich
Eine der folgenden Varianten:
GET https://outlook.office.com/api/beta/me/MailFolders
Erforderliche Parameter | Typ | Beschreibung |
---|---|---|
Headerparameter | ||
Bevorzugt | 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
Minimal benötigter Bereich
Eine der folgenden Varianten:
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/beta/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/beta/me/MailFolders/inbox/childfolders
Content-Type: application/json
{
"DisplayName": "Company"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders('inbox')/ChildFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": ""
}
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Ä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/beta/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/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=
Content-Type: application/json
{
"DisplayName": "Business"
}
Beispielantwort
Status code: 200
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": ""
}
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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Löschen Sie den in folder_id angegebenen Ordner.
DELETE https://outlook.office.com/api/beta/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/BETA/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
Minimal benötigter Bereich
Eine der folgenden Varianten:
Verschieben Sie einen Ordner und seinen Inhalt in einen anderen Ordner mit der Methode Move.
POST https://outlook.office.com/api/beta/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/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=/move
Content-Type: application/json
{
"DestinationId": "AAMkAGE0MyxQ9AAA="
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": ""
}
Antworttyp
Der Ordner, der verschoben wurde.
Einen Ordner kopieren
Minimal benötigter Bereich
Eine der folgenden Varianten:
Kopieren Sie einen Ordner und seinen Inhalt in einen anderen Ordner mit der Methode Copy.
POST https://outlook.office.com/api/beta/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 . |
Beispielanfrage
POST https://outlook.office.com/api/beta/me/MailFolders/AAMkAGE0Mz-l_AAA=/copy
Content-Type: application/json
{
"DestinationId": "inbox"
}
Beispielantwort
Status code: 201
{
"@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/MailFolders/$entity",
"@odata.id": "https://outlook.office.com/api/beta/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,
"WellKnownName": ""
}
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 mit 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