diff --git a/README.md b/README.md index 1da5240..e5b5f2e 100644 --- a/README.md +++ b/README.md @@ -32,31 +32,24 @@ Mailpit was originally **inspired** by MailHog which is [no longer maintained](h ## Features -- Runs entirely from a single [static binary](https://mailpit.axllent.org/docs/install/) -- Modern web UI to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments -including image thumbnails), including optional [HTTPS](https://mailpit.axllent.org/docs/configuration/https/) -- Optional [basic authentication](https://mailpit.axllent.org/docs/configuration/frontend-authentication/) for web UI & API +- Runs entirely from a single [static binary](https://mailpit.axllent.org/docs/install/) or multi-architecture [Docker images](https://mailpit.axllent.org/docs/install/docker/) +- Modern web UI with advanced [mail search](https://mailpit.axllent.org/docs/usage/search-filters/) to view emails (formatted HTML, highlighted HTML source, text, headers, raw source, and MIME attachments +including image thumbnails), including optional [HTTPS](https://mailpit.axllent.org/docs/configuration/http/) & [authentication](https://mailpit.axllent.org/docs/configuration/http/) +- [SMTP server](https://mailpit.axllent.org/docs/configuration/smtp/) with optional STARTTLS or SSL/TLS, authentication (including an "accept any" mode) +- A [REST API](https://mailpit.axllent.org/docs/api-v1/) for integration testing +- Real-time web UI updates using web sockets for new mail & optional [browser notifications](https://mailpit.axllent.org/docs/usage/notifications/) when new mail is received +- Optional [POP3 server](https://mailpit.axllent.org/docs/configuration/pop3/) to download captured message directly into your email client - [HTML check](https://mailpit.axllent.org/docs/usage/html-check/) to test & score mail client compatibility with HTML emails - [Link check](https://mailpit.axllent.org/docs/usage/link-check/) to test message links (HTML & text) & linked images - [Spam check](https://mailpit.axllent.org/docs/usage/spamassassin/) to test message "spamminess" using a running SpamAssassin server - [Create screenshots](https://mailpit.axllent.org/docs/usage/html-screenshots/) of HTML messages via web UI -- `List-Unsubscribe` syntax validation - Mobile and tablet HTML preview toggle in desktop mode -- Advanced [mail search](https://mailpit.axllent.org/docs/usage/search-filters/) -- [Message tagging](https://mailpit.axllent.org/docs/usage/tagging/) -- Real-time web UI updates using web sockets for new mail & optional browser notifications for new mail (when accessed -via either HTTPS or `localhost` only) -- SMTP server with optional [STARTTLS & SMTP authentication](https://mailpit.axllent.org/docs/configuration/smtp-authentication/) (including an -"accept any" mode) -- [SMTP relaying](https://mailpit.axllent.org/docs/configuration/smtp-relay/) (message release) - relay messages via a different SMTP server -including an optional allowlist of accepted recipients -- Fast SMTP processing & storing - ingesting 100-200 emails per second depending on CPU, network speed & email size, -easily handling tens of thousands of emails -- Optional [POP3 server](https://mailpit.axllent.org/docs/configuration/pop3/) to download captured message directly into your email client -- Configurable automatic email pruning (default keeps the most recent 500 emails) -- A simple [REST API](https://mailpit.axllent.org/docs/api-v1/) for integration testing +- [Message tagging](https://mailpit.axllent.org/docs/usage/tagging/) including manual tagging or automated tagging using filtering and "plus addressing" +- [SMTP relaying](https://mailpit.axllent.org/docs/configuration/smtp-relay/) (message release) - relay messages via a different SMTP server including an optional allowlist of accepted recipients +- Fast message [storing & processing](https://mailpit.axllent.org/docs/configuration/email-storage/) - ingesting 100-200 emails per second over SMTP depending on CPU, network speed & email size, +easily handling tens of thousands of emails, with automatic email pruning (by default keeping the most recent 500 emails) +- `List-Unsubscribe` syntax validation - Optional [webhook](https://mailpit.axllent.org/docs/integration/webhook/) for received messages -- Multi-architecture [Docker images](https://mailpit.axllent.org/docs/install/docker/) ## Installation