type de ressource mailFolder

  • Article

Espace de noms: microsoft.graph

Élément mailFolder dans la boîte aux lettres d’un utilisateur, tel que Boîte de réception et Brouillons. Les dossiers de courrier électronique peuvent contenir des messages, d’autres éléments Outlook et des dossiers de courrier électronique enfants.

Cette ressource prend en charge l’utilisation d’une requête delta pour effectuer un suivi des suppressions, des mises à jour et des ajouts incrémentiels à l’aide d’une fonction delta.

Noms des dossiers connus

Par défaut, Outlook crée certains dossiers pour les utilisateurs. Au lieu d’utiliser la valeur id du dossier correspondant, vous pouvez tout simplement utiliser les noms de dossier connus du tableau ci-dessous quand vous accédez à ces dossiers. Par exemple, vous pouvez obtenir le dossier Brouillons à l’aide de son nom connu avec la requête suivante.

GET /me/mailFolders/drafts

Les noms connus fonctionnent indépendamment des paramètres régionaux de la boîte aux lettres de l’utilisateur. Par conséquent, la requête ci-dessus retourne toujours le dossier Brouillons de l’utilisateur, quelle que soit la façon dont il est nommé.

Noms du dossier connu Description
archive Le dossier d’archive vers lequel les messages sont envoyés lorsque vous utilisez la fonctionnalité d’archivage One_Click dans les clients Outlook qui la prennent en charge. Remarque : ce n’est pas la même chose que la fonctionnalité archiver la boîte aux lettres d’Exchange Online.
pêlemêle Le dossier courrier pêle-mêle vers lequel lees messages à basse priorité sont déplacés lorsque vous utilisez la fonctionnalité Courrier pêle-mêle.
conflits Le dossier qui contient des éléments en conflit dans la boîte aux lettres.
conversationhistory Le dossier où Skype enregistre les conversations par messagerie instantanée (si Skype est configuré pour le faire).
deleteditems Les éléments de dossier sont déplacés vers lorsqu’ils sont supprimés.
brouillons Le dossier qui contient les messages non envoyés.
boîtederéception Le dossier Boîte de réception.
junkemail Le dossier courrier indésirable.
localfailures Dossier qui contient des éléments qui existent sur le client local, mais qui n’ont pas pu être chargés sur le serveur.
msgfolderroot Le dossier « Haut de la banque d’informations ». Ce dossier est le dossier parent pour les dossiers affichés dans les clients de messagerie normal, par exemple, la boîte de réception.
Boîte d’envoi Le dossier Boîte d'envoi.
recoverableitemsdeletions Le dossier qui contient les éléments supprimés de menu : supprimés à partir du dossier éléments supprimés ou en appuyant sur MAJ + SUPPR dans Outlook. Ce dossier n’est visible dans aucun client de messagerie Outlook, mais les utilisateurs finaux peuvent interagir avec lui via la fonctionnalité Récupérer des éléments supprimés du serveur dans Outlook ou Outlook sur le web.
planifié Le dossier qui contient les messages planifiés pour réapparaître dans la boîte de réception à l’aide de la fonctionnalité de planification dans Outlook pour iOS.
searchfolders Dossier parent pour tous les dossiers de recherche définies dans la boîte aux lettres de l’utilisateur.
sentitems Le dossier éléments envoyés.
serverfailures Dossier qui contient des éléments qui existent sur le serveur, mais qui n’ont pas pu être synchronisés avec le client local.
syncissues Le dossier qui contient les journaux de synchronisation créés par Outlook.

Méthodes

Méthode Type renvoyé Description
Répertorier les objets mailFolder collection mailFolder Obtenez tous les dossiers de courrier dans la boîte aux lettres de l’utilisateur spécifié, y compris les dossiers de recherche de courrier.
Obtenir mailFolder mailFolder Lisez les propriétés et les relations de l’élément mailFolder.
Créer un objet mailFolder mailFolder Créez un dossier de courrier dans le dossier racine de la boîte aux lettres de l’utilisateur.
Répertorier childFolders collection MailFolder Obtenez la collection de dossiers sous le dossier spécifié. Vous pouvez utiliser le raccourci .../me/MailFolders pour obtenir la collection de dossiers de niveau supérieur et accéder à un autre dossier.
Créer childFolder mailFolder Créez un élément mailFolder sous l’élément mailFolder actuel en publiant dans la collection childFolders.
Créer un message Message Créez un message dans l’élément mailFolder actif en publiant dans la collection de messages.
Répertorier des messages collection Message Obtenez tous les messages de la boîte aux lettres de l’utilisateur connecté ou ces messages dans un dossier spécifié de la boîte aux lettres.
Mettre à jour mailFolder Mettez à jour l’objet mailFolder spécifié.
Supprimer Aucun Supprimez l’objet mailFolder spécifié.
copier MailFolder Copiez un objet mailFolder et son contenu vers un autre objet mailFolder.
delta collection mailFolder Obtenez un ensemble de dossiers de courriers qui ont été ajoutés ou supprimés de la boîte aux lettres de l’utilisateur.
déplacer MailFolder Déplacez un objet mailFolder et son contenu vers un autre objet mailFolder.
Propriétés étendues
Créer une propriété étendue à valeur unique mailFolder Créez une ou plusieurs propriétés étendues à valeur unique dans un objet mailFolder nouveau ou existant.
Obtenir un objet mailFolder avec une propriété étendue à valeur unique mailFolder Obtenez des objets mailFolder qui contiennent une propriété étendue à valeur unique à l’aide de $expand ou $filter.
Créer une propriété étendue à valeurs multiples mailFolder Créez une ou plusieurs propriétés étendues à valeurs multiples dans un objet mailFolder nouveau ou existant.
Obtenir un objet mailFolder avec propriété étendue à valeurs multiples mailFolder Obtenez un objet mailFolder qui contient une propriété étendue à valeurs multiples à l’aide de $expand.

