ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-23 22:34:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Web and API based SMTP testing
54 commits 1 branch 0 tags 3 MiB
Go 68.6%
Makefile 19.7%
Dockerfile 11.7%
Find a file
Ian Kent c2f3507733 Fix markdown
2014-04-27 20:53:12 +01:00
assets Clean up API 2014-04-27 20:52:46 +01:00
images Update screenshot 2014-04-27 20:27:13 +01:00
mailhog Clean up API 2014-04-27 20:52:46 +01:00
APIv1.md Clean up API 2014-04-27 20:52:46 +01:00
auth_test.go More auth tests, fix bug 2014-04-22 23:27:07 +01:00
bindata.go Clean up API 2014-04-27 20:52:46 +01:00
main.go Use go-bindata to embed assets 2014-04-27 16:06:58 +01:00
main_test.go Add in-memory storage, clean up config 2014-04-24 00:22:50 +01:00
mime_test.go Add in-memory storage, clean up config 2014-04-24 00:22:50 +01:00
README.md Fix markdown 2014-04-27 20:53:12 +01:00

README.md

Go-MailHog

Inspired by MailCatcher, easier to install.

Go-MailHog is a rewritten version of MailHog, which was born out of M3MTA.

Go was chosen for portability - MailHog runs without installation on multiple platforms.

Requirements

  • None!

Getting started

  • Download the latest release of Go-MailHog for your platform
  • Start MailHog

By default, the SMTP server will start on port 1025, and the HTTP server will start on port 8025.

Features

  • ESMTP server implementing RFC5321
  • Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
  • Web interface to view messages (plain text, HTML or source)
  • Release messages to real SMTP servers
  • HTTP API to list, retrieve and delete messages
  • Multipart MIME support
  • Download individual MIME parts
  • In-memory message storage
  • MongoDB storage for message persistence
  • Lightweight and portable
  • No installation required

Screenshot of MailHog web interface

Configuration

You can configure Go-MailHog using command line options:

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
-storage memory Set message storage: memory / mongodb

Contributing

Clone this repository to $GOPATH/src/github.com/ian-kent/MailHog and type go install.

You'll need go-bindata to embed web assets:

go get https://github.com/jteeuwen/go-bindata/...
go-bindata assets/...

Run tests using go test. You'll need a copy of MailHog running for tests to pass. (Tests currently fail using in-memory storage, use MongoDB!)

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 for details.