List mail folders - Automate.ax

listMailFolders lists either the mailbox’s top-level folders or the direct children of a selected folder.

Example

automations/list-outlook-folders.automation.ts

import { automation } from "automate.ax"
import { listMailFolders } from "automate.ax/outlook"

export default automation("List Outlook folders", () => {
  listMailFolders({ parentFolder: "Archive", includeHidden: false, limit: 100 })
})

Inputs

Input	Type	Required	Default	Description
`parentFolder`	`string`	No	Mailbox root	Display path, ID, or well-known name whose direct children are returned.
`includeHidden`	`boolean`	No	`false`	Includes hidden folders.
`limit`	`number`	No	`100`	Maximum across Graph pages, 1–10,000.
`account`	`string \| IntegrationAccountReference<"microsoft">`	No	Project default	Microsoft binding.

Output

Returns folders with folderId, displayName, childFolderCount, totalItemCount, unreadItemCount, and isHidden. Numeric counts default to zero and isHidden to false if Graph omits them. Folder names match case-insensitively across the full hierarchy. Use a path such as Projects/Launch or an ID when duplicate names would be ambiguous.

⌘I