mailpit

README

Mailpit - email testing for developers

Mailpit is a multi-platform email testing tool for developers.

It acts as both an SMTP server, and provides a web interface to view all captured emails.

Mailpit is inspired by MailHog, but much, much faster.

Features

• Runs entirely from a single binary, no installation required
• SMTP server (default 0.0.0.0:1025)
• Web UI to view emails (formatted HTML, highlighted HTML source, text, raw source and MIME attachments including image thumbnails)
• Advanced mail search (see wiki)
• Message tagging (see wiki)
• Real-time web UI updates using web sockets for new mail
• Optional browser notifications for new mail (HTTPS only)
• Configurable automatic email pruning (default keeps the most recent 500 emails)
• Email storage either in a temporary or persistent database (see wiki)
• Fast SMTP processing & storing - approximately 70-100 emails per second depending on CPU, network speed & email size
• Can handle hundreds of thousands of emails
• Optional SMTP with STARTTLS & SMTP authentication (see wiki)
• Optional HTTPS for web UI (see wiki)
• Optional basic authentication for web UI (see wiki)
• A simple REST API (see docs)
• Multi-architecture Docker images

Installation

Linux & Mac users can install it directly to /usr/local/bin/mailpit with:

sudo bash < <(curl -sL https://raw.githubusercontent.com/axllent/mailpit/develop/install.sh)

Or download a static binary from the releases. The mailpit binary can be placed in your $PATH, or simply run as ./mailpit. See mailpit -h for options, or see the wiki for additional information.

To build Mailpit from source see building from source.

The Mailpit web UI listens by default on http://0.0.0.0:8025, and the SMTP port on 0.0.0.0:1025.

Configuring sendmail

There are several different options available:

You can use mailpit sendmail as your sendmail configuration in php.ini:

sendmail_path = /usr/local/bin/mailpit sendmail

If Mailpit is found on the same host as sendmail, you can symlink the Mailpit binary to sendmail, eg: ln -s /usr/local/bin/mailpit /usr/sbin/sendmail (only if Mailpit is running on default 1025 port).

You can use your default system sendmail binary to route directly to port 1025 (configurable) by calling /usr/sbin/sendmail -S localhost:1025.

You can build a Mailpit-specific sendmail binary from source (see building from source).

Why rewrite MailHog?

I had been using MailHog for a few years to intercept and test emails generated from several projects. MailHog has a number of severe performance issues, many of the modules are horribly out of date, and other than a few accepted MRs, it is not actively developed.

Initially I started trying to upgrade a fork of MailHog (both the UI as well as the HTTP server & API), but soon discovered that it is (with all due respect) very poorly designed. It is over-engineered (split over 9 separate projects) and has too many unnecessary features for my purpose. It performs exceptionally poorly when dealing with large amounts of emails or processing any email with an attachment (a single email with a 3MB attachment can take over a minute to ingest). The API also transmits a lot of duplicate and unnecessary data on every message request for all web calls, and there is no HTTP compression.

In order to improve it I felt it needed to be completely rewritten, and so Mailpit was born.