Skip to content

Commit 8b2a2dd

Browse files
knadhknadh
committed
Add MJML templating support to campaigns.
1 parent 19b53d8 commit 8b2a2dd

11 files changed

Lines changed: 135 additions & 10 deletions

File tree

‎cmd/campaigns.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,8 @@ func (a *App) validateCampaignFields(c campReq) (campReq, error) {
669669
c.ContentType != models.CampaignContentTypeHTML &&
670670
c.ContentType != models.CampaignContentTypePlain &&
671671
c.ContentType != models.CampaignContentTypeVisual &&
672-
c.ContentType != models.CampaignContentTypeMarkdown {
672+
c.ContentType != models.CampaignContentTypeMarkdown &&
673+
c.ContentType != models.CampaignContentTypeMJML {
673674
c.ContentType = models.CampaignContentTypeRichtext
674675
}
675676

‎cmd/install.go‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,15 @@ func installTemplates(q *models.Queries) (int, int) {
237237
lo.Fatalf("error creating default campaign template: %v", err)
238238
}
239239

240+
// Insert MLML template.
241+
tpl, err := fs.Get("/static/email-templates/sample-mjml.tpl")
242+
if err != nil {
243+
lo.Fatalf("error reading sample mjml template: %v", err)
244+
}
245+
if _, err := q.CreateTemplate.Exec("Sample MJML template", models.TemplateTypeCampaign, "", tpl.ReadBytes(), nil); err != nil {
246+
lo.Fatalf("error creating mjml campaign template: %v", err)
247+
}
248+
240249
return campTplID, archiveTplID
241250
}
242251

‎frontend/src/components/CodeEditor.vue‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ export default {
5050
case 'html':
5151
langs = [html()];
5252
break;
53+
case 'mjml':
54+
langs = [html()];
55+
break;
5356
case 'css':
5457
langs = [css()];
5558
break;

‎frontend/src/components/Editor.vue‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@
6767
<!-- raw html editor //-->
6868
<code-editor lang="html" v-if="self.contentType === 'html'" v-model="self.body" key="editor-html" />
6969

70+
<!-- mjml editor //-->
71+
<code-editor lang="mjml" v-if="self.contentType === 'mjml'" v-model="self.body" key="editor-mjml" />
72+
7073
<!-- markdown editor //-->
7174
<code-editor lang="markdown" v-if="self.contentType === 'markdown'" v-model="self.body" key="editor-markdown" />
7275

@@ -162,7 +165,7 @@ export default {
162165
163166
// If `from` is HTML content, strip out `<body>..` etc. and keep the beautified HTML.
164167
let isHTML = false;
165-
if (from === 'richtext' || from === 'html' || from === 'visual') {
168+
if (from === 'richtext' || from === 'html' || from === 'visual' || from === 'mjml') {
166169
const d = document.createElement('div');
167170
d.innerHTML = body;
168171
body = this.beautifyHTML(d.innerHTML.trim());
@@ -198,7 +201,7 @@ export default {
198201
}
199202
200203
// Markdown to HTML requires a backend call.
201-
} else if (from === 'markdown' && (to === 'richtext' || to === 'html')) {
204+
} else if (from === 'markdown' && (to === 'richtext' || to === 'html' || to === 'mjml')) {
202205
skip = true;
203206
this.$api.convertCampaignContent({
204207
id: 1, body, from, to,
@@ -212,8 +215,21 @@ export default {
212215
});
213216
214217
// Plain to an HTML type, change plain line breaks to HTML breaks.
215-
} else if (from === 'plain' && (to === 'richtext' || to === 'html')) {
218+
} else if (from === 'plain' && (to === 'richtext' || to === 'html' || to === 'mjml')) {
216219
body = body.replace(/\n/ig, '<br>\n');
220+
} else if (from === 'mjml' && (to === 'richtext' || to === 'html')) {
221+
// MJML to HTML requires a backend call.
222+
skip = true;
223+
this.$api.convertCampaignContent({
224+
id: 1, body, from, to,
225+
}).then((data) => {
226+
this.$nextTick(() => {
227+
// Both type + body should be updated in one cycle to avoid firing
228+
// multiple events.
229+
this.self.contentType = to;
230+
this.self.body = this.beautifyHTML(data.trim());
231+
});
232+
});
217233
} else if (to === 'visual') {
218234
bodySource = JSON.stringify(markdownToVisualBlock(body));
219235
}

‎frontend/src/views/Campaign.vue‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,7 @@ export default Vue.extend({
349349
markdown: this.$t('campaigns.markdown'),
350350
plain: this.$t('campaigns.plainText'),
351351
visual: this.$t('campaigns.visual'),
352+
mjml: 'MJML',
352353
}),
353354
354355
isNew: false,

‎go.mod‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module github.com/knadh/listmonk
22

3-
go 1.24.1
3+
go 1.24.4
44

55
require (
66
github.com/Masterminds/sprig/v3 v3.3.0
@@ -30,6 +30,7 @@ require (
3030
github.com/lib/pq v1.10.9
3131
github.com/paulbellamy/ratecounter v0.2.0
3232
github.com/pquerna/otp v1.5.0
33+
github.com/preslavrachev/gomjml v0.10.0
3334
github.com/rhnvrm/simples3 v0.9.1
3435
github.com/spf13/pflag v1.0.6
3536
github.com/yuin/goldmark v1.7.12

‎go.sum‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,12 @@ github.com/Masterminds/semver/v3 v3.4.0 h1:Zog+i5UMtVoCU8oKka5P7i9q9HgrJeGzI9SA1
88
github.com/Masterminds/semver/v3 v3.4.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
99
github.com/Masterminds/sprig/v3 v3.3.0 h1:mQh0Yrg1XPo6vjYXgtf5OtijNAKJRNcTdOOGZe3tPhs=
1010
github.com/Masterminds/sprig/v3 v3.3.0/go.mod h1:Zy1iXRYNqNLUolqCpL4uhk6SHUMAOSCzdgBfDb35Lz0=
11+
github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo=
12+
github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y=
1113
github.com/altcha-org/altcha-lib-go v1.0.0 h1:7oPti0aUS+YCep8nwt5b9g4jYfCU55ZruWESL8G9K5M=
1214
github.com/altcha-org/altcha-lib-go v1.0.0/go.mod h1:I8ESLVWR9C58uvGufB/AJDPhaSU4+4Oh3DLpVtgwDAk=
15+
github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM=
16+
github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA=
1317
github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc h1:biVzkmvwrH8WK8raXaxBx6fRVTlJILwEwQGL1I/ByEI=
1418
github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8=
1519
github.com/coreos/go-oidc/v3 v3.14.1 h1:9ePWwfdwC4QKRlCXsJGou56adA/owXczOzwKdOumLqk=
@@ -110,6 +114,10 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
110114
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
111115
github.com/pquerna/otp v1.5.0 h1:NMMR+WrmaqXU4EzdGJEE1aUUI0AMRzsp96fFFWNPwxs=
112116
github.com/pquerna/otp v1.5.0/go.mod h1:dkJfzwRKNiegxyNb54X/3fLwhCynbMspSyWKnvi1AEg=
117+
github.com/preslavrachev/gomjml v0.5.0 h1:Ca6OxHx7AAK1R3KHx6aRBU6zTex/kezWIp7Z14GrUQM=
118+
github.com/preslavrachev/gomjml v0.5.0/go.mod h1:10tpMJhl+46mqf+5wG18fOXaWNB+OOllCpksDRJlJTU=
119+
github.com/preslavrachev/gomjml v0.10.0 h1:GdcLph92E3aADmBgR6DnDS7NsnK1DsHeYWmDhZGrJEA=
120+
github.com/preslavrachev/gomjml v0.10.0/go.mod h1:10tpMJhl+46mqf+5wG18fOXaWNB+OOllCpksDRJlJTU=
113121
github.com/rhnvrm/simples3 v0.9.1 h1:pYfEe2wTjx8B2zFzUdy4kZn3I3Otd9ZvzIhHkFR85kE=
114122
github.com/rhnvrm/simples3 v0.9.1/go.mod h1:Y+3vYm2V7Y4VijFoJHHTrja6OgPrJ2cBti8dPGkC3sA=
115123
github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=

‎internal/migrations/v6.1.0.go‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,24 @@ func V6_1_0(db *sqlx.DB, fs stuffbin.FileSystem, ko *koanf.Koanf, lo *log.Logger
1212
_, err := db.Exec(`
1313
INSERT INTO settings (key, value, updated_at) VALUES ('privacy.disable_tracking', 'false', NOW()) ON CONFLICT (key) DO NOTHING
1414
`)
15-
return err
15+
if err != nil {
16+
return err
17+
}
18+
19+
// Add MJML to content_type enum if not exists.
20+
if _, err := db.Exec(`ALTER TYPE content_type ADD VALUE IF NOT EXISTS 'mjml';`); err != nil {
21+
return err
22+
}
23+
24+
// Insert sample MJML template.
25+
tpl, err := fs.Get("/static/email-templates/sample-mjml.tpl")
26+
if err != nil {
27+
return err
28+
}
29+
if _, err := db.Exec(`INSERT INTO templates (name, type, subject, body) VALUES($1, $2, $3, $4)`,
30+
"Sample MJML template", "campaign", "", tpl.ReadBytes()); err != nil {
31+
return err
32+
}
33+
34+
return nil
1635
}

‎models/campaigns.go‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/jmoiron/sqlx"
1313
"github.com/jmoiron/sqlx/types"
1414
"github.com/lib/pq"
15+
"github.com/preslavrachev/gomjml/mjml"
1516
null "gopkg.in/volatiletech/null.v6"
1617
)
1718

@@ -29,6 +30,7 @@ const (
2930
CampaignContentTypeMarkdown = "markdown"
3031
CampaignContentTypePlain = "plain"
3132
CampaignContentTypeVisual = "visual"
33+
CampaignContentTypeMJML = "mjml"
3234
)
3335

3436
// Campaigns represents a slice of Campaigns.
@@ -162,19 +164,36 @@ func (c *Campaign) CompileTemplate(f template.FuncMap) error {
162164
body = r.regExp.ReplaceAllString(body, r.replace)
163165
}
164166

167+
// Parse the base template also as MJML if the campaign content type is MJML.
168+
if c.ContentType == CampaignContentTypeMJML {
169+
htmlBody, err := mjml.Render(body)
170+
if err != nil {
171+
return fmt.Errorf("error compiling MJML: %v", err)
172+
}
173+
body = htmlBody
174+
}
175+
165176
baseTPL, err := template.New(BaseTpl).Funcs(f).Parse(body)
166177
if err != nil {
167178
return fmt.Errorf("error compiling base template: %v", err)
168179
}
169180

170-
// If the format is markdown, convert Markdown to HTML.
171-
if c.ContentType == CampaignContentTypeMarkdown {
181+
// If the campaign format is markdown, convert Markdown to HTML.
182+
switch c.ContentType {
183+
case CampaignContentTypeMarkdown:
172184
var b bytes.Buffer
173185
if err := markdown.Convert([]byte(c.Body), &b); err != nil {
174186
return err
175187
}
176188
body = b.String()
177-
} else {
189+
190+
case CampaignContentTypeMJML:
191+
htmlBody, err := mjml.Render(c.Body)
192+
if err != nil {
193+
return fmt.Errorf("error compiling MJML: %v", err)
194+
}
195+
body = htmlBody
196+
default:
178197
body = c.Body
179198
}
180199

@@ -226,6 +245,13 @@ func (c *Campaign) ConvertContent(from, to string) (string, error) {
226245
return out, err
227246
}
228247
out = b.String()
248+
} else if from == CampaignContentTypeMJML &&
249+
(to == CampaignContentTypeHTML || to == CampaignContentTypeRichtext) {
250+
htmlBody, err := mjml.Render(c.Body)
251+
if err != nil {
252+
return out, fmt.Errorf("error converting MJML: %v", err)
253+
}
254+
out = htmlBody
229255
} else {
230256
return out, errors.New("unknown formats to convert")
231257
}

‎schema.sql‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ DROP TYPE IF EXISTS subscriber_status CASCADE; CREATE TYPE subscriber_status AS
55
DROP TYPE IF EXISTS subscription_status CASCADE; CREATE TYPE subscription_status AS ENUM ('unconfirmed', 'confirmed', 'unsubscribed');
66
DROP TYPE IF EXISTS campaign_status CASCADE; CREATE TYPE campaign_status AS ENUM ('draft', 'running', 'scheduled', 'paused', 'cancelled', 'finished');
77
DROP TYPE IF EXISTS campaign_type CASCADE; CREATE TYPE campaign_type AS ENUM ('regular', 'optin');
8-
DROP TYPE IF EXISTS content_type CASCADE; CREATE TYPE content_type AS ENUM ('richtext', 'html', 'plain', 'markdown', 'visual');
8+
DROP TYPE IF EXISTS content_type CASCADE; CREATE TYPE content_type AS ENUM ('richtext', 'html', 'plain', 'markdown', 'visual', 'mjml');
99
DROP TYPE IF EXISTS bounce_type CASCADE; CREATE TYPE bounce_type AS ENUM ('soft', 'hard', 'complaint');
1010
DROP TYPE IF EXISTS template_type CASCADE; CREATE TYPE template_type AS ENUM ('campaign', 'campaign_visual', 'tx');
1111
DROP TYPE IF EXISTS user_type CASCADE; CREATE TYPE user_type AS ENUM ('user', 'api');

0 commit comments

Comments
 (0)