kimsible / muletter

A minimalist NodeJS email list driven by a noSQL-JSON database Web API

muletter

A minimalist email list driven by a Web API running on a database-less Node.js app using a JSON file as data storage.

Requirements

You need a http web server or a cloud hosting to deploy muletter.

Persistent storage is obviously required to keep JSON file data integrity.

Environment variables :

KEY authorization-key
PORT optional server port
HOST optional server host
STORAGE optional server storage path

API Reference

Add email

Request	Body
POST /	email <string>

Example :

POST /
[e-mail]

[e-mail]

Remove email

Request
DELETE /:id

Example :

DELETE /ky8857XlEj1NXFHh

Export emails

Request	Headers
GET /	Authorization: Basic :key

Example :

GET /
Authorization: Basic rltZ/0p/1sdQp+P2wBd9u9iZh97bn9dg

[e-mail]
[e-mail]
[e-mail]

Export emails with IDs

Request	Headers
GET /?verbose	Authorization: Basic :key

Example :

GET /?verbose
Authorization: Basic rltZ/0p/1sdQp+P2wBd9u9iZh97bn9dg

[
  {
    "email": "[e-mail]",
    "_id": "857XlEj1N8FHhXky"
  },
  {
    "email": "[e-mail]",
    "_id": "7XlEky885j1NXFHh"
  },
  {
    "email": "[e-mail]",
    "_id": "NHhky8XF857XlEj1"
  }
]

Send letter to email list via SMTP

Request	Headers	Body
PUT /	Authorization: Basic :key	{ smtp, message, unsubscribe }

message: nodemailer email message fields https://nodemailer.com/message

smtp: nodemailer smtp connection https://nodemailer.com/smtp

unsubscribe (optionnal): unsubscribe list header mailto

Example :

PUT /
Authorization: Basic rltZ/0p/1sdQp+P2wBd9u9iZh97bn9dg

{
  "smtp": "smtps://username:[e-mail]",
  "message": {
    "from": "[e-mail]",
    "subject": "Message title",
    "text": "Plaintext version of the message",
    "html": "<p>HTML version of the message</p>"
  },
  "unsubscribe": "[e-mail]"
}

Errors

Code	Type	Description
401	Unauthorized Error	wrong API access key or bad authorization header
405	Method Not Allowed	using not allowed method HEAD, OPTIONS, PATCH ...
409	Conflict Error	invalid email
500	Internal Server Error	unexpected server error