Skip to content

Deploy your own free, open-source email service with a single click. Connect seamlessly with Gmail or Amazon SES for secure and customizable email management. Take control of your communication with ease.

License

Notifications You must be signed in to change notification settings

stormkit-io/mailer

Repository files navigation

Stormkit Mailer (under active development)

Send automated emails, or launch campaigns through a simple API or an intuitive UI.

Live Demo

Visit https://mailer-demo.stormkit.dev.

  • Username: root
  • Password: 123456

It's a limited, read-only version.

Features

☑️  SES Mailer: Send emails through your own Amazon SES account.

✅  SMTP: Send emails through SMTP, such as your own Gmail account.

☑️  Gmail API Send emails through Gmail API.

✅  Minimal UI: Simple, intuitive UI to configure your templates

☑️  Subscribers: Upload your subscribers either through API or manually

☑️  Unsubscribe: Users can unsubscribe

☑️  API: Send emails to your users through a simple API

✅  Free Forever: Using Stormkit Mailer is free of charge

Legend

✅ Ready to use

☑️ Incomplete or not yet started

Configuration

The Mailer is configured through environment variables. You can configure these variables either by providing an .env file or by making these variables available to your process.

Variable Description
ADMIN_USERNAME The user name that is used to login the Mailer app.
ADMIN_PASSWORD The password that is used to login the Mailer app.
SMTP_USERNAME The user name that is used to login your SMTP provider.
SMTP_PASSWORD The password that is used to login your SMTP provider.
JWT_SECRET A random string that is used to encrypt your JWT tokens.
MAILER_FROM_ADDR The address that will be used to send emails.

Note that some of these variables will be moved to the configuration page once the page is implemented. See #2 for more details.

Local development

See Docker for containarized environments.

$ git clone git@github.com:stormkit-io/mailer.git
$ cd mailer
$ npm install
$ npm run dev

Create an .env file on the root level of the repository and configure the environment variables mentioned in the Configuration section.

✅ HMR enabled

✅ To force restarting the server, type rs and hit Enter on the terminal

Docker

$ docker build -t mailer .
$ docker run -t mailer

Currently, the container does not stop when a Stop Signal is sent. See #12 for more context.

To stop the container, you can execute:

$ docker stop $(docker ps -q --filter ancestor=mailer)

License

MIT

About

Deploy your own free, open-source email service with a single click. Connect seamlessly with Gmail or Amazon SES for secure and customizable email management. Take control of your communication with ease.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages