Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes > Accesses > Invitations → Send Webmail Access Link By E Mail

AI-generated

Summary

Sends a webmail access invitation link to a specified email address

Inputs

  • authentication — Authentication method (OAuth2 or API Key)
  • path_service_mail (required) — Unique identifier (ID) of the mail hosting to request
  • path_mailbox_name (required) — Username (part before @) of the email address you want to request
  • path_invitation_webmail (required) — Identifier of the invitation
  • body_email (required) — Email address to send the invitation
  • bodyParameters — Additional body fields to customize the email (e.g., language)
  • returnFullResponse — Return the full API response instead of just a success indicator

Output shape

a single object representing the API response (or success indicator)

May include error details on failure; otherwise empty on success

Examples

Example 1: Send a German-language invitation link to john.doe@example.com

authentication=oauth2, path_service_mail=12345, path_mailbox_name=john.doe, path_invitation_webmail=abc123, body_email=john.doe@example.com, bodyParameters={language:de}

Example 2: Send an invitation using API Key to alice@example.com with English language

authentication=apiKey, path_service_mail=98765, path_mailbox_name=alice, path_invitation_webmail=def456, body_email=alice@example.com, bodyParameters={language:en}

Example 3: Trigger the operation and receive full response for debugging

authentication=oauth2, path_service_mail=11223, path_mailbox_name=bob, path_invitation_webmail=ghi789, body_email=bob@example.com, returnFullResponse=true

Links

Discussion