Help Centre › Building Processes
This article describes the RPA Outlook functionality to list folders.
For a full list of available functions, please read OUTLOOK functions.
Description
The OUTLOOK List folders function allows you to list all folders with metadata (name, total item count, unread count). Optionally lists subfolders recursively.
Setting it up
To use the OUTLOOK List folders function, follow these instructions:
{{popups:rpas/add:action=outlook-get-folders}}
Once on a process map:
- Navigate to the process where you would like to add the OUTLOOK List folders function
- Click on the green button's drop-down (right side of the green button labelled "Process")
- On the menu that appears, click on the "+ Activity" item
- From here you can select the OUTLOOK List folders option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Account | Yes | Text | - | The Outlook e-mail account |
| Parent folder | No | Text | - | Parent folder path to list from. Lists top-level folders if omitted. |
| Recursive | No | Switch | Off | Whether to list subfolders recursively |
| Variable | Yes | Text | - | Variable to store the folder list |
Output variables
| Variable | Type | Description |
|---|---|---|
| Variable | List | List of folder objects with name, total count, and unread count |
Errors
| Error | Description |
|---|---|
| Outlook not open | Outlook is not running |
| Folder not found | The specified parent folder does not exist |
Tips
- Enable Recursive to get a complete folder tree
- Use this to discover folder names before selecting or moving e-mails