Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JustComments/newsletter-cli
Write newsletters in Markdown and send to many recipients from your machine using AWS SES
https://github.com/JustComments/newsletter-cli
Last synced: 3 months ago
JSON representation
Write newsletters in Markdown and send to many recipients from your machine using AWS SES
- Host: GitHub
- URL: https://github.com/JustComments/newsletter-cli
- Owner: JustComments
- License: mit
- Created: 2018-11-23T20:56:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:00:38.000Z (almost 2 years ago)
- Last Synced: 2024-04-27T22:34:07.908Z (7 months ago)
- Language: TypeScript
- Size: 1000 KB
- Stars: 90
- Watchers: 4
- Forks: 6
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
newsletter-cli
Write newsletters in Markdown and send to many recipients from your machine using AWS SES.
## Features
✍️ **Markdown** for writing the content
🌈 **Styling** using CSS (automatically *inlined*)
📨 **Send** using AWS SES respecting rate limits
## Prerequisites
Prepare your AWS SES account and configure access to AWS on your machine:
- https://docs.aws.amazon.com/ses/latest/DeveloperGuide/sign-up-for-aws.html
- https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html
## Getting Started
```sh
npm i newsletter-cli -g
```
- Step 1: Run `newsletter prepare` to get started. Follow the command's instructions.
- Step 2: Run `newsletter edit ` to open the prepared markdown file for the newsletter using an editor. Write your newsletter!
- Step 3: Run `newsletter preview ` to preview the resulting HTML of your newsletter in a web-browser.
- Step 4: Run `newsletter send ` to send the newsletter in bulks respecting the send rate of AWS SES.
## Parameters
- `` is the internal name for your newsletter (alphanumerical characters and `-`, `_` only).
The newsletter name defines the name of the local file where the newsletter source is stored.
is stored as .md
- `` is the path to a file containing recipients of the newsletter.
The file must be comma-separated (,) and must contain column headers in the first row.
The column named 'email' must be present in the file
- `` is the email address which will appear as the sender of the newsletter.
## Using variables in the template
You can use variables in the templates as supported by [AWS SES](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html). The variables can be used in the subject and inside the body:
```
---
subject: Hi {{name}}! Subject of your awesome newsletter!
---
Hi {{name}}!
Here goes the text of your awesome newsletter!
```
In the snippet above, the `name` column is required for all recipients in the CSV file.
Unfortunately, if the template rendering fails, AWS SES does not return an error. To detect rendering errors, you will need to subscribe to build an async recovery mechanism as described [here](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html).
The reasons why template rendering can fail:
- missing variables
- typos in variable names
- invalid template expressions
The CLI tries to validate as much as possible but it's still recommended to set up a recovery mechanism for the rendering failures.
## User configuration file
An optional user configuration file can be placed at `${HOME}/.newsletter-cli/config.js`, which allows certain customizations. The [sample user configuration](user-config.sample.js) is commented with the possible customizations.
## Get Help
[Open an issue](https://github.com/orkon/newsletter-cli/issues)