Listenordner

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 alle mailboxFolder-Objekte im angegebenen Postfach ab, einschließlich aller Suchordner.

Standardmäßig werden ausgeblendete Ordner nicht zurückgegeben. Um sie einzuschließen, geben Sie includeHiddenFolders=true.

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

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ❌ ❌ ❌

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. 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) MailboxFolder.Read MailboxFolder.ReadWrite
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application MailboxFolder.Read.All MailboxFolder.ReadWrite.All

HTTP-Anforderung

GET /admin/exchange/mailboxes/{mailboxId}/folders

Abfrageparameter

Diese Methode unterstützt den folgenden optionalen Abfrageparameter.

Parameter Typ Beschreibung
includeHiddenFolders Boolean Der Standardwert ist false. Legen Sie fest, dass true sowohl ausgeblendete als auch nicht ausgeblendete Ordner enthalten sind, und verwenden Sie die isHidden-Eigenschaft , um sie zu unterscheiden. Wenn Sie verwenden $select, schließen Sie isHidden ein, um die Eigenschaft zurückzugeben.

Diese Methode unterstützt auch die $selectAbfrageparameter , , , $top, $skip, $orderby$count, und $expand OData-Abfrageparameter, $filterum die Antwort anzupassen. Allgemeine Informationen finden Sie unter OData-Abfrageparameter.

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 200 OK Antwortcode und eine Auflistung von mailboxFolder-Objekten im Antworttext zurück.

Hinweis

Archiv Postfächer mit automatisch erweiterten Ordnern: Wenn sich der Zielordner physisch in einem zusätzlichen (automatisch erweiterten) Archivpostfach befindet, gibt diese API möglicherweise eine Umleitungsantwort zurück, die auf den richtigen Postfachendpunkt verweist. Weitere Informationen finden Sie unter Behandeln von Umleitungen von Archivpostfächern.

Beispiele

Beispiel 1: Listenordner

Im folgenden Beispiel wird gezeigt, wie die mailboxFolder-Sammlung direkt unter dem Stammordner des Postfachs des Benutzers abgerufen wird.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders

Antwort

Das folgende Beispiel zeigt die Antwort.

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#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "EDSVrdi3lRAAACgfQBAAA=",
            "displayName": "Archive",
            "isHidden": false,
            "parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 0,
            "totalItemCount": 2,
            "wellKnownName": "archive",
            "type": "IPF.Note"
        },
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "NJWt2LeVEAAAIBDQAAAA==",
            "displayName": "Project Calendar",
            "isHidden": false,
            "parentFolderId": "NJWt2LeVEAAAIBCAAAAA==",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "childFolderCount": 5,
            "totalItemCount": 6,
            "wellKnownName": null,
            "type": "IPF.Appointment"
        }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?%24skip=10"
}

Beispiel 2: Auflisten von Ordnern mit Abfrageparametern

Im folgenden Beispiel werden die $filterAbfrageparameter , $selectund $top verwendet. Der $filter Parameter verfeinert die Ergebnisse und gibt nur Ordner des TypsIPF.Appointment zurück. Der $select Parameter ist so festgelegt, dass nur die Eigenschaften displayName, parentMailboxUrl, type und wellKnownName zurückgegeben werden $top . Der Parameter legt die Seitengröße des Resultsets so fest, dass die ersten fünf Ordner im Postfach zurückgegeben werden.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?$filter=type eq 'IPF.Appointment'&$select=displayName,parentMailboxUrl,type,wellKnownName&$top=5

Antwort

Das folgende Beispiel zeigt die Antwort.

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

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxFolder",
            "id": "NJWt2LeVEAAAIBDQAAAA==",
            "displayName": "Project Calendar",
            "parentMailboxUrl": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93",
            "type": "IPF.Appointment",
            "wellKnownName": null
        }
    ]
}

Beispiel 3: Ausgeblendete Ordner einbeziehen

Das folgende Beispiel zeigt, wie Sie sowohl ausgeblendete als auch nicht ausgeblendete Ordner einbeziehen und "isHidden" auswählen, um zwischen ihnen zu unterscheiden.

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders?includeHiddenFolders=true&$select=id,displayName,isHidden

Antwort

Im folgenden Beispiel ist die Antwort zur besseren Lesbarkeit gekürzt. Wenn die Antwort @odata.nextLink enthält, verwenden Sie die gesamte URL unverändert, um die nächste Seite abzurufen.

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

{
  "value": [
    {
      "id": "EDSVrdi3lRAAACgfQBAAA=",
      "displayName": "Archive",
      "isHidden": false
    },
    {
      "id": "EDSVrdi3lRAAEED0yUAAA=",
      "displayName": "Application data",
      "isHidden": true
    }
  ]
}