Mirrors/go-inbucket
1
0
Fork 0
mirror of https://github.com/jhillyerd/inbucket.git synced 2025-12-17 17:47:03 +00:00
Code Issues Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
James Hillyerd
2012-11-05 21:48:24 -08:00
parent 1da98a9f7e
commit 6a654075ad
1 changed files with 22 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -12,32 +12,36 @@ 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 Inbucket has a built-in SMTP server and stores incoming mail as flat files on
disk - no external SMTP or database daemons required. 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 Screenshots
----------- -----------
![An Email](http://cloud.github.com/downloads/jhillyerd/inbucket/inbucket-ss1.png) ![An Email](http://cloud.github.com/downloads/jhillyerd/inbucket/inbucket-ss1.png)
*Viewing an email in Inbucket.* *Viewing an email in Inbucket.*
![Metrics](http://cloud.github.com/downloads/jhillyerd/inbucket/inbucket-ss2.png) ![Metrics](http://cloud.github.com/downloads/jhillyerd/inbucket/inbucket-ss2.png)
*Watching metrics while Inbucket handles over 4,000 messages per minute.* *Watching metrics while Inbucket recieves and stores over 4,000 messages per minute.*
Development Status Development Status
------------------ ------------------
Inbucket is currently alpha quality: it works but is not well tested. Inbucket is currently beta quality: it works but is not well tested.
It can: Please check the [issues list](https://github.com/jhillyerd/inbucket/issues?state=open)
for more details.
* 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
* Purge messages after a configurable amount of time
It does not yet:
* Display or download attachments
Installation Installation
------------ ------------
@@ -55,6 +59,8 @@ Unix and OS X machines as is. Launch the daemon:
By default the SMTP server will be listening on localhost port 2500 and 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/). the web interface will be available at [localhost:9000](http://localhost:9000/).
There are RedHat EL6 init, logrotate and httpd proxy configs provided.
About About
----- -----
Inbucket is written in [Google Go][1]. Inbucket is written in [Google Go][1].