Actions15
Overview
This node, named "Mailgroup," is designed to interact with a mailgroup instance via its API. Specifically, the "Update Settings" operation under the "Setting" resource allows users to update various configuration settings of the mailgroup system. This can include site information, email sending parameters, privacy options, upload configurations, SMTP server details, bounce handling, appearance customizations, and more.
Common scenarios for this node include automating the configuration of a mailgroup installation, updating email server credentials or settings programmatically, adjusting privacy or appearance settings without manual intervention, or integrating mailgroup configuration updates into larger workflows.
For example, an administrator could use this node to update the site's name and logo URL dynamically based on external inputs or to change SMTP server settings when rotating credentials.
Properties
| Name | Meaning |
|---|---|
| Settings (JSON) | A JSON object representing the settings to update in the mailgroup system. It supports a wide range of configuration options including: - app.site_name: The name of the site. - app.root_url: The root URL of the application. - app.logo_url: URL to the site logo. - app.favicon_url: URL to the favicon. - app.from_email: Default sender email address. - app.notify_emails: Array of emails to notify. - app.enable_public_subscription_page: Enable public subscription page (true/false). - app.enable_public_archive: Enable public archive (true/false). - app.send_optin_confirmation: Send opt-in confirmation emails (true/false). - app.check_updates: Enable update checks (true/false). - app.lang: Language code string. - app.batch_size, app.concurrency, app.max_send_errors, app.message_rate: Numeric settings controlling message sending behavior. - app.message_sliding_window: Boolean flag for message rate limiting. - app.message_sliding_window_duration: Duration string for sliding window. - app.message_sliding_window_rate: Rate limit number. - privacy.individual_tracking, privacy.unsubscribe_header, privacy.allow_blocklist, privacy.allow_preferences, privacy.allow_export, privacy.allow_wipe: Privacy-related boolean flags. - privacy.exportable: Array of strings defining exportable data. - privacy.domain_blocklist: Array of domain blocklist entries. - upload.provider: Upload provider type string. - upload.filesystem.upload_path, upload.filesystem.upload_uri: Filesystem upload paths. - upload.s3.url, upload.s3.public_url, upload.s3.aws_access_key_id, upload.s3.aws_default_region, upload.s3.bucket, upload.s3.bucket_domain, upload.s3.bucket_path, upload.s3.bucket_type, upload.s3.expiry: Amazon S3 upload configuration. - smtp: Array of SMTP server configurations, each with properties like uuid, enabled, host, port, authentication protocol, username, email headers, connection limits, timeouts, TLS settings. - messengers: Array of messenger configurations. - bounce.enabled, bounce.webhooks_enabled, bounce.count, bounce.action, bounce.ses_enabled, bounce.sendgrid_enabled, bounce.sendgrid_key, bounce.postmark_enabled, bounce.postmark_username, bounce.postmark_password: Bounce handling settings. - bounce.mailboxes: Array of mailbox configurations for bounce processing. - appearance.admin.custom_css, appearance.admin.custom_js, appearance.public.custom_css, appearance.public.custom_js: Custom CSS and JS for admin and public interfaces. This property is required and must be provided as a valid JSON object reflecting the desired settings changes. |
Output
The node outputs data in the json field of the output items. This JSON contains the response from the mailgroup API after attempting to update the settings. Typically, this will include confirmation of updated fields or error messages if the update failed.
No binary data output is indicated by the source code or properties.
Dependencies
- Requires an active connection to a mailgroup instance's API.
- Requires credentials for authentication, specifically:
- An API domain URL.
- Username and password for basic authentication.
- The node expects these credentials to be configured in n8n prior to execution.
- The mailgroup API must be accessible from the environment where n8n runs.
Troubleshooting
- Invalid JSON in Settings: If the JSON provided in the "Settings (JSON)" property is malformed or contains invalid values, the API may reject the request. Ensure the JSON is well-formed and matches expected schema.
- Authentication Errors: Incorrect or missing credentials will cause authentication failures. Verify that the API domain, username, and password are correctly set in the node credentials.
- API Connectivity Issues: Network problems or incorrect base URL configuration can prevent communication with the mailgroup API. Confirm the API endpoint is reachable.
- Permission Denied: The authenticated user must have permission to update settings. Lack of permissions will result in errors.
- Partial Updates: Some settings might require specific formats or dependencies; improper values may cause partial update failures or ignored fields.
- Error Messages: The node will likely return error messages from the mailgroup API in the output JSON. Review these messages to identify issues such as invalid parameters or server errors.
Links and References
- Mailgroup official documentation (if available) for API and settings schema.
- JSON schema validation tools to verify the correctness of the settings JSON before submission.
- n8n documentation on credential setup and HTTP request nodes for general guidance on API integrations.