1
0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 17:47:03 +00:00
Files
go-inbucket/README.md
James Hillyerd ddaeb9ee01 Update readme
2012-10-17 21:58:13 -07:00

58 lines
1.9 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.
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.
# From the base of your GOPATH...
go get github.com/robfig/revel
go get github.com/jhillyerd/inbucket
go build -o bin/revel github.com/robfig/revel/cmd
bin/revel run github.com/jhillyerd/inbucket
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/).
Inbucket's configuration can be found in the `inbucket/conf/app.conf` file.
About
-----
Inbucket is written in [Google Go][1], and utilizes the [Revel framework][2]
for its web interface.
Inbucket is open source software released under the MIT License. The latest
version can be found at [github](https://github.com/jhillyerd/inbucket).
[1]: http://golang.org/
[2]: http://robfig.github.com/revel/