You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
James Hillyerd cb6f99c487 Merge branch 'release/3.0.0' 2 weeks ago
.github/workflows Bump Go to 1.17 (#233) 1 month ago
cmd Add configurable base path for reverse proxy use (#169) 1 year ago
doc Add configurable base path for reverse proxy use (#169) 1 year ago
etc Add configurable base path for reverse proxy use (#169) 1 year ago
pkg smtp: allow empty user & pass during AUTH LOGIN (#225) 2 months ago
ui Update npm deps (#235) 1 month ago
.dockerignore Update backend and docker dependencies (#173) 1 year ago
.gitattributes Line ending normalization 8 years ago
.gitignore Set base path in index.html (#172) 1 year ago
.goreleaser.yml goreleaser: update nfpm config to use contents attrib (#220) 3 months ago
CHANGELOG.md Update CHANGELOG for final 3.0.0 1 month ago
CONTRIBUTING.md Add tl;dr to CONTRIBUTING.md 3 years ago
Dockerfile Bump Go to 1.17 (#233) 1 month ago
LICENSE Add some text to readme and the MIT license. 9 years ago
Makefile docker: Default to JSON log output for #90 3 years ago
README.md Readme updates (#183) 1 year ago
go.mod Update Go dependencies, incl enmime (#234) 1 month ago
go.sum Update Go dependencies, incl enmime (#234) 1 month ago
shell.nix nix: add elm-json for updating pkgs 5 months ago

README.md

Inbucket

Build Status Docker Image

Inbucket is an email testing service; it will accept messages for any email address and make them available via web, REST and POP3 interfaces. 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.

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 ci
npm run build
cd ..
go build ./cmd/inbucket

For more information on building and development flows, check out the Development Quickstart page of our wiki.

Configure and Launch

Inbucket reads its configuration from environment variables, but comes with reasonable defaults built-in. 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 the easiest way to generate a configuration.

About

Inbucket is written in Go and Elm.

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