mirror of
https://github.com/jhillyerd/inbucket.git
synced 2025-12-17 17:47:03 +00:00
67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
Inbucket
|
|
=============================================================================
|
|
[][Build Status]
|
|
|
|
Inbucket is an email testing service; it will accept messages for any email
|
|
address and make them available via web, REST and POP3. Once compiled,
|
|
Inbucket does not have any external dependencies (HTTP, SMTP, POP3 and storage
|
|
are all built in).
|
|
|
|
Read more at the [Inbucket Website]
|
|
|
|
|
|
|
|
## Development Status
|
|
|
|
Inbucket is currently production quality: it is being used for real work.
|
|
|
|
Please see the [Change Log] and [Issues List] for more details. If you'd like
|
|
to contribute code to the project check out [CONTRIBUTING.md].
|
|
|
|
|
|
## Homebrew Tap
|
|
|
|
(currently broken, being tracked in [issue
|
|
#68](https://github.com/jhillyerd/inbucket/issues/68))
|
|
|
|
Inbucket has an OS X [Homebrew] tap available as [jhillyerd/inbucket][Homebrew Tap],
|
|
see the `README.md` there for installation instructions.
|
|
|
|
|
|
## Building from Source
|
|
|
|
You will need a functioning [Go installation][Google Go] for this to work.
|
|
|
|
Grab the Inbucket source code and compile the daemon:
|
|
|
|
go get -v github.com/jhillyerd/inbucket/cmd/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](http://localhost:9000/).
|
|
|
|
The Inbucket website has a more complete guide to
|
|
[installing from source][From Source]
|
|
|
|
|
|
## 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
|
|
|
|
[Build Status]: https://travis-ci.org/jhillyerd/inbucket
|
|
[Change Log]: https://github.com/jhillyerd/inbucket/blob/master/CHANGELOG.md
|
|
[CONTRIBUTING.md]: https://github.com/jhillyerd/inbucket/blob/develop/CONTRIBUTING.md
|
|
[From Source]: http://www.inbucket.org/installation/from-source.html
|
|
[Google Go]: http://golang.org/
|
|
[Homebrew]: http://brew.sh/
|
|
[Homebrew Tap]: https://github.com/jhillyerd/homebrew-inbucket
|
|
[Inbucket Website]: http://www.inbucket.org/
|
|
[Issues List]: https://github.com/jhillyerd/inbucket/issues?state=open
|