Microsoft Exchange · Schema

Microsoft Exchange Mail Folder

Represents a mail folder in a user's mailbox as exposed through the Microsoft Graph Mail API. Mail folders such as Inbox, Drafts, and Sent Items can contain messages, other Outlook items, and child mail folders. Well-known folder names like inbox, drafts, sentitems, and deleteditems can be used in place of folder IDs.

CalendarCollaborationContactsEmailEnterprise

Properties

Name Type Description
id string The mail folder's unique identifier
displayName string The mail folder's display name
parentFolderId string The unique identifier for the parent mail folder
childFolderCount integer The number of immediate child mail folders
totalItemCount integer The number of items in the mail folder (includes all item types)
unreadItemCount integer The number of items in the mail folder marked as unread
isHidden boolean Indicates whether the mail folder is hidden. Can only be set when creating the folder.
View JSON Schema on GitHub

JSON Schema

microsoft-exchange-mail-folder-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/microsoft-exchange/json-schema/microsoft-exchange-mail-folder-schema.json",
  "title": "Microsoft Exchange Mail Folder",
  "description": "Represents a mail folder in a user's mailbox as exposed through the Microsoft Graph Mail API. Mail folders such as Inbox, Drafts, and Sent Items can contain messages, other Outlook items, and child mail folders. Well-known folder names like inbox, drafts, sentitems, and deleteditems can be used in place of folder IDs.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The mail folder's unique identifier",
      "readOnly": true
    },
    "displayName": {
      "type": "string",
      "description": "The mail folder's display name"
    },
    "parentFolderId": {
      "type": "string",
      "description": "The unique identifier for the parent mail folder",
      "readOnly": true
    },
    "childFolderCount": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of immediate child mail folders",
      "readOnly": true
    },
    "totalItemCount": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of items in the mail folder (includes all item types)",
      "readOnly": true
    },
    "unreadItemCount": {
      "type": "integer",
      "minimum": 0,
      "description": "The number of items in the mail folder marked as unread",
      "readOnly": true
    },
    "isHidden": {
      "type": "boolean",
      "description": "Indicates whether the mail folder is hidden. Can only be set when creating the folder.",
      "default": false
    }
  },
  "required": ["displayName"]
}