1
0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 09:37:02 +00:00
James Hillyerd 6a654075ad Update README
2012-11-05 21:48:24 -08:00
2012-11-05 09:33:27 -08:00
2012-11-05 21:35:34 -08:00
2012-10-22 18:07:16 -07:00
2012-11-05 21:35:34 -08:00
2012-10-31 16:29:38 -07:00
2012-11-05 21:48:24 -08:00

Inbucket

Inbucket is an email testing service; it will accept messages for any email address and make them available to view via a web interface.

It allows web developers, software engineers and system administrators to quickly see the emailed output of ther applications. No per-account setup is required! Mailboxes are created on the fly as mail is received for them, and no password is required to browse the content of the mailboxes.

Inbucket has a built-in SMTP server and stores incoming mail as flat files on disk - no external SMTP or database daemons required.

Features

  • Receive and store SMTP & ESMTP
  • List messages in a mailbox
  • Display the text content of a particular message
  • Display the source of a message (headers + body text)
  • Display the HTML version of a message (in a new window)
  • List MIME attachments with buttons to display or download
  • Delete a message
  • Purge messages after a configurable amount of time
  • Optional load test mode; messages are never written to disk

It does not yet:

  • Display inline attachments within HTML email

Screenshots

An Email Viewing an email in Inbucket.

Metrics Watching metrics while Inbucket recieves and stores over 4,000 messages per minute.

Development Status

Inbucket is currently beta quality: it works but is not well tested.

Please check the issues list for more details.

Installation

You will need a functioning Go installation for this to work.

Grab the Inbucket source code and compile the daemon:

go get -v github.com/jhillyerd/inbucket

Edit etc/inbucket.conf and tailor to your environment. It should work on most Unix and OS X machines as is. Launch the daemon:

$GOPATH/bin/inbucket $GOPATH/src/github.com/jhillyerd/inbucket/etc/inbucket.conf

By default the SMTP server will be listening on localhost port 2500 and the web interface will be available at localhost:9000.

There are RedHat EL6 init, logrotate and httpd proxy configs provided.

About

Inbucket is written in Google Go.

Inbucket is open source software released under the MIT License. The latest version can be found at https://github.com/jhillyerd/inbucket

Description
No description provided
Readme MIT 11 MiB
Languages
Go 75.2%
Elm 18.5%
CSS 2.9%
Shell 1.4%
JavaScript 0.8%
Other 1.2%