Email (IMAP)

Node catalog Triggers

On this page

Starts the workflow when a new message arrives in a mailbox folder

Usage and specifics

IMAP receives messages; SMTP sends them. The first poll records the latest UID and ignores existing messages by default. markAsRead applies the \Seen flag after a successful run.

Technical type : email_trigger. Runtime : nodulz.

Credentials and prerequisites

Create and configure the credential : imap

Create credentials in your nodulz instance’s Credentials area, then select them on the node. Availability depends on ownership and sharing. See the credentials guide for access and rotation.

Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

Parameter	Type	Default	Values / limits
`credentialId`	`string`	`""`	-
`folder`	`string`	`"INBOX"`	-
`pollInterval`	`string`	`"1m"`	-
`markAsRead`	`boolean`	`false`	-
`triggerOnFirstPoll`	`boolean`	`false`	-
`rules`	`object`	`{}`	-
`rules.fromContains`	`string`	`""`	-
`rules.subjectContains`	`string`	`""`	-
`rules.toContains`	`string`	`""`	-
`testPayload`	`string`	`""`	-
`pollState`	`object`	-	-
`pollState.lastSeenUid`	`number`	-	-; ≥ 0
`lastError`	`string`	-	-

Configuration help

credentialId IMAP mailbox: Create a credential under Credentials → IMAP (host, port, user, app password).
folder Folder: IMAP folder to watch - usually INBOX.
pollInterval Poll interval: How often nodulz checks the mailbox for new messages. Examples: 30s, 1m, 5m, or a cron expression.
markAsRead Mark as read after run: Sets the \Seen flag on IMAP after a successful workflow run.
triggerOnFirstPoll Trigger on existing mail at first poll: When off (default), the first poll only records the latest UID - no backlog.
testPayload Test payload (JSON): Used when you click Test trigger in the editor. Must include trigger, mailbox, and message fields.

Examples

Output includes subject, bodies, headers, and attachment metadata in input.message.

Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

json

{
  "credentialId": "",
  "folder": "INBOX",
  "pollInterval": "1m",
  "markAsRead": false,
  "triggerOnFirstPoll": false,
  "rules": {},
  "testPayload": ""
}

Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.