1
0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 09:37:02 +00:00
Files
go-inbucket/README.md
James Hillyerd 01955d3cb2 Moved inbucketd to main to make building easier
Updated README.md with a install procedure that actually works
2012-10-21 14:47:41 -07:00

67 lines
2.1 KiB
Markdown

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.
Screenshots
-----------
![Screenshot 1](http://cloud.github.com/downloads/jhillyerd/inbucket/inbucket-ss1.png)
Development Status
------------------
Inbucket is currently alpha quality: it works but is not well tested.
It can:
* Receive SMTP and ESMTP messages and store them to disk
* List subject, sender and date of messages for a particular mailbox
* Parse MIME multipart emails
* Display the 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)
* Delete a message
It does not yet:
* Display or download attachments
Installation
------------
You will need a functioning [Go installation][1] for this to work.
Grab the Inbucket source code and compile the daemon:
go get -v github.com/jhillyerd/inbucket
go get -v github.com/gorilla/mux
go get -v github.com/gorilla/sessions
go get -v thegoods.biz/httpbuf
cd $GOPATH/src/github.com/jhillyerd/inbucket
go build main/inbucketd.go
Edit conf/inbucket.conf and tailor to your environment. It should work on most
Unix and OS X machines as is.
./inbucketd conf/inbucket.conf
By default the SMTP server will be listening on localhost port 2500 and
the web interface will be available at [localhost:9000](http://localhost:9000/).
About
-----
Inbucket is written in [Google Go][1].
Inbucket is open source software released under the MIT License. The latest
version can be found at https://github.com/jhillyerd/inbucket
[1]: http://golang.org/
[2]: http://robfig.github.com/revel/