mjmlhelper 2.2.6 → 2.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE.md +21 -0
  2. package/README.md +129 -122
  3. package/package.json +9 -2
package/LICENSE.md ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) David Vielhuber
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,122 +1,129 @@
1
- # 🌈 mjmlhelper 🌈
2
-
3
- mjmlhelper is a little toolbox for [mjml](https://mjml.io/) (v4.X) that...
4
-
5
- - sends mails from the command line for testing and production,
6
- - automatically inlines or uploads images for testing purposes,
7
- - converts your template to the drag&drop editors of [CleverReach](https://www.cleverreach.com) and [Mailchimp](https://mailchimp.com).
8
-
9
- it also includes a small boilerplate and some nifty updates for mjml.
10
-
11
- ## installation
12
-
13
- ```
14
- npm init -y
15
- npm install mjmlhelper
16
- ```
17
-
18
- ## setup
19
-
20
- copy out all boilerplate files:
21
-
22
- ```
23
- cp -r ./node_modules/mjmlhelper/boilerplate/. .
24
- ```
25
-
26
- run the initial setup:
27
-
28
- ```
29
- npm run setup
30
- ```
31
-
32
- then edit your smtp credentials in `mjmlhelper.json` for sending out emails:
33
-
34
- ```json
35
- {
36
- "from": "from@tld.com",
37
- "name": "Testmailer",
38
- "smtp": "your.hostname.com",
39
- "username": "your-username",
40
- "password": "your-password",
41
- "port": 465,
42
- "ssl": "tls",
43
-
44
- "to": "to@tld.com",
45
- "to": ["to@tld.com", "to2@tld.com"],
46
- "to": "list.txt",
47
-
48
- "images": false,
49
- "images": "inline",
50
- "images": "upload",
51
-
52
- "log": "log.txt",
53
- "ftp": {
54
- "host": "localhost",
55
- "port": 21,
56
- "username": "foo",
57
- "password": "bar",
58
- "path": "/path/to/folder/",
59
- "url": "https://tld.com/path/to/folder"
60
- }
61
- }
62
- ```
63
-
64
- ## usage
65
-
66
- build mjml (and watch)
67
-
68
- ```
69
- npm run watch
70
- ```
71
-
72
- build mjml
73
-
74
- ```
75
- npm run build
76
- ```
77
-
78
- send out mail
79
-
80
- ```
81
- npm run mail
82
- ```
83
-
84
- create a ready-to-import zip file for CleverReach
85
-
86
- ```
87
- npm run cleverreach
88
- ```
89
-
90
- create a ready-to-import zip file for Mailchimp
91
-
92
- ```
93
- npm run mailchimp
94
- ```
95
-
96
- ## placeholders
97
-
98
- ### auto
99
-
100
- - `%UNSUBSCRIBE%`
101
- - `%WEBVERSION%`
102
- - `%PREVIEWTEXT%`
103
-
104
- ### cleverreach
105
-
106
- - `{UNSUBSCRIBE}`
107
- - `{ONLINE_VERSION}`
108
- - `{CAMPAIGN}`
109
-
110
- ### mailchimp
111
-
112
- - `*|UNSUB|*`
113
- - `*|ARCHIVE|*`
114
- - `*|MC_PREVIEW_TEXT|*`
115
-
116
- ## notes
117
-
118
- ### mailchimp
119
-
120
- 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.
121
-
122
- images must be sized (width is crucial) exactly as mentionned in the image edit mask (Content Studio).
1
+ [![GitHub Tag](https://img.shields.io/github/v/tag/vielhuber/mjmlhelper)](https://github.com/vielhuber/mjmlhelper/tags)
2
+ [![Code Style](https://img.shields.io/badge/code_style-psr--12-ff69b4.svg)](https://www.php-fig.org/psr/psr-12/)
3
+ [![License](https://img.shields.io/github/license/vielhuber/mjmlhelper)](https://github.com/vielhuber/mjmlhelper/blob/main/LICENSE.md)
4
+ [![Last Commit](https://img.shields.io/github/last-commit/vielhuber/mjmlhelper)](https://github.com/vielhuber/mjmlhelper/commits)
5
+ [![node version](https://img.shields.io/node/v/mjmlhelper)](https://www.npmjs.com/package/mjmlhelper)
6
+ [![npm Downloads](https://img.shields.io/npm/dt/mjmlhelper)](https://www.npmjs.com/package/mjmlhelper)
7
+
8
+ # 🌈 mjmlhelper 🌈
9
+
10
+ mjmlhelper is a little toolbox for [mjml](https://mjml.io/) (v4.X) that...
11
+
12
+ - sends mails from the command line for testing and production,
13
+ - automatically inlines or uploads images for testing purposes,
14
+ - converts your template to the drag&drop editors of [CleverReach](https://www.cleverreach.com) and [Mailchimp](https://mailchimp.com).
15
+
16
+ it also includes a small boilerplate and some nifty updates for mjml.
17
+
18
+ ## installation
19
+
20
+ ```
21
+ npm init -y
22
+ npm install mjmlhelper
23
+ ```
24
+
25
+ ## setup
26
+
27
+ copy out all boilerplate files:
28
+
29
+ ```
30
+ cp -r ./node_modules/mjmlhelper/boilerplate/. .
31
+ ```
32
+
33
+ run the initial setup:
34
+
35
+ ```
36
+ npm run setup
37
+ ```
38
+
39
+ then edit your smtp credentials in `mjmlhelper.json` for sending out emails:
40
+
41
+ ```json
42
+ {
43
+ "from": "from@tld.com",
44
+ "name": "Testmailer",
45
+ "smtp": "your.hostname.com",
46
+ "username": "your-username",
47
+ "password": "your-password",
48
+ "port": 465,
49
+ "ssl": "tls",
50
+
51
+ "to": "to@tld.com",
52
+ "to": ["to@tld.com", "to2@tld.com"],
53
+ "to": "list.txt",
54
+
55
+ "images": false,
56
+ "images": "inline",
57
+ "images": "upload",
58
+
59
+ "log": "log.txt",
60
+ "ftp": {
61
+ "host": "localhost",
62
+ "port": 21,
63
+ "username": "foo",
64
+ "password": "bar",
65
+ "path": "/path/to/folder/",
66
+ "url": "https://tld.com/path/to/folder"
67
+ }
68
+ }
69
+ ```
70
+
71
+ ## usage
72
+
73
+ build mjml (and watch)
74
+
75
+ ```
76
+ npm run watch
77
+ ```
78
+
79
+ build mjml
80
+
81
+ ```
82
+ npm run build
83
+ ```
84
+
85
+ send out mail
86
+
87
+ ```
88
+ npm run mail
89
+ ```
90
+
91
+ create a ready-to-import zip file for CleverReach
92
+
93
+ ```
94
+ npm run cleverreach
95
+ ```
96
+
97
+ create a ready-to-import zip file for Mailchimp
98
+
99
+ ```
100
+ npm run mailchimp
101
+ ```
102
+
103
+ ## placeholders
104
+
105
+ ### auto
106
+
107
+ - `%UNSUBSCRIBE%`
108
+ - `%WEBVERSION%`
109
+ - `%PREVIEWTEXT%`
110
+
111
+ ### cleverreach
112
+
113
+ - `{UNSUBSCRIBE}`
114
+ - `{ONLINE_VERSION}`
115
+ - `{CAMPAIGN}`
116
+
117
+ ### mailchimp
118
+
119
+ - `*|UNSUB|*`
120
+ - `*|ARCHIVE|*`
121
+ - `*|MC_PREVIEW_TEXT|*`
122
+
123
+ ## notes
124
+
125
+ ### mailchimp
126
+
127
+ 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.
128
+
129
+ images must be sized (width is crucial) exactly as mentionned in the image edit mask (Content Studio).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mjmlhelper",
3
- "version": "2.2.6",
3
+ "version": "2.2.7",
4
4
  "description": "",
5
5
  "main": "mjmlhelper.js",
6
6
  "dependencies": {
@@ -22,5 +22,12 @@
22
22
  },
23
23
  "keywords": [],
24
24
  "author": "David Vielhuber <david@vielhuber.de>",
25
- "license": "ISC"
25
+ "license": "MIT",
26
+ "repository": {
27
+ "type": "git",
28
+ "url": "git+ssh://git@github.com/vielhuber/mjmlhelper.git"
29
+ },
30
+ "engines": {
31
+ "node": ">=18"
32
+ }
26
33
  }