Folders
Manages user-defined and system folders such as Inbox, Sent Items, and custom folders. It supports folder hierarchy operations like creation, deletion, and renaming.
Table Specific Information
Update and Delete
The add-in will need the FolderChangeKey to update or delete an item. However, if you are unsure of the FolderChangeKey, the add-in is able to retrieve it from the Exchange server automatically. Note that this may increase the time it take to perform a query.
Columns
| Name | Type | ReadOnly | Description |
| FolderId [KEY] | String | True |
Uniquely identifies a specific folder within the Exchange store. This identifier is used to track and reference the folder across Exchange services and client applications. |
| FolderChangeKey | String | True |
Provides a version-specific identifier for the folder, enabling synchronization systems to detect changes made to the folder's properties or contents since the last retrieval. |
| ParentFolderId | String | False |
Contains the unique identifier of the folder that is the immediate parent of the current folder. This establishes the folder's position within the overall folder hierarchy. |
| ParentFolderChangeKey | String | True |
Stores the change key of the parent folder, allowing synchronization and version tracking of changes made to the parent folder. |
| FolderClass | String | False |
Specifies the type or classification of the folder, such as IPF.Note for mail folders, IPF.Appointment for calendar folders, or custom values for user-defined folder types. |
| DisplayName | String | False |
Holds the user-facing name of the folder, which is typically shown in email clients such as Outlook or Exchange Web Services. |
| TotalCount | Integer | True |
Indicates the total number of items—such as emails, calendar entries, or tasks—currently stored in the folder, regardless of their read or unread state. |
| ChildFolderCount | Integer | True |
Represents the number of subfolders directly nested within this folder. This helps identify folder hierarchy depth and structure. |
| CanDelete | Boolean | True |
Specifies whether the folder, particularly if it is a managed folder created by policy, can be deleted by the end user. |
| CanRenameOrMove | Boolean | True |
Indicates whether the folder can be renamed or relocated by the user. This is often restricted for system or managed folders enforced by retention policies. |
| MustDisplayComment | Boolean | True |
Specifies whether a user-facing comment associated with a managed folder must be displayed in the mail client to comply with retention or usage policies. |
| HasQuota | Boolean | True |
Indicates whether a storage quota has been applied to the folder, typically in managed folder scenarios for mailbox size control. |
| IsManagedFoldersRoot | Boolean | True |
True if the folder is designated as the root container for all managed folders within the mailbox, serving as a parent structure for policy-based folders. |
| ManagedFolderId | String | True |
Stores the identifier of the managed folder, which is used for policy enforcement, retention tracking, and folder provisioning by administrators. |
| Comment | String | True |
Contains a textual note or policy comment associated with the folder, often displayed to users to describe folder purpose or retention guidelines. |
| StorageQuota | Integer | True |
Defines the maximum allowed storage size for the folder, in kilobytes or megabytes, depending on server configuration. This helps enforce compliance with mailbox management policies. |
| FolderSize | Integer | True |
Represents the total size, in bytes, of all contents within the folder, including messages, calendar items, and attachments. Useful for storage management and quota evaluation. |
| HomePage | String | True |
Specifies the URL that is set as the folder's default home page. Typically used to display custom content or information when accessing the folder through a client interface. |
| UnreadCount | Integer | True |
Displays the total number of unread messages or items currently stored in the folder. Helps users and administrators track pending or new content. |
| EffectiveRights_CreateAssociated | Boolean | True |
Indicates whether the authenticated client has the right to create associated items, which are hidden messages used for storing metadata or settings within the folder. |
| EffectiveRights_CreateContents | Boolean | True |
Indicates whether the authenticated client is permitted to create new messages, events, or other primary content types in the folder. |
| EffectiveRights_CreateHierarchy | Boolean | True |
Indicates whether the authenticated client can create child folders under the current folder, supporting custom folder structures. |
| EffectiveRights_Delete | Boolean | True |
Indicates whether the authenticated user or application has permission to delete the folder or its contents. Used for enforcing retention policies and user access controls. |
| EffectiveRights_Modify | Boolean | True |
Indicates whether the contents or properties of the folder or its items can be updated by the user. Reflects the user's write or edit permissions. |
| EffectiveRights_Read | Boolean | True |
Indicates whether the user has read access to the folder and its items. Determines whether items are visible in client applications. |
| EffectiveRights_ViewPrivateItems | Boolean | True |
Indicates whether the user has permission to view items marked as private within the folder. Typically used in calendar or mailbox sharing scenarios. |
| SharingEffectiveRights | String | False |
Specifies the level of access granted to a user through folder sharing. Values include permissions like Read, Write, Delete, and Owner, which define how shared data can be used. |
| ParentFolderName | String | False |
Contains the display name or identifier of the parent folder that contains the current folder. Helps maintain folder hierarchy relationships. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ImpersonationUser | String |
Specifies the user account to impersonate when performing operations. Used in scenarios where an application needs to act on behalf of another user. |
| ImpersonationType | String |
Indicates the type of user identifier used for impersonation. Acceptable values include PrincipalName, SID, PrimarySmtpAddress, and SmtpAddress. |
| Traversal | String |
Defines the scope of folder traversal during search operations. Valid options are Shallow (top-level only), Deep (including all subfolders), and SoftDeleted (recoverable items). Default is Shallow. |
| SharedMailboxEmail | String |
Provides the SMTP email address of a shared mailbox whose folders are being accessed. Required when retrieving folders from shared mailboxes. |
| Rows@Next | String |
Token used for pagination in result sets. It identifies the position of the next page of data. Do not set manually; it is system-generated for cursor-based navigation. |