IMAP Source Node
Quick Reference
Host
IMAP server hostname or IP address.
ex: imap.example.com
Port
IMAP server port.
ex: 993
Use Credentials Username/password or OAuth2 credential for authentication.
Authentication Type
How to authenticate with the IMAP server. Options: Password or OAuth2.
Folder
Mailbox folder to read from.
ex: INBOX
Search Criteria
IMAP search filter string to narrow which messages are fetched.
ex: UNSEEN
Poll Interval (ms)
How often to check for new messages, in milliseconds.
ex: 60000
Mark as Read When enabled, fetched messages are marked as read so they are not fetched again.
Include Attachments When enabled, email attachment data is included in the emitted record.
Use SSL Enable SSL/TLS for the connection.
Max Messages Per Poll
Maximum number of messages to fetch per poll cycle.
ex: 100
Overview
The IMAP Source node polls an IMAP email mailbox on a configurable interval and emits each email as an record to be processed downstream. It supports password and OAuth2 authentication, flexible search filters, and optional attachment ingestion, making it suitable for email-driven automation and monitoring workflows.
Configuration
| Field | Description | Required | Default |
|---|---|---|---|
| Host | IMAP server hostname or IP address. | Yes | — |
| Port | IMAP server port number. | No | 993 |
| Use Credentials | Select or create a credential for authentication. | Yes | — |
| Authentication Type | How to authenticate with the IMAP server. Options: Password, OAuth2. | No | Password |
| Folder | Mailbox folder to read messages from. | No | INBOX |
| Search Criteria | IMAP search filter string used to narrow which messages are fetched (e.g. UNSEEN, FROM "sender@example.com"). If omitted, all messages in the folder are returned. | No | — |
| Poll Interval (ms) | How frequently the node checks for new messages, in milliseconds. | No | 60000 |
| Mark as Read | When enabled, messages are marked as read after being fetched so they are not retrieved again on the next poll. | No | true |
| Include Attachments | When enabled, attachment data is included in the emitted record payload. | No | false |
| Use SSL | Enable SSL/TLS encryption for the IMAP connection. | No | true |
| Max Messages Per Poll | Maximum number of messages to fetch in a single poll cycle. | No | 100 |
Related Nodes
- SMTP Sink: Send emails via SMTP for each pipeline record
- Kafka Source: Consume streaming data from Kafka