Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Users → List Users

AI-generated

Summary

List mailbox users for a specified hosting

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key)
  • path_mail_hosting_id (required) — Identifier of the mail hosting
  • path_mailbox_name (required) — Username part of the email address
  • queryParameters — Additional query parameters, e.g., to expand related resources
  • returnFullResponse — If true, returns the full API response; otherwise returns parsed items

Output shape

JSON array of user objects

Each object contains user details; pagination may require additional query parameters; optional returnFullResponse returns the raw response

Examples

Example 1: Retrieve users via OAuth2

authentication: OAuth2, path_mail_hosting_id: 42, path_mailbox_name: "john", queryParameters: {}, returnFullResponse: false

Example 2: Retrieve users via API Key

authentication: API Key, path_mail_hosting_id: 42, path_mailbox_name: "john", queryParameters: {"with": "contacts"}, returnFullResponse: true

Links

Discussion