List mail folders
BetaReads data
Lists the folders of a Microsoft 365 mailbox, or those inside one folder.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Microsoft Graph connection the step signs in with. |
| MailboxRequired | The mailbox this node works in — a user's sign-in address, or their object id. Your app needs Mail.ReadBasic.All for it. |
| Inside folder | A folder id, or a well-known name such as inbox. Leave empty for the folders at the top. |
| Include hidden folders | true/false |
| Fields | text |
| Filter | text |
| Folders per call | 1 to 999. |
| Fetch every page | Follows Graph's own next-page link; refuses rather than truncating at Stop after. |
| Stop after | Pages — at most 50. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `microsoft-graph`) |
mailbox | text |
parent | text |
includeHidden | true/false, by default false |
select | text, by default "id,displayName,parentFolderId,childFolderCount,unreadItemCount,totalItemCount" |
filter | text |
top | number, by default 100 |
returnAll | true/false, by default false |
maxPages | number, by default 10 |
cursor | text |
Output
| Field | Type |
|---|---|
folders | array |
countFolders in this answer | number |
hasMoreMore folders are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- count0
- folders[]
- hasMorefalse
- nextCursor""
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"connection": "<connection id>",
"cursor": "",
"filter": "",
"includeHidden": false,
"mailbox": "<mailbox>",
"maxPages": 10,
"parent": "",
"returnAll": false,
"select": "id,displayName,parentFolderId,childFolderCount,unreadItemCount,totalItemCount",
"top": 100
},
"label": "List mail folders",
"type": "graph.listMailFolders",
"version": 1
}