Skip to content

Latest commit

 

History

History
91 lines (63 loc) · 3.14 KB

README.md

File metadata and controls

91 lines (63 loc) · 3.14 KB

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).

A Go client for the REST API is available in github.com/inbucket/inbucket/pkg/rest/client - Go API docs

Read more at the Inbucket Website

Screenshot

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.

Docker

Inbucket has automated Docker Image builds via Docker Hub. The stable tag tracks our master branch (releases), latest tracks our unstable development branch.

Homebrew Tap

(currently broken, being tracked in issue #68)

Inbucket has an OS X Homebrew tap available as jhillyerd/inbucket, see the README.md there for installation instructions.

Building from Source

You will need functioning Go and Node.js installations for this to work.

git clone https://github.com/inbucket/inbucket.git
cd inbucket/ui
npm i
npm run build
cd ..
go build ./cmd/inbucket

Note: You may also use the included Makefile to build and test the Go binaries.

Inbucket reads its configuration from environment variables, but comes with built in sane defaults. It should work on most Unix and OS X machines as is. Launch the daemon:

./inbucket

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

See doc/config.md for more information on configuring Inbucket, but you will likely find the Configurator tool easier to use.

About

Inbucket is written in Go

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