README.md
1MailHog [  ](https://github.com/mailhog/MailHog/releases/tag/v1.0.0) [](https://godoc.org/github.com/mailhog/MailHog) [](https://travis-ci.org/mailhog/MailHog)
2=========
3
4Inspired by [MailCatcher](http://mailcatcher.me/), easier to install.
5
6* Download and run MailHog
7* Configure your outgoing SMTP server
8* View your outgoing email in a web UI
9* Release it to a real mail server
10
11Built with Go - MailHog runs without installation on multiple platforms.
12
13### Overview
14
15MailHog is an email testing tool for developers:
16
17* Configure your application to use MailHog for SMTP delivery
18* View messages in the web UI, or retrieve them with the JSON API
19* Optionally release messages to real SMTP servers for delivery
20
21### Getting started
22
231. Either:
24 * [Download the latest release](/docs/RELEASES.md) of MailHog for your platform
25 * [Run it from Docker Hub](https://registry.hub.docker.com/u/mailhog/mailhog/) or using the provided [Dockerfile](Dockerfile)
26 * [Read the deployment guide](/docs/DEPLOY.md) for other deployment options
27 * Install it with Homebrew on MacOS - `brew update && brew install mailhog`
282. [Configure MailHog](/docs/CONFIG.md), or use the default settings:
29 * the SMTP server starts on port 1025
30 * the HTTP server starts on port 8025
31 * in-memory message storage
32
33### Features
34
35See [MailHog libraries](docs/LIBRARIES.md) for a list of MailHog client libraries.
36
37* ESMTP server implementing RFC5321
38* Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
39* Web interface to view messages (plain text, HTML or source)
40 * Supports RFC2047 encoded headers
41* Real-time updates using EventSource
42* Release messages to real SMTP servers
43* Chaos Monkey for failure testing
44 * See [Introduction to Jim](/docs/JIM.md) for more information
45* HTTP API to list, retrieve and delete messages
46 * See [APIv1](/docs/APIv1.md) and [APIv2](/docs/APIv2.md) documentation for more information
47* [HTTP basic authentication](docs/Auth.md) for MailHog UI and API
48* Multipart MIME support
49* Download individual MIME parts
50* In-memory message storage
51* MongoDB and file based storage for message persistence
52* Lightweight and portable
53* No installation required
54
55#### sendmail
56
57[mhsendmail](https://github.com/mailhog/mhsendmail) is a sendmail replacement for MailHog.
58
59It redirects mail to MailHog using SMTP.
60
61You can also use `MailHog sendmail ...` instead of the separate mhsendmail binary.
62
63Alternatively, you can use your native `sendmail` command by providing `-S`, for example:
64
65```
66/usr/sbin/sendmail -S mail:1025
67```
68
69For example, in PHP you could add either of these lines to `php.ini`:
70
71```
72sendmail_path = /usr/local/bin/mhsendmail
73sendmail_path = /usr/sbin/sendmail -S mail:1025
74```
75
76#### Web UI
77
78
79
80### Contributing
81
82MailHog is a rewritten version of [MailHog](https://github.com/ian-kent/MailHog), which was born out of [M3MTA](https://github.com/ian-kent/M3MTA).
83
84Clone this repository to ```$GOPATH/src/github.com/mailhog/MailHog``` and type ```make deps```.
85
86See the [Building MailHog](/docs/BUILD.md) guide.
87
88Requires Go 1.4+ to build.
89
90Run tests using ```make test``` or ```goconvey```.
91
92If you make any changes, run ```go fmt ./...``` before submitting a pull request.
93
94### Licence
95
96Copyright © 2014 - 2017, Ian Kent (http://iankent.uk)
97
98Released under MIT license, see [LICENSE](LICENSE.md) for details.
99
){kind=link}
){kind=link}
){kind=link}
