mirrors/maddy
1
0
Fork 0
mirror of https://github.com/foxcpp/maddy.git synced 2025-04-05 05:57:39 +03:00
Code Issues Projects Releases Packages Wiki Activity
maddy/docs
History
fox.cpp c3ebbb05a0
Generalize message flow restrictions 
Set of flow restrictions is represented as a "limits" module instance
that can be either created inline via "limits" directive in some modules
(including "remote" target and "smtp" endpoint) or defined globally and
referenced in configuration of modules mentioned above.

This permits a variety of use cases, including shared and separate
counters for various endpoints and also "modules group" style sharing
described in #195.
2020-02-15 17:02:48 +03:00
..
internals docs: Move the project documentation from GitHub Wiki 2019-12-06 22:56:47 +03:00
man Generalize message flow restrictions 2020-02-15 17:02:48 +03:00
tutorials Rewrite build scripts 2020-02-07 20:33:58 +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

README.md

maddy

builds.sr.ht status

Composable all-in-one mail server.

⚠️ Disclaimer: maddy is in development, many planned features are missing, bugs are waiting to eat your messages and incompatible changes happen from time to time

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

Examples of more advanced configurations with explainations can be found in the examples directory in the source repository.

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.