2014-04-20 16:17:00 +00:00
|
|
|
Go-MailHog
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
Inspired by [MailCatcher](http://mailcatcher.me/), easier to install.
|
|
|
|
|
|
2014-06-23 16:41:48 +00:00
|
|
|
Go-MailHog is a rewritten version of [MailHog](https://github.com/ian-kent/MailHog), which was born out of [M3MTA](https://github.com/ian-kent/M3MTA).
|
2014-04-20 16:17:00 +00:00
|
|
|
|
|
|
|
|
Go was chosen for portability - MailHog runs without installation on multiple platforms.
|
|
|
|
|
|
|
|
|
|
### Requirements
|
|
|
|
|
|
|
|
|
|
* None!
|
|
|
|
|
|
|
|
|
|
### Getting started
|
|
|
|
|
|
2014-04-28 00:52:15 +00:00
|
|
|
* [Download the latest release](RELEASES.md) of Go-MailHog for your platform
|
2014-04-20 16:17:00 +00:00
|
|
|
* Start MailHog
|
|
|
|
|
|
2014-04-27 19:55:22 +00:00
|
|
|
By default, the SMTP server will start on port 1025, the HTTP server will start
|
|
|
|
|
on port 8025, and in-memory message storage will be used.
|
2014-04-20 16:17:00 +00:00
|
|
|
|
2014-04-21 11:24:21 +00:00
|
|
|
### Features
|
|
|
|
|
|
|
|
|
|
* ESMTP server implementing RFC5321
|
2014-04-24 18:58:34 +00:00
|
|
|
* Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
|
|
|
|
|
* Web interface to view messages (plain text, HTML or source)
|
2014-04-27 22:39:13 +00:00
|
|
|
* Real-time updates using EventSource
|
2014-04-27 16:31:43 +00:00
|
|
|
* Release messages to real SMTP servers
|
2014-04-24 18:58:34 +00:00
|
|
|
* HTTP API to list, retrieve and delete messages
|
2014-04-27 19:53:12 +00:00
|
|
|
* See [APIv1 documentation](APIv1.md) for more information
|
2014-04-24 18:58:34 +00:00
|
|
|
* Multipart MIME support
|
2014-04-27 19:02:36 +00:00
|
|
|
* Download individual MIME parts
|
2014-04-24 18:58:34 +00:00
|
|
|
* In-memory message storage
|
2014-04-21 11:24:21 +00:00
|
|
|
* MongoDB storage for message persistence
|
|
|
|
|
* Lightweight and portable
|
|
|
|
|
* No installation required
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-04-20 16:17:00 +00:00
|
|
|
### Configuration
|
|
|
|
|
|
2014-04-20 16:17:46 +00:00
|
|
|
You can configure Go-MailHog using command line options:
|
|
|
|
|
|
2014-04-20 16:17:00 +00:00
|
|
|
| Parameter | Default | Description
|
|
|
|
|
| ------------- | --------------- | -----------
|
|
|
|
|
| -hostname | mailhog.example | Hostname to use for EHLO/HELO and message IDs
|
|
|
|
|
| -httpbindaddr | 0.0.0.0:8025 | Interface and port for HTTP server to bind to
|
|
|
|
|
| -mongocoll | messages | MongoDB collection name for message storage
|
|
|
|
|
| -mongodb | mailhog | MongoDB database name for message storage
|
|
|
|
|
| -mongouri | 127.0.0.1:27017 | MongoDB host and port
|
|
|
|
|
| -smtpbindaddr | 0.0.0.0:1025 | Interface and port for SMTP server to bind to
|
2014-04-24 18:58:34 +00:00
|
|
|
| -storage | memory | Set message storage: memory / mongodb
|
2014-04-20 16:17:00 +00:00
|
|
|
|
|
|
|
|
### Contributing
|
|
|
|
|
|
2014-06-23 16:41:03 +00:00
|
|
|
Clone this repository to ```$GOPATH/src/github.com/ian-kent/Go-MailHog``` and type ```go install```.
|
2014-04-20 16:17:00 +00:00
|
|
|
|
2014-04-27 15:06:58 +00:00
|
|
|
You'll need go-bindata to embed web assets:
|
|
|
|
|
```
|
|
|
|
|
go get https://github.com/jteeuwen/go-bindata/...
|
|
|
|
|
go-bindata assets/...
|
|
|
|
|
```
|
|
|
|
|
|
2014-04-28 00:42:05 +00:00
|
|
|
If you build using ```make install```, necessary dependencies will be installed for you.
|
|
|
|
|
|
|
|
|
|
Run tests using ```make test```. You'll need a copy of MailHog running for tests to pass.
|
2014-04-24 18:58:34 +00:00
|
|
|
(Tests currently fail using in-memory storage, use MongoDB!)
|
2014-04-20 16:17:00 +00:00
|
|
|
|
|
|
|
|
If you make any changes, run ```go fmt``` before submitting a pull request.
|
|
|
|
|
|
|
|
|
|
### Licence
|
|
|
|
|
|
|
|
|
|
Copyright © 2014, Ian Kent (http://www.iankent.eu).
|
|
|
|
|
|
|
|
|
|
Released under MIT license, see [LICENSE](license) for details.
|
