Directories
¶
| Path | Synopsis |
|---|---|
|
Package config loads, validates, and resolves the mail-muncher YAML configuration file: provider credentials, rule definitions, sink targets, and any file paths referenced from within them.
|
Package config loads, validates, and resolves the mail-muncher YAML configuration file: provider credentials, rule definitions, sink targets, and any file paths referenced from within them. |
|
Package filter implements the rule engine: it compiles a rule's `match:` tree into a Matcher and decides, for each message, which rule (if any) claims it.
|
Package filter implements the rule engine: it compiles a rule's `match:` tree into a Matcher and decides, for each message, which rule (if any) claims it. |
|
Package mcpserver exposes the mail mail-muncher has already stored to agents over the Model Context Protocol.
|
Package mcpserver exposes the mail mail-muncher has already stored to agents over the Model Context Protocol. |
|
Package model defines the canonical, provider-independent message model that flows through the pipeline: headers, addresses, bodies, and attachments normalised from whatever the provider returned.
|
Package model defines the canonical, provider-independent message model that flows through the pipeline: headers, addresses, bodies, and attachments normalised from whatever the provider returned. |
|
Package pipeline orchestrates a full cycle: fetch messages from a provider, evaluate them with the filter engine, and hand the matches to the sinks.
|
Package pipeline orchestrates a full cycle: fetch messages from a provider, evaluate them with the filter engine, and hand the matches to the sinks. |
|
Package provider defines the mail provider interface (authenticate, list, fetch) along with its concrete implementations, e.g.
|
Package provider defines the mail provider interface (authenticate, list, fetch) along with its concrete implementations, e.g. |
|
gmail
Package gmail implements the Gmail provider: OAuth against a user-supplied desktop OAuth client, cached token storage, and (in later files) message fetching via the Gmail API.
|
Package gmail implements the Gmail provider: OAuth against a user-supplied desktop OAuth client, cached token storage, and (in later files) message fetching via the Gmail API. |
|
imap
Package imap fetches mail from any IMAP4rev1/rev2 server behind internal/provider.Provider.
|
Package imap fetches mail from any IMAP4rev1/rev2 server behind internal/provider.Provider. |
|
Package sink writes matched messages to their destinations, such as raw .eml files and rendered Markdown documents.
|
Package sink writes matched messages to their destinations, such as raw .eml files and rendered Markdown documents. |
|
Package state persists sync state between runs: which messages have already been processed, provider cursors, and the locking that keeps concurrent runs from stepping on each other.
|
Package state persists sync state between runs: which messages have already been processed, provider cursors, and the locking that keeps concurrent runs from stepping on each other. |
Click to show internal directories.
Click to hide internal directories.