邮件模板工具mosaico和现有VUE工程的整合(一)

mosaico是一个电子邮件模板制作的单页应用工具,采用nodejs开发,grunt发布。如果要使用原版默认的图片上传功能,那么还需要在你的电脑中安装ImageMagick。
项目地址在https://github.com/voidlabs/mosaico

screenshot.png

本次的需求是要在已有的vuejs项目工程中引入这个项目。完全重写mosaico的grunt发布命令太麻烦,而且未尝试过也不知道能否成功。所以采用vuejs父页面+iframe子页面引入,postmessage互相通信的方式。另外,原版里有不使用图片上传而直接使用在线图片引入模板的功能,所以本次的图片上传也不在讨论范围之内。
首先,下载好mosaico的代码在本地运行起来,怎么运行github上都有,这里省略。发布生成的代码都在dist目录下,全部拷贝到vuejs工程的public文件夹下。我这里顺手把目录名dist改成了mosaico用以和其他资源区分。此外,mosaico的预置模板在templates目录下,一并拷贝到上述public/mosaico里。


微信截图_20210327122528.png

然后是在vue中准备父页面。

<template>
  <div class="">
      <iframe ref="iframe" :src="src" width="100%" style="min-height:1000px" />
  </div>
</template>

iframe里的src就是我们mosaico的页面地址。由于是作为静态资源使用,域名是和vue工程一样的。那么定义一下相对地址。

baseUrl: {
        editor: '/mosaico/editor.html?',
        index: '/mosaico/index.html'
      }

这两个页面都在public/mosaico里可以找到,一个是新建模板页面,一个是编辑模板页面。如果运行过原工程,你会发现原版的编辑页面是类似http://localhost:9006/editor.html?0.17.5#s0flmau这样。后面的0.17.5可以去掉,#s0flmau就是要编辑模板的hashId。我们可以在父页面的created事件里调用一个初始化页面方法去后台DB检索,然后判断传回来的hashId值的有无,用baseUrl组装成src迁移到其中的一个页面。
这样初步的引入工作就做完了。还剩下两个问题,原本的mosaico生成的模板是保存到localStorage里的,怎样将其保存到DB里以便共享给其他用户编辑;iframe页面编辑完了,怎样通知父页面让其跳转到其他页面。

第一个问题:
观察一下mosaico工程编辑完保存的数据,打开localStorage,发现里面有[metadata-#hashId],[template-#hashId]两个object。这两个就是制作完的模板数据了。


微信截图_20210327122405.png

但是,还有呢?我们需要模板的html啊,电子邮件发送的不就是html吗?点击mosaico页面的download按钮,发现可以生成html,这就是我们需要的东西。
调查一下download事件,在mosaico-master\src\js\ext\localstorage.js里。

downloadCmd.execute = function() {
      downloadCmd.enabled(false);
      viewModel.notifier.info(viewModel.t("Downloading..."));
      viewModel.exportHTMLtoTextarea('#downloadHtmlTextarea');
      var postUrl = emailProcessorBackend ? emailProcessorBackend : '/dl/';
      global.document.getElementById('downloadForm').setAttribute("action", postUrl);
      global.document.getElementById('downloadForm').submit();
      downloadCmd.enabled(true);
    };

最关键的就是

viewModel.exportHTMLtoTextarea('#downloadHtmlTextarea');

它把生成的html输出到页面上的#downloadHtmlTextarea中了。我这里稍微改造了一下,不要download按钮,点击save按钮就可以生成html。(不要删除download按钮,否则页面不会渲染出#downloadHtmlTextarea DOM从而导致报错。)

saveCmd.execute = function() {
      saveCmd.enabled(false);
      ...
      global.localStorage.setItem("metadata-" + mdkey, viewModel.exportMetadata());
      global.localStorage.setItem("template-" + mdkey, viewModel.exportJSON());
      viewModel.exportHTMLtoTextarea('#downloadHtmlTextarea');
      global.localStorage.setItem("html-" + mdkey, global.document.getElementById('downloadHtmlTextarea').value);
      
      saveCmd.enabled(true);
    };

这样就存进了localStorage的[html-#hashId]之中。在vuejs工程中的父页面读取到这些值,然后发往后台就可以存入到DB之中了。(这也是为什么把两个工程合二为一的好处,你可以读取到同一个localStorage。而如果将两个工程分别部署,他们的端口号是不同的,localStorage也就不是互通的,你需要在mosaico工程中通过ajax调用vue工程的后台方法从而需要更多的工作。当然你也可以通过设置公开同样的一级域名来使用localStorage,但是注意一点,开发环境和生产环境是不同的,开发环境可能是没有条件使用公开域名的,这会给你的调试带来难度。)
回到上文的父页面的created事件,初始化页面的时候取出hashId和保存的object,这样就解决了数据存取的问题。

第二个问题就更简单了:
保存的按钮里写一个global.parent.postMessage方法,然后在vue页面mount事件里挂载监听器
window.addEventListener('message', messageFunc),iframe页面就可以向父页面通信了。vue页面接收到message以后执行localStorage取值,调用后台接口保存操作。如果还要再精致一点,addEventListener之前先removeEventListener一次,避免重复监听。

至此就完成了整合的初步工作。还剩下图片功能、语言本地化等工作。留给下一次文章吧。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,590评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 86,808评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,151评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,779评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,773评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,656评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,022评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,678评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,038评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,659评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,756评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,411评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,005评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,973评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,053评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,495评论 2 343

推荐阅读更多精彩内容