Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Users → List User Invitations

AI-generated

Summary

List user invitations for a given mailbox and hosting.

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key).
  • path_mail_hosting_id (required) — The ID of the mail hosting to request.
  • path_mailbox_name (required) — The username (part before @) of the email address to request.
  • returnFullResponse — If true, the full response is returned; otherwise only essential data.

Output shape

array of invitation objects

Returns a list of invitation records; no pagination metadata is included.

Examples

Example 1: Fetch invitations for mailbox alice@example.com under hosting ID 123 using OAuth2.

authentication: oauth2, path_mail_hosting_id: 123, path_mailbox_name: alice, returnFullResponse: false

Links

Discussion