mailboxFolder resource type
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a folder in a user's mailbox, such as inbox, drafts, or other user created folders. Folders can contain various mailbox items like messages, events, contacts, other Outlook items, and child folders.
This resource supports delta query to track incremental additions, deletions, and updates, by providing a delta function. It also supports single-value and multi-value extended properties for storing and accessing custom data that isn't already exposed in the Microsoft Graph API metadata.
Methods
| Method | Return type | Description |
|---|---|---|
| List | mailboxFolder collection | Get all the mailboxFolder objects in the specified mailbox, including any search folders. |
| Create | mailboxFolder | Create a new mailboxFolder or child mailboxFolder in a user's mailbox. |
| Get | mailboxFolder | Read the properties and relationships of a mailboxFolder object. |
| Update | mailboxFolder | Update mailboxFolder properties such as the displayName within a mailbox. |
| Delete | None | Delete a mailboxFolder or a child mailboxFolder within a mailbox. |
| Get delta | mailboxFolder collection | Get a set of mailboxFolder objects that have been added, deleted, or removed from the user's mailbox. |
| List child mailbox folders | mailboxFolder collection | Get the mailboxFolder collection under the specified mailboxFolder in a mailbox. |
| List items in folder | mailboxItem collection | Get the mailboxItem collection within a specified mailboxFolder in a mailbox. |
| Extended properties | ||
| Create single-value property | mailboxFolder | Create one or more single-value extended properties in a new or existing mailbox folder. |
| Get single-value property | mailboxFolder | Get mailbox folders that contain a single-value extended property by using $expand or $filter. |
| Create multi-value property | mailboxFolder | Create one or more multi-value extended properties in a new or existing mailbox folder. |
| Get multi-value property | mailboxFolder | Get a mailbox folder that contains a multi-value extended property by using $expand. |
Properties
| Property | Type | Description |
|---|---|---|
| childFolderCount | Int32 | The number of immediate child folders in the current folder. |
| displayName | String | The display name of the folder. |
| id | String | The unique identifier for the folder. |
| parentFolderId | String | The unique identifier for the parent folder of this folder. |
| parentMailboxUrl | String | The routing link to the actual underlying mailbox where the folder physically resides. The folder can be accessed using GET {parentMailboxUrl}/folders/{id}, which treats the entire URL as an opaque string. This method is especially important when auto-expanding archiving is enabled for a user's in-place archive mailbox. The user's archive content can span across multiple mailboxes in such scenarios. |
| totalItemCount | Int32 | The number of items in the folder. |
| type | String | Describes the folder class type. |
Relationships
| Relationship | Type | Description |
|---|---|---|
| childFolders | mailboxFolder collection | The collection of child folders in this folder. |
| items | mailboxItem collection | The collection of items in this folder. |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty collection | The collection of multi-value extended properties defined for the mailboxFolder. |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | The collection of single-value extended properties defined for the mailboxFolder. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.mailboxFolder",
"displayName": "String",
"childFolderCount": "Int32",
"id": "String (identifier)",
"parentFolderId": "String",
"parentMailboxUrl": "String",
"totalItemCount": "Int32",
"type": "String"
}