Actions7
Overview
This node interacts with the HideMail API to retrieve all email aliases associated with a user account. It is useful for managing and viewing multiple email aliases, which can help users organize incoming emails, protect their primary email address, and control spam. For example, a user might want to list all active aliases to audit which ones are still in use or to find an alias that matches certain criteria.
Properties
| Name | Meaning |
|---|---|
| Page | JSON object specifying pagination details (e.g., page size and number) for the results. |
| Filter | JSON object used to filter the list of aliases based on specific criteria. |
| Search | A string to search aliases by keyword; must be between 3 and 25 characters long. |
| Sort | Field to sort the aliases by. Options include: Email, Is Active, Created At, Updated At, Total Blocked, Total Forwarded, and their descending variants (prefixed with "-"). |
| Page Size | Number indicating how many aliases to return per page (default 100). |
| Page Number | Number indicating which page of results to return (default 1). |
Output
The node outputs a JSON array containing the list of email aliases retrieved from the HideMail API. Each alias object typically includes details such as the alias email address, status (active/inactive), creation and update timestamps, and usage statistics like total blocked and forwarded emails.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the HideMail API.
- The base URL for the API is configurable via credentials.
- The node uses HTTP requests with JSON payloads and expects JSON responses.
Troubleshooting
- Invalid API Token or Authentication Errors: Ensure the API key credential is correctly configured and has the necessary permissions.
- Pagination Issues: If too many results are requested at once, the API may reject the request or respond slowly. Adjust "Page Size" accordingly.
- Search String Length Violations: The "Search" property must be between 3 and 25 characters; otherwise, the API may return an error.
- Sorting Errors: Using unsupported sort fields or invalid values may cause errors. Use only the provided options.
- Malformed JSON in Page or Filter: Since these properties expect JSON input, ensure valid JSON syntax to avoid parsing errors.
Links and References
- HideMail Official Website (replace with actual URL)
- HideMail API Documentation (replace with actual URL)