Lark Email icon

Lark Email

Lark Email Management

Overview

This node interacts with the Lark Email service to obtain members of a specified mail group in batch. It is useful for scenarios where you need to retrieve all members of a mailing list managed within Lark's email system, such as syncing mailing list members with another system, auditing group membership, or automating communication workflows based on group membership.

For example, an organization might use this node to fetch all members of a project-specific mailing list to send targeted notifications or to update access permissions in other tools based on current group membership.

Properties

Name Meaning
Authentication Method of authenticating API requests. Options: "Tenant Token" or "OAuth2".
Mailgroup Id The unique identifier or email address of the mail group whose members are to be fetched.
Options Additional optional settings:
- Use Custom Body Whether to send a custom request body instead of the default one (boolean).

Output

The node outputs JSON data representing the members of the specified mail group. This typically includes details about each member such as their email address and possibly other metadata related to their membership status. The output structure is designed to be consumed by subsequent nodes for further processing or integration.

If the node supports binary data output (not indicated here), it would represent attachments or files related to the mail group members, but this is not applicable based on the provided code and properties.

Dependencies

  • Requires valid authentication credentials for Lark Email API access, either via a tenant token or OAuth2.
  • Needs network connectivity to https://open.larksuite.com/open-apis.
  • Proper configuration of authentication credentials in n8n is necessary before using this node.

Troubleshooting

  • Authentication errors: Ensure that the selected authentication method is correctly configured with valid tokens or credentials.
  • Invalid Mailgroup Id: Verify that the mail group ID or email address is correct and exists in the Lark Email system.
  • API rate limits or connectivity issues: Check network connection and API usage limits; retry after some time if rate limited.
  • Custom Body option misuse: If "Use Custom Body" is enabled without providing a proper body, the request may fail. Make sure to supply a valid custom body when this option is used.

Links and References

Discussion