Créer mailSearchFolder
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Créez un objet mailSearchFolder dans la boîte aux lettres de l’utilisateur spécifié.
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
Type d’autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées plus élevées |
---|---|---|
Déléguée (compte professionnel ou scolaire) | Mail.ReadWrite | Non disponible. |
Déléguée (compte Microsoft personnel) | Mail.ReadWrite | Non disponible. |
Application | Mail.ReadWrite | Non disponible. |
Requête HTTP
POST /me/mailFolders/{id}/childFolders
POST /users/{id | userPrincipalName}/mailFolders/{id}/childFolders
Spécifiez le dossier parent dans l’URL de requête en tant qu’ID de dossier ou nom de dossier connu. Pour obtenir la liste des noms de dossier connus pris en charge, consultez l’article Type de ressource mailFolder.
En-têtes de demande
En-tête | Valeur |
---|---|
Autorisation |
Bearer {token} . Obligatoire. |
Content-Type |
application/json . Obligatoire. |
Corps de la demande
Dans le corps de la demande, indiquez un objet JSON avec les paramètres suivants.
Paramètre | Type | Description |
---|---|---|
@odata.type | Chaîne | Type de dossier à créer. Définissez sur « microsoft.graph.mailSearchFolder ». |
displayName | Chaîne | Nom d’affichage du nouveau dossier. |
includeNestedFolders | Valeur booléenne | Indique comment la hiérarchie des dossiers de boîtes aux lettres doit être parcourue dans la recherche.
true signifie qu’une recherche approfondie doit être effectuée pour inclure les dossiers enfants dans la hiérarchie de chaque dossier explicitement spécifié dans sourceFolderIds.
false signifie une recherche superficielle de chacun des dossiers explicitement spécifiés dans sourceFolderIds. |
sourceFolderIds | String collection | Dossiers de boîte aux lettres qui doivent être extraits. |
filterQuery | Chaîne | Requête OData pour filtrer les messages. |
Réponse
Si elle réussit, cette méthode renvoie un 201 Created
code de réponse et un objet mailSearchFolder dans le corps de la réponse.
Exemple
Demande
Voici un exemple de demande : il crée un dossier de recherche de messages qui contiennent la chaîne « hebdomadaire digest » dans l’objet. Le dossier de recherche se trouve sous le même dossier que celui auquel s’applique la requête de filtre spécifiée.
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')"
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
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')"
}
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour