🌈 mjmlhelper 🌈

mjmlhelper is a little toolbox for mjml (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 and Mailchimp.

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:

{
    "from": "from@tld.com",
    "name": "Testmailer",
    "smtp": "your.hostname.com",
    "username": "your-username",
    "password": "your-password",
    "port": 465,
    "ssl": "tls",

    "to": "to@tld.com",
    "to": ["to@tld.com", "to2@tld.com"],
    "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).