Atriomail icon

Atriomail

Manage email domains, mailboxes, forwarders, and catch-all configurations with Atriomail

Mailbox → Get Many

AI-generated

Summary

Retrieve a list of mailboxes configured in Atriomail with optional pagination control.

Inputs

  • Return All — Set to true to fetch all mailboxes without limit.
  • Limit — Specify the maximum number of mailboxes to return when 'Return All' is false. Minimum value is 1, default is 50.

Output shape

a list of mailbox records, each representing a mailbox returned from the Atriomail API

If 'Return All' is set to false, results are capped at the 'Limit' number. If true, all mailboxes are returned across multiple API requests if necessary. Errors are included per item if 'Continue On Fail' is enabled.

Examples

Example 1: Get up to 50 mailboxes

Set 'Return All' to false and 'Limit' to 50 (default).

Example 2: Get all mailboxes available

Set 'Return All' to true to retrieve all mailboxes regardless of count.

Discussion