Propriétés

Propriété Type Description
childFolderCount Int32 Nombre d’objets mailFolder enfants immédiats dans l’objet mailFolder actuel.
displayName Chaîne Nom d’affichage de l’objet mailFolder.
id Chaîne Identificateur unique de l’objet mailFolder.
isHidden Booléen Indique si l’élément mailFolder est masqué. Cette propriété ne peut être définie que lors de la création du dossier. Si vous souhaitez en savoir plus, consultez la section Dossiers de courrier masqués.
parentFolderId Chaîne Identificateur unique de l’objet mailFolder parent de l’objet mailFolder.
totalItemCount Int32 Nombre d’éléments inclus dans l’objet mailFolder.
unreadItemCount Int32 Nombre d’éléments inclus dans l’objet mailFolder marqués comme non lus.

Accéder efficacement aux nombres d’éléments

Les propriétés TotalItemCount et UnreadItemCount d’un dossier vous permettent de calculer le nombre d’éléments lus dans le dossier. Elles vous permettent d’éviter les requêtes qui peuvent entraîner une latence importante, telles que la suivante :

https://graph.microsoft.com/v1.0/me/mailFolders/inbox/messages?$count=true&$filter=isread%20eq%20false

Les dossiers de courrier dans Outlook peuvent contenir plusieurs types d’éléments. Par exemple, la boîte de réception peut contenir des éléments de demande de réunion distincts des éléments de courrier. Les propriétés TotalItemCount et UnreadItemCount incluent des éléments dans un dossier de courrier quels que soient leurs types d'éléments.

Dossiers de courrier masqués

La valeur par défaut de la propriété isHidden est false. Vous ne pouvez définir isHidden qu’une seule fois lors de la création du mailFolder. Vous ne pouvez pas mettre à jour la propriété à l’aide d’une opération PATCH. Pour modifier la propriété isHidden d’un dossier, supprimez le dossier existant et créez-en un nouveau avec la valeur souhaitée.

Les dossiers de courrier masqués prennent en charge toutes les opérations prises en charge par un dossier de courrier normal.

Par défaut, la liste mailFolders renvoie uniquement les dossiers de courrier qui ne sont pas masqués. Pour inclure les dossiers de courrier masqués dans la réponse, utilisez le paramètre de requête includeHiddenFolders=true. Ensuite, utilisez la propriété isHidden pour déterminer si un dossier de messagerie est masqué.

Relations

Relation Type Description
childFolders collection MailFolder Collection de dossiers enfants dans l’objet mailFolder.
messageRules Collection messageRule Ensemble de règles qui s’appliquent au dossier de boîte de réception de l’utilisateur.
messages collection Message Collection de messages dans l’objet mailFolder.
multiValueExtendedProperties collection multiValueLegacyExtendedProperty Collection des propriétés étendues à valeurs multiples définies pour l’objet mailFolder. En lecture seule. Pouvant accepter la valeur Null.
singleValueExtendedProperties collection singleValueLegacyExtendedProperty Collection des propriétés étendues à valeur unique définies pour l’objet mailFolder. En lecture seule. Pouvant accepter la valeur Null.

Représentation JSON

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

{
  "childFolderCount": 1024,
  "displayName": "string",
  "id": "string (identifier)",
  "parentFolderId": "string",
  "totalItemCount": 1024,
  "unreadItemCount": 1024,
  "isHidden": false,
  "childFolders": [ { "@odata.type": "microsoft.graph.mailFolder" } ],
  "messageRules": [ { "@odata.type": "microsoft.graph.messageRule" } ],
  "messages": [ { "@odata.type": "microsoft.graph.message" } ],
  "multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }],
  "singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }]
}

Contenu connexe