IMAP icon

IMAP

Retrieve emails via IMAP

Overview

This node connects to an IMAP email server to perform various mailbox-related operations. Specifically, the Mailbox - Get Status operation retrieves the status information of a selected mailbox (e.g., INBOX). This can include details such as the number of messages, recent messages, unseen messages, and other mailbox metadata.

Common scenarios where this node is beneficial:

  • Monitoring mailbox status to trigger workflows based on new or unread emails.
  • Fetching mailbox statistics for reporting or auditing purposes.
  • Integrating email status checks into larger automation pipelines.

Practical example:

  • Automatically check the status of the "INBOX" mailbox every hour to detect if new emails have arrived, then trigger further processing like parsing or forwarding those emails.

Properties

Name Meaning
Credential Type Choose which credentials to use for connecting to the IMAP server:
- IMAP: Use credentials defined in this node.
- N8N IMAP Trigger Node: Use existing credentials from an N8N IMAP Trigger node.
Mailbox Select the mailbox to get the status of. You can either:
- Pick from a list of available mailboxes.
- Provide the full path to the mailbox manually.

Output

The node outputs JSON data containing the status information of the specified mailbox. The exact structure depends on the IMAP server response but typically includes fields such as:

  • Number of messages in the mailbox.
  • Number of recent messages.
  • Number of unseen (unread) messages.
  • Other mailbox flags or metadata.

If the node supports binary data output (not indicated here), it would represent email content or attachments; however, for the "Get Status" operation, only JSON metadata is returned.

Dependencies

  • Requires valid IMAP credentials to connect to the email server. These credentials must be provided either directly in the node or via an existing IMAP Trigger node.
  • The node uses an internal IMAP client library to communicate with the server.
  • No additional external services are required beyond the IMAP server itself.
  • Environment variable N8N_LOG_LEVEL can influence logging verbosity (e.g., set to "debug" for detailed logs).

Troubleshooting

  • Connection failed errors: Usually caused by incorrect credentials, wrong server address, or network issues. Verify the IMAP credentials and server accessibility.
  • Unknown operation or resource errors: Ensure that the Resource is set to "Mailbox" and Operation to "Get Status" as supported by the node.
  • Empty or no data returned: Could indicate the mailbox path is incorrect or the mailbox is empty. Double-check the mailbox selection.
  • Error messages including responseText or generic "Unknown error": These often come from the IMAP server or network layer. Check server logs and network connectivity.
  • If using credentials from another node, ensure that node is configured correctly and accessible.

Links and References

Discussion