告别邮件排版噩梦:使用notfloran/mjml-bundle在Symfony中轻松构建精美邮件

在 Web 应用开发中,发送邮件是一个常见的需求。然而,手动编写 html 邮件既费时又容易出错,而且不同邮件客户端的兼容性问题也让人头疼。为了解决这个问题,我尝试了 notfloran/mjml-bundle,这是一个 symfony 框架的扩展包,它集成了 MJML 邮件模板引擎,可以帮助开发者更高效地创建美观、响应式的 HTML 邮件。 composer在线学习地址:学习地址

mjml (mailjet markup language) 是一种专门为邮件设计的标记语言,它通过简洁的语法和组件化的方式,让开发者能够轻松构建出在各种设备和邮件客户端上都能完美显示的邮件模板。notfloran/mjml-bundle 则将 mjml 集成到了 symfony 框架中,使得在 symfony 项目中使用 mjml 变得非常简单。

安装与配置

使用 Composer 安装 notfloran/mjml-bundle 非常简单:

composer require notfloran/mjml-bundle

安装完成后,如果你的 Symfony 项目使用了 flex,那么扩展包会自动完成配置。如果没有使用 Flex,则需要在 config/bundles.php 文件中手动启用该扩展包。

接下来,你需要安装 MJML 编译器。推荐使用 npm 安装:

npm install mjml

然后,在 config/packages/mjml.yaml 文件中配置 MJML 编译器的路径和其他选项:

mjml:   renderer: binary   options:     binary: '%kernel.project_dir%/node_modules/.bin/mjml'     minify: true     validation_level: skip

使用方法

notfloran/mjml-bundle 提供了两种使用 MJML 的方式:

  1. Twig 标签: 在 Twig 模板中使用 {% mjml %} 和 {% endmjml %} 标签包裹 MJML 代码,扩展包会自动将其编译为 HTML。

    {# templates/mail/example.mjml.twig #} {% block email_content %}     {% mjml %}     <mjml>         <mj-body>             <mj-section>                 <mj-column>                     <mj-text font-size="20px" color="#F45E43" font-family="helvetica">                         Hello {{ name }} from MJML and Symfony                     </mj-text>                 </mj-column>             </mj-section>         </mj-body>     </mjml>     {% endmjml %} {% endblock %}

    在 Controller 中渲染该模板,即可得到编译后的 HTML 代码:

    use SymfonyComponentMailerMailerInterface; use SymfonyComponentMimeEmail;  public function sendEmail(MailerInterface $mailer) {     $htmlBody = $this->renderView('templates/mail/example.mjml.twig', ['name' => 'Floran']);      $email = (new Email())         ->from('my-app@example.fr')         ->to('me@example.fr')         ->subject('Hello from MJML!')         ->html($htmlBody);      $mailer->send($email); }
  2. MJML 服务: 将 MJML 代码放在独立的 Twig 模板中,然后通过 NotFloranMjmlBundleRendererRendererInterface 服务来编译 MJML 代码。

    {# templates/mail/example.mjml.twig #} <mjml>     <mj-body>         <mj-section>             <mj-column>                 <mj-text font-size="20px" color="#F45E43" font-family="helvetica">                     Hello {{ name }} from MJML and Symfony                 </mj-text>             </mj-column>         </mj-section>     </mj-body> </mjml>
    use NotFloranMjmlBundleRendererRendererInterface; use SymfonyComponentMailerMailerInterface; use SymfonyComponentMimeEmail;  public function sendEmail(MailerInterface $mailer, RendererInterface $mjml) {     $mjmlBody = $this->renderView('templates/mail/example.mjml.twig', ['name' => 'Floran']);     $htmlBody = $mjml->render($mjmlBody);      $email = (new Email())         ->from('my-app@example.fr')         ->to('me@example.fr')         ->subject('Hello from MJML!')         ->html($htmlBody);      $mailer->send($email); }

优势与应用

使用 notfloran/mjml-bundle 的优势在于:

  • 高效的邮件开发: MJML 语法简洁易懂,可以快速构建出复杂的邮件布局。
  • 跨客户端兼容性: MJML 编译器会自动处理不同邮件客户端的兼容性问题,保证邮件在各种设备上都能正常显示。
  • 响应式设计: MJML 支持响应式设计,可以轻松创建适应不同屏幕尺寸的邮件。
  • 易于集成: notfloran/mjml-bundle 与 Symfony 框架无缝集成,使用起来非常方便。

在实际应用中,notfloran/mjml-bundle 可以用于:

  • 发送营销邮件: 创建精美的营销邮件,提升用户参与度。
  • 发送通知邮件: 发送重要的通知邮件,确保用户及时收到信息。
  • 发送验证邮件: 发送用户注册密码重置等验证邮件,保障用户账号安全。

总而言之,notfloran/mjml-bundle 是一款非常实用的 Symfony 扩展包,它可以帮助开发者更高效地创建美观、兼容性强的 HTML 邮件,从而提升 Web 应用的用户体验。如果你正在使用 Symfony 框架,并且需要发送邮件,那么强烈推荐你尝试一下 notfloran/mjml-bundle。

© 版权声明
THE END
喜欢就支持一下吧
点赞7 分享