Infomaniak CoreResources icon

Infomaniak CoreResources

Interact with Infomaniak API

Overview

The "Set Primary Mailbox" operation within the kSuite resource of this node allows users to designate a specific mailbox as the primary one for their kSuite workspace. This is useful in scenarios where multiple mailboxes are attached to a user or workspace, and one needs to be marked as the main or default mailbox for sending or receiving emails.

Practical examples include:

  • Setting a newly added mailbox as the primary mailbox after attaching it.
  • Changing the primary mailbox when the user wants to switch their main email address.
  • Managing mailbox priorities programmatically in automated workflows.

This operation interacts with the Infomaniak API to update the mailbox status accordingly.

Properties

Name Meaning
Sub Resource The sub-section of kSuite to operate on. Options: Workspace, My kSuite, Product Management
Mailbox ID The unique identifier of the mailbox to set as primary

Output

The output JSON contains a success confirmation message indicating that the specified mailbox has been set as the primary mailbox successfully. It follows this structure:

{
  "success": true,
  "message": "Mailbox <mailboxId> set as primary successfully"
}

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Infomaniak API.
  • The node makes HTTP PUT requests to the Infomaniak API endpoint for setting the primary mailbox.
  • Proper permissions on the Infomaniak account to modify mailbox settings are necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing mailbox ID will cause the operation to fail.
    • Insufficient permissions or invalid API credentials can result in authorization errors.
    • Network issues or API downtime may cause request failures.
  • Error Messages:

    • "Failed to set primary mailbox": Indicates the API call did not succeed. Verify mailbox ID correctness and API credentials.
    • If the node throws an error related to authentication, ensure the API key credential is valid and has required scopes.
    • If the mailbox ID does not exist or is not linked to the user/workspace, the API will reject the request.

Links and References


This summary focuses exclusively on the "Set Primary Mailbox" operation under the kSuite resource as requested.

Discussion