Actions105
- Info Actions
- Messages Actions
- Homework Actions
- Absence Actions
- Calendar Actions
Overview
This node interacts with a school management system API to manage and retrieve messages, specifically focusing on the "Messages" resource and the "List Inbox" operation. It allows users to list inbox messages optionally filtered by date range and paginated by page number. This is useful for automating message retrieval from a student's or teacher's inbox, enabling workflows such as monitoring new messages, archiving communications, or integrating message data into other systems.
Practical examples:
- Automatically fetch all inbox messages received within a specific date range.
- Paginate through inbox messages to process large volumes in batches.
- Use the retrieved messages to trigger notifications or further processing in an educational workflow.
Properties
| Name | Meaning |
|---|---|
| From | Optional start date filter for messages in format YYYY-MM-DD. |
| To | Optional end date filter for messages in format YYYY-MM-DD. |
| Custom method name | Advanced: override the default API method called (e.g., to call a custom or extended method). |
| Folder ID | Numeric ID of the folder to list messages from; default is 5 which corresponds to inbox. |
| Page | Page number for pagination if supported by the API; defaults to 1. |
Output
The output is an array of JSON objects where each object represents a single message from the inbox. Each message object contains the properties returned by the underlying API, typically including details like sender, subject, content snippet, timestamps, and message IDs.
If the node is used with operations that return binary data (not applicable for List Inbox), it would provide binary data fields containing file contents encoded in base64 along with metadata such as MIME type and filename.
Dependencies
- Requires valid credentials for the external school management system API (an API key or login/password).
- The node uses an internal client wrapper to communicate with the API.
- No additional environment variables are explicitly required beyond the API credentials.
Troubleshooting
- No supported method found error: This occurs if the selected operation or custom method name does not match any available API methods. Verify the operation and custom method name inputs.
- Empty results: If no messages appear, check the date filters ("From" and "To") and folder ID to ensure they correspond to existing messages.
- Pagination issues: Ensure the "Page" parameter is set correctly; some APIs may have limits on page size or number.
- Authentication errors: Confirm that the provided API credentials are correct and have sufficient permissions.
Links and References
- Refer to the official API documentation of the school management system for detailed information about message folders, pagination, and filtering options.
- n8n documentation on creating and using credentials for API authentication.