Lark Email icon

Lark Email

Lark Email Management

Overview

The node manages Lark Email functionalities, specifically here focusing on clearing members from a Public Mailbox. This operation removes all members associated with a specified public mailbox, effectively resetting its membership list.

Common scenarios include:

  • Administrators needing to revoke access for all current members of a public mailbox before adding a new set of members.
  • Automating cleanup tasks where public mailbox memberships must be cleared regularly or triggered by certain events.

Practical example:

  • An IT admin uses this node in an automation workflow to clear all members from a shared support mailbox before onboarding a new team.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Public Mailbox Id Unique identifier or email address of the public mailbox whose members will be cleared.
Use Custom Body Boolean option to specify whether to send a custom JSON body instead of the default request.
Custom Body JSON object representing a custom request body to send if "Use Custom Body" is enabled.

Output

The node outputs JSON data representing the response from the Lark API after attempting to clear the public mailbox members. This typically includes status information indicating success or failure of the operation.

No binary data output is involved.

Dependencies

  • Requires valid authentication credentials via either a Tenant Token or OAuth2 token for Lark Suite API access.
  • The node communicates with the Lark Suite Open API endpoint at https://open.larksuite.com/open-apis.
  • Proper configuration of these credentials within n8n is necessary for successful API calls.

Troubleshooting

  • Authentication errors: Ensure that the provided Tenant Token or OAuth2 credentials are valid and have sufficient permissions to manage public mailboxes.
  • Invalid Public Mailbox Id: Verify that the mailbox ID or address is correct and exists in the Lark environment.
  • API rate limits or network issues: These may cause failures; check connectivity and API usage quotas.
  • Custom Body misuse: If "Use Custom Body" is enabled but the JSON is malformed or missing required fields, the API call may fail. Validate JSON syntax and required parameters.

Links and References

Discussion