maddy

README

maddy

Composable all-in-one mail server.

Features

• IMAP4rev1 & SMTP server in one binary
• Comprehensive & Secure
  • DKIM signing and verification
  • SPF policy enforcement
  • DMARC policy enforcement
  • MTA-STS policy enforcement
  • DANE support
  • Built-in STARTTLS Everywhere rules support
• Simple to deploy
  • Two steps (excluding messing with DNS) to get your own secure mail server running
  • Virtual users > system users
  • Single daemon that is easy to manage
• Fast
  • Optimized for concurrency
  • Single process model allows more efficient implementation
• Useful
  • Subaddressing support
  • DNSBL checking support
  • Messages compression (LZ4, Zstd)
  • First-class Unicode support (SMTPUTF8, IDNA2008)
• Flexible
  • Intuitive syntax for complex message routing (SMTP)
  • Same meaningful configuration scheme for all filters
  • Any builtin functionality can be replaced with third-party implementation if it you need it

Installation & configuration

Detailed explaination of what you need to do to get it running can be found here.

Documentation

The full documentation is published here

Manual pages with reference documentation will be installed by build.sh if scdoc utility is available on the system.

Community

There is IRC channel on freenode.net named #maddy. You can join it if you have any questions or just want to talk.

Also there is public mailing list for maddy-related discussions on https://lists.sr.ht/~foxcpp/maddy. You can use it too.

Contributing

See .github/CONTRIBUTING.md.

License

The code is under MIT license. See LICENSE for more information.

Documentation

Index

• Constants
• Variables
• func BuildInfo() string
• func InitDirs() error
• func LogOutputOption(args []string) (log.Output, error)
• func Run() int
• type SDStatus

Constants

const (
	SDReady     = "READY=1"
	SDReloading = "RELOADING=1"
	SDStopping  = "STOPPING=1"
)

Variables

var (
	Version = "go-build"

	// ConfigDirectory specifies platform-specific value
	// that should be used as a location of default configuration
	//
	// It should not be changed and is defined as a variable
	// only for purposes of modification using -X linker flag.
	ConfigDirectory = "/etc/maddy"

	// DefaultStateDirectory specifies platform-specific
	// default for StateDirectory.
	//
	// Most code should use StateDirectory instead since
	// it will contain the effective location of the state
	// directory.
	//
	// It should not be changed and is defined as a variable
	// only for purposes of modification using -X linker flag.
	DefaultStateDirectory = "/var/lib/maddy"

	// DefaultRuntimeDirectory specifies platform-specific
	// default for RuntimeDirectory.
	//
	// Most code should use RuntimeDirectory instead since
	// it will contain the effective location of the state
	// directory.
	//
	// It should not be changed and is defined as a variable
	// only for purposes of modification using -X linker flag.
	DefaultRuntimeDirectory = "/run/maddy"

	// DefaultLibexecDirectory specifies platform-specific
	// default for LibexecDirectory.
	//
	// Most code should use LibexecDirectory since it will
	// contain the effective location of the libexec
	// directory.
	//
	// It should not be changed and is defined as a variable
	// only for purposes of modification using -X linker flag.
	DefaultLibexecDirectory = "/usr/lib/maddy"
)

var (
	ErrNoNotifySock = errors.New("no systemd socket")
)

Functions

func BuildInfo

func BuildInfo() string

func InitDirs

func InitDirs() error

func LogOutputOption

func LogOutputOption(args []string) (log.Output, error)

func Run

func Run() int

Run is the entry point for all maddy code. It takes care of command line arguments parsing, logging initialization, directives setup, configuration reading. After all that, it calls moduleMain to initialize and run modules.

Types

type SDStatus

type SDStatus string