ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-27 08:14:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Web and API based SMTP testing
180 commits 1 branch 0 tags 3 MiB
Go 68.6%
Makefile 19.7%
Dockerfile 11.7%
Find a file
Ian Kent 861f70329d Fix #29 - add more descriptive overview to readme
2015-02-24 23:06:00 +00:00
docs API v2 search and message list documentation for #36 2015-02-24 22:44:34 +00:00
.travis.yml Update .travis.yml - remove go 1.2, add go 1.4 2015-01-08 22:10:28 +00:00
Dockerfile Dockerfile with golang:1.4 2014-12-30 22:18:40 +01:00
LICENSE.md Change release output path, add missing LICENSE file 2014-10-29 18:55:17 +00:00
main.go Add APIv2 (and update download badge) 2014-12-27 13:53:31 +00:00
Makefile Makefile fix 2015-01-04 13:01:50 +00:00
README.md Fix #29 - add more descriptive overview to readme 2015-02-24 23:06:00 +00:00

README.md

MailHog Download GoDoc Build Status

Inspired by MailCatcher, easier to install.

  • Download and run MailHog
  • Configure your outgoing SMTP server
  • View your outgoing email in a web UI
  • Release it to a real mail server

Built with Go - MailHog runs without installation on multiple platforms.

Overview

MailHog is an email testing tool for developers:

  • Configure your application to use MailHog for SMTP delivery
  • View messages in the web UI, or retrieve them with the JSON API
  • Optionally release messages to real SMTP servers for delivery

Getting started

  1. Either:
  1. Configure MailHog, or use the default settings:
  • the SMTP server starts on port 1025
  • the HTTP server starts on port 8025
  • in-memory message storage

Features

  • ESMTP server implementing RFC5321
  • Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
  • Web interface to view messages (plain text, HTML or source)
    • Supports RFC2047 encoded headers
  • Real-time updates using EventSource
  • Release messages to real SMTP servers
  • Chaos Monkey for failure testing
  • HTTP API to list, retrieve and delete messages
    • See APIv1 and APIv2 documentation for more information
  • 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

Contributing

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

Clone this repository to $GOPATH/src/github.com/mailhog/MailHog and type make deps.

See the Building MailHog guide.

Requires Go 1.3+ to build.

Run tests using make test or goconvey.

If you make any changes, run go fmt ./... before submitting a pull request.

Licence

Copyright ©‎ 2014-2015, Ian Kent (http://iankent.uk)

Released under MIT license, see LICENSE for details.