A simple newsletter mailing list service that supports:
- Confirming subscriptions to a list via email
- This works by generating a token for an email address, sending a link with that token to that email address, then allowing subscription if the token is including in the subscription request.
- Unsubscribing from a list
- This also works via a token that the user gets in every email sent to them by the mailing list.
- Sending html emails to a mailing list with password auth
This app is not battle-tested nor meant for any application that deals with safety or money. It does make lazier vandals do a little bit of work, though.
- Fork this repo.
- Create a
.envfile containing the following variables:- STORE_PATH: that points to a JSON file that will serve as the store for the app.
- There is an example store file in [tests/fixtures/test-store-a-initial-state.json].
- SENDER_PASSWORD: The password you require a sender to the list to use.
- SERVER_BASE_URL: The URL that the service will run at. Examples:
https://your-domain.wot/orhttps://who.dis/franz-list. - JMAP_USERNAME: The sending email account username if you're sending mail via the Fastmail API.
- JMAP_TOKEN: Your API token, if you're sending mail via the Fastmail API.
- STORE_PATH: that points to a JSON file that will serve as the store for the app.
- Edit
start-server.jsto pass thesendMailfunction of your choosing. This repo provides a Fastmail one and sendmail one (that just shells out to the Unixsendmailcommand). If you want to create a new sender, implement asendMailfunction with this signature:function sendMailFn({ address, subject, message }, done)wheredoneis an error-first Node-style callback that takes an error as the first argument if there was a problem ornullorundefinedif there was not. - Start the service with
make run. - If using the Makefile to deploy (and you don't have to):
- Set up a
config.mkfile that defines these variables:- USER: A user on the server you're deploying to that can create directories.
- GROUP: The group that USER belongs to.
- PRIVUSER: A user with privleges to run services.
- SERVER: The server when the service will be running.
- Run
make set-up-app-dir - Run
make install-service - Run
make update-remote - Run
make check-statusto see if the service is up on the server.
- Set up a
Run tests with make test.