ric/MailHog
1
0
Fork 0
mirror of https://gitlab.com/ric_harvey/MailHog.git synced 2024-11-30 09:44:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme and screenshot

Browse source
This commit is contained in:
Ian Kent 2014-04-24 19:58:34 +01:00
parent 7e467afbe6
commit c9d12d1fee
2 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -10,7 +10,6 @@ Go was chosen for portability - MailHog runs without installation on multiple pl
### Requirements ### Requirements
* None! * None!
* Well, you need MongoDB installed somewhere
### Getting started ### Getting started
@ -23,8 +22,11 @@ server will start on port 8025.
### Features ### Features
* ESMTP server implementing RFC5321 * ESMTP server implementing RFC5321
* Web interface to view messages * Support for SMTP AUTH (RFC4954) and PIPELINING (RFC2920)
* API interface to list, retrieve and delete messages * Web interface to view messages (plain text, HTML or source)
* HTTP API to list, retrieve and delete messages
* Multipart MIME support
* In-memory message storage
* MongoDB storage for message persistence * MongoDB storage for message persistence
* Lightweight and portable * Lightweight and portable
* No installation required * No installation required
@ -43,12 +45,14 @@ You can configure Go-MailHog using command line options:
| -mongodb | mailhog | MongoDB database name for message storage | -mongodb | mailhog | MongoDB database name for message storage
| -mongouri | 127.0.0.1:27017 | MongoDB host and port | -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 | -smtpbindaddr | 0.0.0.0:1025 | Interface and port for SMTP server to bind to
| -storage | memory | Set message storage: memory / mongodb
### Contributing ### Contributing
Clone this repository to ```$GOPATH/src/github.com/ian-kent/MailHog``` and type ```go install```. Clone this repository to ```$GOPATH/src/github.com/ian-kent/MailHog``` and type ```go install```.
Run tests using ```go test```. You'll need a copy of MailHog running for tests to pass. 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. If you make any changes, run ```go fmt``` before submitting a pull request.

BIN
images/MailHog.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 94 KiB