ExternalMailboxFolderDto

One folder (Outlook) or label (Gmail) belonging to a mailbox configuration.
Returned by the tenant-scoped folders endpoint so the UI can render a folder/label
tree across every accessible read-enabled configuration.

Properties

Name	Type	Description
uniqueId	string	Folder UniqueId (Guid) — stable identifier suitable for URL routing and filter params.
Folder UniqueId (Guid) — stable identifier suitable for URL routing and filter params.
configCode	string	Configuration UniqueId (Guid) the folder belongs to. Lets the UI group the response per-mailbox or filter to a single mailbox client-side.
Configuration UniqueId (Guid) the folder belongs to. Lets the UI group the response per-mailbox or filter to a single mailbox client-side.
name	string	Display name of the folder/label (e.g. "Inbox", "Clients/Acme").
Display name of the folder/label (e.g. "Inbox", "Clients/Acme").
path	string	Provider-canonical path. For Outlook this is the full folder path (e.g. "Inbox/Sub"); for Gmail this is the label name (e.g. "Clients/Acme") where forward slashes denote hierarchy.
Provider-canonical path. For Outlook this is the full folder path (e.g. "Inbox/Sub"); for Gmail this is the label name (e.g. "Clients/Acme") where forward slashes denote hierarchy.
systemFolderType	enum	Identifies which provider-system folder a row represents. None (0, the default) means the row is a user-created folder or a Gmail user label. None Inbox Sent Drafts Junk Trash Archive Outbox GmailCategory GmailPromotionalCategory
Identifies which provider-system folder a row represents. None (0, the default) means the row is a user-created folder or a Gmail user label. None Inbox Sent Drafts Junk Trash Archive Outbox GmailCategory GmailPromotionalCategory
parentFolderUniqueId	string	UniqueId of the parent folder, or null for top-level folders. Used to render Outlook folder hierarchies. Gmail labels do not use this — hierarchy is encoded in Path.
UniqueId of the parent folder, or null for top-level folders. Used to render Outlook folder hierarchies. Gmail labels do not use this — hierarchy is encoded in Path.
isSystem	boolean	True if the folder is provider-system (Inbox, Sent, etc.) rather than user-created.
True if the folder is provider-system (Inbox, Sent, etc.) rather than user-created.
totalCount	integer	Total number of emails currently mapped to this folder (junction row count).
Total number of emails currently mapped to this folder (junction row count).
unreadCount	integer	Number of unread emails currently mapped to this folder.
Number of unread emails currently mapped to this folder.

JSON Example

{
  "uniqueId": "00000000-0000-0000-0000-000000000000",
  "configCode": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "path": "string",
  "systemFolderType": "None"
}