maddy/docs
2020-05-14 20:35:21 +03:00
..
internals docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
man Fix small typo 2020-05-14 20:31:52 +03:00
tutorials docs: Update outdated tutorials 2020-05-14 20:35:21 +03:00
README.md docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
seclevels.md target/remote: Clean up security policies checking 2019-12-28 18:41:55 +03:00
specifications.md docs: Add page with implemented RFCs 2020-02-08 03:23:05 +03:00
unicode.md Document Unicode support details 2019-12-28 18:41:55 +03:00

maddy builds.sr.ht status codecov

Composable all-in-one mail server.

Features

  • IMAP4rev1 & SMTP server in one binary
  • Comprehensive & Secure
  • 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.