Freigeben über


Erstellen von mailSearchFolder

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.

Erstellen Sie einen neuen mailSearchFolder im Postfach des angegebenen Benutzers.

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.ReadWrite Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Mail.ReadWrite Nicht verfügbar.
Anwendung Mail.ReadWrite Nicht verfügbar.

HTTP-Anforderung

POST /me/mailFolders/{id}/childFolders
POST /users/{id | userPrincipalName}/mailFolders/{id}/childFolders

Geben Sie den übergeordneten Ordner in der Abfrage-URL als Ordner-ID oder als bekannten Ordnernamen an. Eine Liste der unterstützten bekannten Ordnernamen finden Sie unter mailFolder-Ressourcentyp.

Anforderungsheader

Kopfzeile Wert
Authorization Bearer {token}. Erforderlich.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

Parameter Typ Beschreibung
@odata.type String Der Typ des zu erstellenden Ordners. Legen Sie auf "microsoft.graph.mailSearchFolder" fest.
displayName String Der Anzeigename für den neuen Ordner.
includeNestedFolders Boolesch Gibt an, wie die Postfachordnerhierarchie bei der Suche durchlaufen werden soll. true bedeutet, dass eine umfassende Suche durchgeführt werden sollte, um untergeordnete Ordner in die Hierarchie jedes Ordners einzuschließen, die explizit in sourceFolderIds angegeben sind. false bezeichnet eine flache Suche nur der einzelnen Ordner, die explizit in sourceFolderIds angegeben sind.
sourceFolderIds String collection Die Postfachordner, die mined werden sollen.
filterQuery String Die OData-Abfrage zum Filtern der Nachrichten.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 201 Created Antwortcode und ein mailSearchFolder-Objekt im Antworttext zurückgegeben.

Beispiel

Anforderung

Im Folgenden finden Sie ein Beispiel für die Anforderung: Sie erstellt einen Suchordner mit Nachrichten, die die Zeichenfolge "Weekly Digest" im Betreff enthalten. Der Suchordner befindet sich unter demselben Ordner, für den die angegebene Filterabfrage gilt.

POST https://graph.microsoft.com/beta/me/mailFolders/AQMkADYAAAIBDAAAAA==/childFolders
Content-type: application/json

{
  "@odata.type": "microsoft.graph.mailSearchFolder",
  "displayName": "Weekly digests",
  "includeNestedFolders": true,
  "sourceFolderIds": ["AQMkADYAAAIBDAAAAA=="],
  "filterQuery": "contains(subject, 'weekly digest')"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('68ca8ec0-11f8-456b-a785-70d9936650d5')/mailFolders('AQMkADYAAAIBDAAAAA%3D%3D')/childFolders/$entity",
    "@odata.type": "#microsoft.graph.mailSearchFolder",
    "id": "AAMkADYfRAAAZg1yTAAA=",
    "displayName": "Weekly digests",
    "parentFolderId": "AQMkADYAAAIBDAAAAA==",
    "childFolderCount": 0,
    "unreadItemCount": 0,
    "totalItemCount": 0,
    "wellKnownName": null,
    "isSupported": true,
    "includeNestedFolders": true,
    "sourceFolderIds": [
        "AQMkADYAAAIBDAAAAA=="
    ],
    "filterQuery": "contains(subject, 'weekly digest')"
}