Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Accesses > Webmail → List Users Having Access

AI-generated

Summary

List users who have access to a specified mailbox via Infomaniak's webmail API.

Inputs

  • authentication — Authentication method: OAuth2 or API Key.
  • path_service_mail (required) — ID of the mail hosting (service mail) to query.
  • path_mailbox_name (required) — Mailbox username (part before @) whose accesses to list.
  • queryParameters — Additional query parameters for pagination or filtering.
  • query_search — Search term applied to results.
  • query_return — If set to "total", returns only the count of items.
  • query_page — Page number for pagination.
  • query_per_page — Number of items per page.
  • returnAll — If true, returns all items without pagination limits.
  • limit — Maximum number of items to return (1‑500).
  • returnFullResponse — If true, returns the full response object instead of just items.

Output shape

a list of user access objects (may be paginated)

Pagination controlled by query_page, query_per_page, limit; query_return can restrict to total count; returnAll overrides pagination; returnFullResponse provides the complete API response.

Examples

Example 1: List all users with access to mailbox example@domain.com using OAuth2

authentication=oauth2, path_service_mail=1, path_mailbox_name=example, returnAll=true

Example 2: Get the total number of accesses for a mailbox

authentication=apiKey, path_service_mail=2, path_mailbox_name=test, query_return=total

Example 3: Paginate results, 10 items per page, page 2

authentication=oauth2, path_service_mail=3, path_mailbox_name=user, query_page=2, query_per_page=10, limit=10

Links

Discussion