Lark Email icon

Lark Email

Lark Email Management

Overview

This node, named "Lark Email," is designed to manage email-related operations within the Lark platform, specifically focusing on mailing list aliases. The "Create A Mailing List Alias" operation allows users to create an alias for a mailing list (mail group). This can be useful in scenarios where you want to provide alternative or easier-to-remember email addresses that forward to an existing mailing list.

Practical examples include:

  • Creating department-specific aliases (e.g., sales@example.com) that point to a broader mailing list.
  • Setting up temporary aliases for events or projects without changing the main mailing list address.
  • Managing multiple aliases for the same mail group to simplify communication channels.

Properties

Name Meaning
Authentication Method of authentication to use: either "Tenant Token" or "OAuth2".
Mailgroup Id The unique identifier or email address of the mailing list to which the alias will be added.
Email Alias The new email alias to create for the specified mailing list.
Custom Body A JSON object allowing the user to specify a custom request body instead of the standard one.
Use Custom Body Boolean option to toggle whether to send a custom JSON body instead of the default structure.

Output

The node outputs JSON data representing the response from the Lark API after attempting to create the mailing list alias. This typically includes confirmation details about the created alias or error information if the creation failed.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Lark Open API endpoint at https://open.larksuite.com/open-apis.
  • Needs either a Tenant Token or OAuth2 credentials configured in n8n for authentication.
  • The node expects proper permissions to manage mail groups and aliases within the Lark environment.

Troubleshooting

  • Common Issues:

    • Invalid or missing Mailgroup Id or Email Alias values will cause the API call to fail.
    • Authentication errors may occur if the provided token or OAuth2 credentials are expired or lack necessary scopes.
    • Using a malformed custom JSON body can lead to request rejection by the API.
  • Error Messages:

    • Unauthorized / Authentication Failed: Check that the API credentials are valid and have required permissions.
    • Invalid Mailgroup Id: Verify that the mailing list ID or address exists and is correctly entered.
    • Alias Already Exists: The email alias you are trying to create might already be in use; choose a different alias.
    • Malformed Request Body: If using a custom body, ensure it is valid JSON and matches the API's expected schema.

Links and References

Discussion