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 de messagerie répondant à des critères de recherche spécifiés. mailSearchFolder hérite de mailFolder. Vous pouvez créer des dossiers de recherche 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, il doit être créé dans le dossier WellKnownFolderName.SearchFolders.

Cycle de vie du dossier de recherche

Exchange Online peut supprimer des dossiers de recherche créés par votre application pour l’une des raisons suivantes :

  1. Les dossiers de recherche expirent après 45 jours d’inutilisation.
  2. Le nombre de dossiers de recherche pouvant être créés par dossier source est limité. Lorsque cette limite est dépassée, les anciens dossiers de recherche sont supprimés pour faire place à de nouveaux.

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 Obtenir le dossier de recherche spécifié.
Mettre à jour mailSearchFolder Mettez à jour le dossier de recherche spécifié.
Supprimer Aucun Supprimez le dossier de recherche spécifié.
Supprimer définitivement Aucun Supprimer définitivement un dossier de recherche de courrier et supprimer ses éléments de la boîte aux lettres de l’utilisateur.
Répertorier les dossiers enfants collection mailFolder Répertorier tous les dossiers dans la boîte aux lettres de cet utilisateur, y compris les dossiers de recherche.
Répertorier les messages dans un dossier collection message Répertorier tous les messages dans le dossier de recherche spécifié.

Propriétés

Propriété Type Description
isSupported Booléen Indique si un dossier de recherche est modifiable à l’aide des API REST.
includeNestedFolders Booléen Indique comment la hiérarchie du dossier de boîte 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 spécifié explicitement dans sourceFolderIds. false désigne une recherche superficielle de chacun des dossiers spécifiés explicitement dans sourceFolderIds.
sourceFolderIds String collection Dossiers de boîte aux lettres qui doivent être minés.
filterQuery String Requête OData pour filtrer les messages.

Relations

Aucun.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "isSupported": true,
  "includeNestedFolders": true,
  "sourceFolderIds": ["string"],
  "filterQuery": "string"
}