Fastmail icon

Fastmail

Actions for Fastmail messages, labels, drafts and threads

Label → Get Many Labels

AI-generated

Summary

Retrieves a list of all configured mailboxes (labels) in the user's Fastmail account.

Inputs

  • fetchOptions (required) — A collection of optional filtering and debugging settings. Includes 'Read Status' (Any, Read, Unread), 'Search' (full-text filter), 'Include Body Values' (boolean), 'Download Attachments' (boolean), 'Attachment Binary Property Prefix' (string), 'Include Message IDs' (boolean), and 'Debug' (boolean). Note that for the Label resource, most 'fetchOptions' are ignored; only 'Debug' is relevant.

Output shape

a list of items, each containing a single mailbox object with id, name, path, parentId, role, and isSubscribed properties.

The 'path' property constructs a hierarchical path (e.g., 'Inbox / Work'). The 'role' indicates standard system folders like 'inbox', 'trash', etc. If 'Debug' is enabled, a 'note' field indicates that raw JMAP responses are not attached.

Examples

Example 1: List all mailboxes to populate a dropdown menu with label names.

Resource set to 'Label', Operation set to 'Get Many Labels', 'Debug' unchecked.

Links

Discussion