Freigeben über


mailFolders auflisten

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Ruft die E-Mail-Ordner-Sammlung direkt unter dem Stammordner des angemeldeten Benutzers ab. Die zurückgegebene Sammlung enthält alle E-Mail-Suchordner direkt unter dem Stammordner.

Standardmäßig gibt dieser Vorgang keine ausgeblendeten Ordner zurück. Verwenden Sie einen Abfrageparameter includeHiddenFolders , um sie in die Antwort einzuschließen. Dieser Vorgang gibt nicht alle E-Mail-Ordner in einem Postfach zurück, nur die untergeordneten Ordner des Stammordners. Um alle E-Mail-Ordner in einem Postfach zurückzugeben, muss jeder untergeordnete Ordner separat durchlaufen werden.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Mail.ReadBasic Mail.ReadWrite, Mail.Read
Delegiert (persönliches Microsoft-Konto) Mail.ReadBasic Mail.ReadWrite, Mail.Read
App Mail.ReadBasic.All Mail.ReadWrite, Mail.Read

HTTP-Anforderung

So rufen Sie alle E-Mail-Ordner im Stammordner im Postfach des angegebenen Benutzers ab, mit Ausnahme der ausgeblendeten Ordner:

GET /me/mailFolders
GET /users/{id | userPrincipalName}/mailFolders

So fügen Sie ausgeblendete E-Mail-Ordner zur Antwort hinzu

GET /me/mailFolders/?includeHiddenFolders=true
GET /users/{id | userPrincipalName}/mailFolders/?includeHiddenFolders=true

Optionale Abfrageparameter

Um eine Liste aller mailFolders zurückzugeben, einschließlich der ausgeblendeten E-Mail-Ordner (deren isHidden-Eigenschaft „true“ lautet), geben Sie in der Anforderungs-URL den Abfrageparameter includeHiddenFolders als true an, wie im Abschnitt HTTP-Anforderung gezeigt.

Diese Methode unterstützt OData-Abfrageparameter , um die Antwort anzupassen.

Anforderungsheader

Kopfzeile Wert
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von mailFolder-Objekten im Antworttext zurückgegeben.

Beispiele

Beispiel 1: Auflisten von E-Mail-Ordnern im Postfach des angemeldeten Benutzers

Dieses Beispiel enthält ein mailSearchFolder-Objekt in der Antwort. Der E-Mail-Suchordner ist ein untergeordneter Ordner unter dem Posteingang mit dem Anzeigenamen „Wöchentliche Übersicht“.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/me/mailFolders

Antwort

Im Folgenden finden Sie ein Beispiel für die Antwort, die einen mailSearchFolder enthält, der ein untergeordneter Ordner unter dem Posteingang ist.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AQMkADYAAAIBXQAAAA==",
            "displayName": "Archive",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "archive",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBFQAAAA==",
            "displayName": "Conversation History",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCgAAAA==",
            "displayName": "Deleted Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "deleteditems",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDwAAAA==",
            "displayName": "Drafts",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "drafts",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBDAAAAA==",
            "displayName": "Inbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 1,
            "unreadItemCount": 70,
            "totalItemCount": 71,
            "wellKnownName": "inbox",
            "isHidden": false
        },
        {
            "@odata.type": "#microsoft.graph.mailSearchFolder",
            "id": "AAMkADYRAAAZg1yTAAA=",
            "displayName": "Weekly digests",
            "parentFolderId": "AQMkADYAAAIBDAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 4,
            "totalItemCount": 5,
            "wellKnownName": null,
            "isHidden": false,
            "isSupported": true,
            "filterQuery": "contains(subject, 'weekly digest')"
        },
        {
            "id": "AQMkADYAAAIBGQAAAA==",
            "displayName": "Junk Email",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "junkemail",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCwAAAA==",
            "displayName": "Outbox",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "outbox",
            "isHidden": false
        },
        {
            "id": "AQMkADYAAAIBCQAAAA==",
            "displayName": "Sent Items",
            "parentFolderId": "AQMkADYAAAIBCAAAAA==",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "sentitems",
            "isHidden": false
        }
    ]
}

Tipp

Wenn eine Sammlung die Standardseitengröße (10 Elemente) überschreitet, wird die @odata.nextLink-Eigenschaft in der Antwort zurückgegeben, um anzugeben, dass mehr Elemente verfügbar sind und die Anforderungs-URL für die nächste Elementseite angegeben wird.

Sie können die Seitengröße über Optionale Abfragezeichenfolge-Parameter steuern.

Beispiel 2: Hinzufügen ausgeblendeter E-Mail-Ordnern zum Postfach des angemeldeten Benutzers

In diesem Beispiel wird der includeHiddenFolders Abfrageparameter verwendet, um eine Liste von E-Mail-Ordnern einschließlich ausgeblendeter E-Mail-Ordner abzurufen. Die Antwort enthält den Ordner "Clutter", in dem isHidden auf truefestgelegt ist.

Anforderung

GET https://graph.microsoft.com/beta/me/mailFolders/?includeHiddenFolders=true

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt wurde zur besseren Lesbarkeit gekürzt und enthält nicht alle Standardordner in einem Benutzerpostfach.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders",
    "value": [
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Clutter",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 0,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": null,
            "isHidden": true
        },
        {
            "id": "AAMkADg3NTY5MDg4LWMzYmQtNDQzNi05OTgwLWAAA=",
            "displayName": "Conversation History",
            "parentFolderId": "AAMkADg3NTY5MDg4LWMzYmQtEIAAA=",
            "childFolderCount": 1,
            "unreadItemCount": 0,
            "totalItemCount": 0,
            "wellKnownName": "conversationhistory",
            "isHidden": false
        }
    ]
}