ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-23 14:24:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Web and API based SMTP testing
257 commits 1 branch 0 tags 3 MiB
Go 68.6%
Makefile 19.7%
Dockerfile 11.7%
Find a file
Ian Kent 5c4899c652
fix build issue
2017-04-16 23:41:32 +01:00
config fix typo 2016-03-13 17:58:18 +00:00
docs Update DEPLOY.md 2017-03-14 19:12:08 +08:00
vendor fix build issue 2017-04-16 23:41:32 +01:00
.dockerignore Optimise the Dockerfile for Docker Hub Automated Builds. 2016-10-23 12:42:22 +02:00
.gitignore Add gitignore and ignore build folder. 2016-11-08 14:32:39 +01:00
.travis.yml remove 1.4/1.5 from .travis.yml 2016-08-10 08:44:35 +01:00
Dockerfile Optimise the Dockerfile for Docker Hub Automated Builds. 2016-10-23 12:42:22 +02:00
LICENSE.md update year 2016-03-13 19:49:18 +00:00
main.go Add version flag which displays the current version. 2016-11-08 14:28:15 +01:00
Makefile update vendored deps and clean up makefile 2017-04-16 19:47:34 +01:00
README.md add libraries doc for #120 2016-11-14 22:53:35 +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

See MailHog libraries for a list of MailHog client libraries.

  • 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
  • HTTP basic authentication for MailHog UI and API
  • Multipart MIME support
  • Download individual MIME parts
  • In-memory message storage
  • MongoDB and file based storage for message persistence
  • Lightweight and portable
  • No installation required

sendmail

mhsendmail is a sendmail replacement for MailHog.

It redirects mail to MailHog using SMTP.

You can also use MailHog sendmail ... instead of the separate mhsendmail binary.

Web UI

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.4+ 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 - 2016, Ian Kent (http://iankent.uk)

Released under MIT license, see LICENSE for details.