@dschau/email-template 使用教程

阅读时长 6 分钟读完

简介

@dschau/email-template 是一个基于 Node.js 的 npm 包,它可以帮助开发者方便地创建 HTML 邮件模板。通过该包,开发者可以快速创建邮件模板并且可以创建基于自定义模板的个性化邮件,服务于业务需求。

安装

在终端输入以下命令来安装此 npm 包:

使用

以下是一个快速开始的例子。首先,您需要构建一个以字符串格式的基础 HTML 模板:

-- -------------------- ---- -------
----- ------------ - -
--------- -----
----- ----------
  ------
    ----- ----------------
    ------------------------
  -------
  ------
    -----------
  -------
-------
-

通过使用 {{}} 包围值来包含您的个性化内容。这个例子中,我们包含了一个 {{title}} 变量和一个 {{content}} 变量。接下来,使用 @dschau/email-template 将内容添加到基础模板中:

-- -------------------- ---- -------
----- ------------- - -----------------------------------------------

----- -------- - --- ---------------
  -------------
  ------ ------ -------
  -------- ------------ -- ----- --------------
--

-----------------------------

此代码将生成以下 HTML 输出:

-- -------------------- ---- -------
--------- -----
----- ----------
  ------
    ----- ----------------
    ------------ -------------
  -------
  ------
    ----------- -- ----- -------------
  -------
-------

参数

以下是 EmailTemplate 可用的配置选项:

参数 类型 描述
baseTemplate 字符串 必须,基础 HTML 模板。
...variables 任意 可选,在基础模板中定义的变量名和对应的值。

示例

以下是一个更完整的例子,基于一个旅游产品的 HTML 邮件模板:

-- -------------------- ---- -------
----- ------------ - -
--------- -----
----- -------------
------
    ----- ----------------
    ------------------------
    ----- --------------- ---------------------------- --------------------
    -------
        ---- -
            ------------ ---------- ------ ------------ ---------- ------ -----------
            ------ --------
            ----------- -------
            ---------- -----
            ------------ ------
        -
        ------- -
            ----------- --------
            ------ --------
            -------- -----
        -
        ------- -- -
            ---------- -----
            ----------- --
        -
        -------- -
            -------- -----
            ------- -----
            ----------------- --------
            ------- --- ----- --------
            -------------- ----
        -
        -------- -- -
            ----------- --
            ---------- -----
        -
        -------- ------------ -
            ------ --------
            ---------- -----
            ------------ ------
            -------------- -----
        -
        ------- -
            -----------
            ------------ ----- 
            --------------- 
            ----------- --------
            --------------------- 
            ---------------------
            -------------- ----
        -
    --------
-------
------
---- ---------------
    ------------------------
------
---- ----------------
    ------------------
    -- ---------------------------------------
    -- -------------- -------------------------------
------
-------
-------
-

----- ------------- - -----------------------------------------------

----- -------- - --- ---------------
  -------------
  ------------ --------
  ------ --------
  ------------ ----------------------------
  ------------ ------------------------------
--

-----------------------------

这个例子中,我们从一个预定义的基础 HTML 模板开始,然后向其注入个性化的内容和数据。

结论

@dschau/email-template 是一个简单易用的 HTML 邮件模板创建工具,旨在减少手动代码输入的时间和资源。它提供了易于理解和使用的参数和功能,有助于开发人员快速准确地构建个性化的 HTML 邮件模板。如未出现框架或功能更新,请关注作者的 GitHub 库以获得最新更新。

参考资料

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600562d681e8991b448e02ef

纠错
反馈