Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vielhuber/mjmlhelper
🌈 Lil' toolbox for mjml (send mails, CleverReach). 🌈
https://github.com/vielhuber/mjmlhelper
mjml
Last synced: 19 days ago
JSON representation
🌈 Lil' toolbox for mjml (send mails, CleverReach). 🌈
- Host: GitHub
- URL: https://github.com/vielhuber/mjmlhelper
- Owner: vielhuber
- Created: 2017-10-23T20:32:23.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-12T07:21:49.000Z (about 1 year ago)
- Last Synced: 2023-10-13T00:01:29.989Z (about 1 year ago)
- Topics: mjml
- Language: HTML
- Homepage:
- Size: 235 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌈 mjmlhelper 🌈
mjmlhelper is a little toolbox for [mjml](https://mjml.io/) (v4.X) that...
- sends mails from the command line for testing and production,
- automatically inlines or uploads images for testing purposes,
- converts your template to the drag&drop editors of [CleverReach](https://www.cleverreach.com) and [Mailchimp](https://mailchimp.com).
it also includes a small boilerplate and some nifty updates for mjml.
## installation
```
npm init -y
npm install mjmlhelper
```
## setup
copy out all boilerplate files:
```
cp -r ./node_modules/mjmlhelper/boilerplate/. .
```
run the initial setup:
```
npm run setup
```
then edit your smtp credentials in `mjmlhelper.json` for sending out emails:
```json
{
"from": "[email protected]",
"name": "Testmailer",
"smtp": "your.hostname.com",
"username": "your-username",
"password": "your-password",
"port": 465,
"ssl": "tls",
"to": "[email protected]",
"to": ["[email protected]", "[email protected]"],
"to": "list.txt",
"images": false,
"images": "inline",
"images": "upload",
"log": "log.txt",
"ftp": {
"host": "localhost",
"port": 21,
"username": "foo",
"password": "bar",
"path": "/path/to/folder/",
"url": "https://tld.com/path/to/folder"
}
}
```
## usage
build mjml (and watch)
```
npm run watch
```
build mjml
```
npm run build
```
send out mail
```
npm run mail
```
create a ready-to-import zip file for CleverReach
```
npm run cleverreach
```
create a ready-to-import zip file for Mailchimp
```
npm run mailchimp
```
## placeholders
### auto
- `%UNSUBSCRIBE%`
- `%WEBVERSION%`
- `%PREVIEWTEXT%`
### cleverreach
- `{UNSUBSCRIBE}`
- `{ONLINE_VERSION}`
- `{CAMPAIGN}`
### mailchimp
- `*|UNSUB|*`
- `*|ARCHIVE|*`
- `*|MC_PREVIEW_TEXT|*`
## notes
### mailchimp
creating mailchimp emails in their classic editor can be a bit tedious. a first block is created by default and you can only create more blocks by duplicating the first one and choosing any other variant. if there is only one block left, it cannot be deleted.
images must be sized (width is crucial) exactly as mentionned in the image edit mask (Content Studio).