README
¶
maddy source tree
Main maddy code base lives here. No packages are intended to be used in third-party software hence API is not stable.
Subdirectories are organized as follows:
/
auxiliary libraries
endpoint/
modules - protocol listeners (e.g. SMTP server, etc)
target/
modules - final delivery targets (including outbound delivery, such as
target.smtp, remote)
auth/
modules - authentication providers
check/
modules - message checkers (module.Check)
modify/
modules - message modifiers (module.Modifier)
storage/
modules - local messages storage implementations (module.Storage)
Directories
¶
| Path | Synopsis |
|---|---|
|
Package adminweb embeds the pre-built admin dashboard SPA (SvelteKit static output).
|
Package adminweb embeds the pre-built admin dashboard SPA (SvelteKit static output). |
|
api
|
|
|
admin
Package admin implements a single-endpoint RPC-style Admin API for Madmail.
|
Package admin implements a single-endpoint RPC-style Admin API for Madmail. |
|
shadow
shadow package implements utilities for parsing and using shadow password database on Unix systems.
|
shadow package implements utilities for parsing and using shadow password database on Unix systems. |
|
Package dsn contains the utilities used for dsn message (DSN) generation.
|
Package dsn contains the utilities used for dsn message (DSN) generation. |
|
endpoint
|
|
|
Package endpoint_cache implements a database-backed endpoint override cache.
|
Package endpoint_cache implements a database-backed endpoint override cache. |
|
Package limit provides a module object that can be used to restrict the concurrency and rate of the messages flow globally or on per-source, per-destination basis.
|
Package limit provides a module object that can be used to restrict the concurrency and rate of the messages flow globally or on per-source, per-destination basis. |
|
limiters
Package limiters provides a set of wrappers intended to restrict the amount of resources consumed by the server.
|
Package limiters provides a set of wrappers intended to restrict the amount of resources consumed by the server. |
|
Package servertracker provides an in-memory tracker for unique email servers seen by the SMTP endpoint.
|
Package servertracker provides an in-memory tracker for unique email servers seen by the SMTP endpoint. |
|
Package smtpconn contains the code shared between target.smtp and remote modules.
|
Package smtpconn contains the code shared between target.smtp and remote modules. |
|
storage
|
|
|
imapsql
Package imapsql implements SQL-based storage module using go-imap-sql library (github.com/foxcpp/go-imap-sql).
|
Package imapsql implements SQL-based storage module using go-imap-sql library (github.com/foxcpp/go-imap-sql). |
|
queue
Package queue implements module which keeps messages on disk and tries delivery to the configured target (usually remote) multiple times until all recipients are succeeded.
|
Package queue implements module which keeps messages on disk and tries delivery to the configured target (usually remote) multiple times until all recipients are succeeded. |
|
remote
Package remote implements module which does outgoing message delivery using servers discovered using DNS MX records.
|
Package remote implements module which does outgoing message delivery using servers discovered using DNS MX records. |
|
smtp
Package smtp_downstream provides target.smtp module that implements transparent forwarding or messages to configured list of SMTP servers.
|
Package smtp_downstream provides target.smtp module that implements transparent forwarding or messages to configured list of SMTP servers. |
|
Package updatepipe implements utilities for serialization and transport of IMAP update objects between processes and machines.
|
Package updatepipe implements utilities for serialization and transport of IMAP update objects between processes and machines. |
Click to show internal directories.
Click to hide internal directories.