Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/inbucket/inbucket

Disposable webmail server (similar to Mailinator) with built in SMTP, POP3, RESTful servers; no DB required.
https://github.com/inbucket/inbucket

go golang integration-testing linux mail mailserver osx pop pop3 smtp smtp-server webmail windows

Last synced: 1 day ago
JSON representation

Disposable webmail server (similar to Mailinator) with built in SMTP, POP3, RESTful servers; no DB required.

Awesome Lists containing this project

README 

        
![Build Status](https://github.com/inbucket/inbucket/actions/workflows/build-and-test.yml/badge.svg)

![Docker Image](https://github.com/inbucket/inbucket/actions/workflows/docker-build.yml/badge.svg)



# Inbucket



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](http://www.inbucket.org/images/inbucket-ss1.png "Viewing a message")



## 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 `latest` tag

tracks our tagged releases, and `edge` tracks our potentially unstable

`main` branch.



## Building from Source



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



```sh

git clone https://github.com/inbucket/inbucket.git

cd inbucket/ui

yarn install

yarn 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:



```sh

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



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



[Build Status]:           https://travis-ci.org/inbucket/inbucket

[Change Log]:             https://github.com/inbucket/inbucket/blob/main/CHANGELOG.md

[config.md]:              https://github.com/inbucket/inbucket/blob/main/doc/config.md

[Configurator]:           https://www.inbucket.org/configurator/

[CONTRIBUTING.md]:        https://github.com/inbucket/inbucket/blob/main/CONTRIBUTING.md

[Development Quickstart]: https://github.com/inbucket/inbucket/wiki/Development-Quickstart

[Docker Image]:           https://inbucket.org/packages/docker.html

[Elm]:                    https://elm-lang.org/

[From Source]:            https://www.inbucket.org/installation/from-source.html

[Go]:                     https://golang.org/

[Go API docs]:            https://pkg.go.dev/github.com/inbucket/inbucket/pkg/rest/client

[Homebrew]:               http://brew.sh/

[Homebrew Tap]:           https://github.com/inbucket/homebrew-inbucket

[Inbucket Website]:       https://www.inbucket.org/

[Issues List]:            https://github.com/inbucket/inbucket/issues?state=open

[Node.js]:                https://nodejs.org/en/