IMAP integration
IMAP is supported through the Mach5 connector framework. This page lists every supported operation and where it can be used.
Connection
- Connector kind:
imap - Configuration:
host, optionalport,tls,username,password_secret_ref,default_page_limit, andmax_message_bytes.
How to use this integration
For Axon concepts, safety classes, idempotency, and outcomes, see Axon workflows.
Axon
Axon is the controlled action path for connector reads, enrichments, and side effects. Use Axon when a workflow needs to call IMAP directly, enrich an investigation, or take an approved action. Invoke the connector kind imap with the operation name and JSON input.
connector: imap
operation: list_mailboxes
input: { ... }
Ingest Pipelines
Use ingest pipelines for operations exposed as sources. These operations can checkpoint and stream records into Mach5-managed data.
source.connector: imap
source.operation: mailbox_source
source.config: { ... }
SQL
Use SQL for read operations exposed as table or scalar functions. Query the connector operation with JSON input and join the result with Mach5 data.
SELECT *
FROM connector_table('imap', 'list_mailboxes', JSON '{}');
Supported operations
| Operation | What it does | Axon | Ingest Pipelines | SQL |
|---|---|---|---|---|
validate | Validate IMAP server reachability and auth settings. | — | — | — |
list_mailboxes | List IMAP mailboxes. | Yes | — | Yes |
search_messages | Search IMAP message metadata with bounded limits. | Yes | — | Yes |
fetch_message | Fetch IMAP message metadata/body/raw with byte limits. | Yes | — | Yes |
update_flags | Add/remove IMAP message flags. | Yes | — | — |
delete_message | Mark an IMAP message deleted and optionally expunge. | Yes | — | — |
parse_message | Parse a raw RFC 5322/MIME message without network side effects. | Yes | — | Yes |
mailbox_source | Durable mailbox ingest source partitioned by mailbox and UID. | — | Yes | — |