mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Mail List Mail Addresses, retrieves a list of mail addresses associated with a specified project from the mittwald mStudio API. It is useful for scenarios where you need to programmatically access and manage email addresses within a project, such as syncing mail addresses to another system, auditing mailboxes, or filtering addresses based on specific criteria.

Practical examples include:

  • Fetching all mail addresses in a project to display them in a dashboard.
  • Filtering mail addresses that have active auto responders or are catch-all addresses.
  • Paginating through large sets of mail addresses for batch processing.

Properties

Name Meaning
Project Id ID of the Project to list MailAddresses for. (Required)
Search Search term to filter MailAddresses. Searches fields: id (exact match), address and mailboxName (partial match).
Forward Address Filter by whether the MailAddress is a forward address (true or false).
Catch All Filter by whether the MailAddress is a catch-all address (true or false).
Auto Responder Filter by whether the MailAddress has an active auto responder (true or false).
Mail Archive Filter by whether the MailAddress has a mail archive (true or false).
Limit Maximum number of mail addresses to return in the response. Default is 10,000.
Skip Number of items to skip in the result set. Should be a multiple of limit. Used for pagination.
Page Page number to display. Similar effect as skip. If both page and skip are set, skip takes precedence.
Sort JSON array specifying fields to sort the results by. Default is ["address.domain", "address.local"].
Order JSON array specifying sorting order for each field in Sort. Values can be "asc" or "desc". Default is ["asc", "asc"].

Output

The node outputs a JSON array of mail address objects matching the query parameters. Each object typically contains details about a mail address such as its ID, full address, mailbox name, and flags indicating if it is a forward address, catch-all, has an auto responder, or mail archive enabled.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de and expects JSON responses.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Empty Results: Ensure the Project Id is correct and that the project contains mail addresses. Also verify that search filters are not too restrictive.
  • Authentication Errors: Check that the API key credential is valid and has sufficient permissions.
  • Pagination Issues: When using skip and limit, ensure skip is a multiple of limit to avoid unexpected results.
  • Invalid JSON in Sort/Order: The Sort and Order properties expect valid JSON arrays. Invalid JSON will cause errors.
  • API Rate Limits: Large limit values may hit API rate limits or timeouts; consider reducing the limit or paginating results.

Links and References

Discussion