improve Readme
Raphael Sprenger
Sat, 29 Aug 2026 16:58:23 +0200
1 files changed,
9 insertions(+),
6 deletions(-)
jump to
M
Readme.md
→
Readme.md
@@ -1,9 +1,9 @@
Postern ======= -> [!WARNING] -> **Alpha warning:** This software is in an experimental state. -> Do not use in production or for any important emails while we work towards v1.0. +Subscribe to our mailing list by sending an email to `postern+subscribe@lists.p25.dev` for announcements of +new versions. +The mailing list server runs Postern and mlmmj. Postern is a modern all-in-one mail delivery agent. It combines IMAP (IMAP4rev2), SMTP Submission and SMTP delivery.@@ -11,12 +11,15 @@
We have EU Sovereignity at our core values. We welcome users and contributions from around the world and will keep service providers such as server hosting and DNS registrars EU based. +> **⚠️ WARNING:** This software is in an experimental state. +> Do not use in production or for any important emails while we work towards v1.0. + Overview -------- What makes Postern special is its policy engine. Imagine it as a modern Sieve based on [Starlark](https://starlark-lang.org), which uses Python syntax. -The `policy.star` file has an example how new senders end up in a "Gatekeeper" mailbox. +The [policy.star file](https://code.raphting.dev/postern.git/blob/main/policy.star) has an example how new senders end up in a "Gatekeeper" mailbox. Simply moving a message from one folder to another updates how the policy engine reacts to this sender for future messages.@@ -24,6 +27,7 @@ Reacting on side effects such as database state or network calls is probably the biggest advantage of the policy engine
over Sieve when it comes to modern email management. Postern has secure defaults, stores emails encrypted at rest and runs as a single binary with an SQLite backend. +This simplifies backups. All you need to back up is your `/var/lib/postern` (depending on your configuration) directory. You can subscribe to *announcements* by sending an email to `postern+subscribe@lists.p25.dev`. The mailing list server runs on Postern and mlmmj.@@ -94,8 +98,7 @@
Use `git send-email` to contribute your patch. For a tutorial see [https://git-send-email.io](https://git-send-email.io/). It is okay to use the mailing list as a chat rather than a formalized procedure. Just say 'hi'! -> [!TIP] -> You can integrate `git send-email` with Postern too! +> **💡 TIP:** You can integrate `git send-email` with Postern too! Security --------