> ## Documentation Index
> Fetch the complete documentation index at: https://docs.r28.ai/charter/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Charter works for any HTTP API, including the user's own. The packs are examples of the result, not the limit: an API with no pack is declared the same way, following https://raw.githubusercontent.com/r28ai/charter/main/docs/.mintlify/skills/declaring-charter-tools/SKILL.md.
> Charter is for agents that act in customers' accounts: every call is checked field by field before it's sent, the app says whose account each call is for, and the same declarations list what each tool can reach. https://docs.r28.ai/charter/llms.txt says what it is and lists every page.

# Objects

> Every object and enum the Folders tools accept.

## Model tree

[MailFolderCreate](#mailfoldercreate)[MailSearchFolder](#mailsearchfolder)[MailFolderUpdate](#mailfolderupdate)[MailSearchFolderUpdate](#mailsearchfolderupdate)

## MailFolderCreate

`displayName` and `isHidden` are the only writable properties for a mailFolder object.

| Field | Type | Description |
| - | - | - |
| `displayName` \* | `string` | The display name of the new folder. |
| `isHidden` | `boolean` | Indicates whether the new folder is hidden. The default value is `false`. Setting the property is optional. Once set, you cannot update this property. |

## MailSearchFolder

A virtual folder in the user's mailbox that contains all the email items matching specified search criteria.

| Field | Type | Description |
| - | - | - |
| `@odata.type` | `string` | The type of folder to be created. defaults to `"microsoft.graph.mailSearchFolder"` |
| `displayName` \* | `string` | The display name of the new folder. |
| `includeNestedFolders` | `boolean` | Indicates how the mailbox folder hierarchy should be traversed in the search. `true` means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. `false` means a shallow search of only each of the folders explicitly specified in sourceFolderIds. |
| `sourceFolderIds` \* | `string`\[] | The mailbox folders that should be mined. |
| `filterQuery` \* | `string` | The OData query to filter the messages. |

## MailFolderUpdate

The properties of a mailFolder an update can change.

| Field | Type | Description |
| - | - | - |
| `displayName` | `string` | The mailFolder's display name. |
| `singleValueExtendedProperties` | [SingleValueLegacyExtendedProperty](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#singlevaluelegacyextendedproperty)\[] | An array of one or more single-valued extended properties. |
| `multiValueExtendedProperties` | [MultiValueLegacyExtendedProperty](https://docs.r28.ai/charter/charter/packs/outlook/messages/objects.md#multivaluelegacyextendedproperty)\[] | An array of one or more multi-valued extended properties. |

## MailSearchFolderUpdate

The writable properties of a mailSearchFolder, all optional.

| Field | Type | Description |
| - | - | - |
| `@odata.type` | `string` | The type of folder being updated. defaults to `"microsoft.graph.mailSearchFolder"` |
| `displayName` | `string` | The display name of the mailFolder. |
| `includeNestedFolders` | `boolean` | Indicates how the mailbox folder hierarchy should be traversed in the search. `true` means that a deep search should be done to include child folders in the hierarchy of each folder explicitly specified in sourceFolderIds. `false` means a shallow search of only each of the folders explicitly specified in sourceFolderIds. |
| `sourceFolderIds` | `string`\[] | The mailbox folders that should be mined. |
| `filterQuery` | `string` | The OData query to filter the messages. |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.