Skip to content

uilicious/inboxkitten

Repository files navigation

inboxkitten header

Open-Source Disposable Email - Served by Serverless Kittens

Build Status

Inboxkitten is an open-source disposable email service that you can freely deploy adopt on your own!

Visit our site to give a spin, or ...

Docker Deployment Guide

Its one simple line - to use our prebuilt docker container.

Note you will need to setup your mailgun account first

# PS: you should modify this for your use case
docker run \
	-e MAILGUN_EMAIL_DOMAIN="<email-domain>" \
	-e MAILGUN_API_KEY="<api-key>" \
	-e WEBSITE_DOMAIN="localhost:8000" \
	-p 8000:8000 \
	uilicious/inboxkitten

And head over to port 8000 - for your inboxkitten

Other Deployment Options

Support us on product hunt 🚀

Somewhat related blog / articles

Other References

Looking for sponsor

Note: Due to this project rather heavy traffic usage, a good half sadly spam/bot related, we are looking for a hosting sponsor / sponsor to subsidise running cost


How to Setup Mailgun - and get your free API key

Mailgun

To sign up for a Mailgun account, go to the signup page.

2021 Udpate: Inbound routing for mailgun, now requires any paid account (starting at $35/month) see : https://www.mailgun.com/pricing/

Custom Domain

	1. Click on `Add New Domain` button under your Domains panel. 
	2. Follow the steps accordingly

You can use the default domain that was provided by Mailgun if you do not have your own domain.

Routes Configuration

After setting up your domain, in order for you to receive email, you have to configure the routes. Routes act as rules that will filter through all the incoming mails and execute actions on matched conditions.

In your Routes panel, simply click on Create Route button and follow the steps accordingly.

Mailgun Route

The above route will match all names ending with @inboxkitten.com, store them in the storage that mailgun provides (only for 3 days) and stop processing any other rules once this route is matched.

Mailgun API Key

You can locate your Mailgun API key by clicking on the domain that you are managing. In it you can see your API key.

Mailgun API key

Or you can go to the security settings and locate the API key there.

Mailgun API key