Type de ressource 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 .
Un mailSearchFolder est un dossier virtuel dans la boîte aux lettres de l’utilisateur qui contient tous les éléments d’e-mail correspondant aux critères de recherche spécifiés. mailSearchFolder hérite de mailFolder. Les dossiers de recherche peuvent être créés dans n’importe quel dossier de la boîte aux lettres Exchange Online d’un utilisateur. Toutefois, pour qu’un dossier de recherche apparaisse dans Outlook, Outlook pour le web ou Outlook Live, le dossier doit être créé dans le dossier WellKnownFolderName.SearchFolders .
Cycle de vie des dossiers de recherche
Exchange Online peut supprimer les dossiers de recherche créés par votre application pour l’une des raisons suivantes :
- Les dossiers de recherche expirent après 45 jours sans utilisation.
- Le nombre de dossiers de recherche pouvant être créés par dossier source est limité. En cas de dépassement de cette limite, les dossiers de recherche plus anciens sont supprimés pour faire place à de nouveaux dossiers.
Lorsqu’un dossier de recherche est supprimé, votre application doit créer une ressource de dossier de recherche et l’utiliser.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Créer | mailSearchFolder | Créez un dossier de recherche dans la boîte aux lettres de cet utilisateur. |
| Obtenir | mailSearchFolder | Obtient le dossier de recherche spécifié. |
| Mettre à jour | mailSearchFolder | Mettez à jour le dossier de recherche spécifié. |
| Supprimer | Aucune | Supprimez le dossier de recherche spécifié. |
| Supprimer définitivement | Aucune | Supprimez définitivement un dossier de recherche de courrier et supprimez ses éléments de la boîte aux lettres de l’utilisateur. |
| Répertorier les dossiers enfants | collection mailFolder | Répertoriez tous les dossiers de la boîte aux lettres de cet utilisateur, y compris les dossiers de recherche. |
| Répertorier les messages dans un dossier | collection message | Répertoriez tous les messages dans le dossier de recherche spécifié. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| isSupported | Valeur booléenne | Indique si un dossier de recherche peut être modifié à l’aide d’API REST. |
| 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 | Collection de chaînes | Dossiers de boîte aux lettres qui doivent être extraits. |
| filterQuery | Chaîne | Requête OData pour filtrer les messages. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"isSupported": true,
"includeNestedFolders": true,
"sourceFolderIds": ["string"],
"filterQuery": "string"
}