Laravel-MJML 项目使用教程

Laravel-MJML 项目使用教程

laravel-mjmlEasily use MJML in your Laravel Blade templates!项目地址:https://gitcode.com/gh_mirrors/la/laravel-mjml

1、项目介绍

Laravel-MJML 是一个用于在 Laravel 项目中集成 MJML（一种用于构建响应式邮件模板的标记语言）的扩展包。通过这个扩展包，开发者可以轻松地在 Laravel 的 Blade 模板中使用 MJML，从而简化邮件模板的设计和开发过程。

2、项目快速启动

安装

首先，通过 Composer 安装 Laravel-MJML 扩展包：

composer require asahasrabuddhe/laravel-mjml

安装完成后，发布扩展包的配置文件：

php artisan vendor:publish --tag=laravel-mjml

接下来，安装 MJML CLI：

npm install --save mjml

使用

1. 创建 MJML 视图： 在 resources/views 目录下创建一个包含 MJML 代码的视图文件，例如 emails/welcome.blade.php。

2. 创建 Mailable 类： 使用 Artisan 命令创建一个 Mailable 类：

   php artisan make:mail WelcomeEmail
   

   在生成的 Mailable 类中，替换 use Illuminate\Mail\Mailable 为 use Asahasrabuddhe\LaravelMJML\Mail\Mailable。

3. 构建邮件内容： 在 Mailable 类的 build 方法中使用 mjml 方法：

   public function build()
   {
       return $this->mjml('emails.welcome');
   }
   

   如果是 Laravel 9 及以上版本，可以在 content 方法中使用：

   public function content()
   {
       return new Content(
           view: $this->mjml('emails.welcome')->buildMjmlView()['html']
       );
   }
   

3、应用案例和最佳实践

应用案例

Laravel-MJML 适用于需要发送复杂邮件模板的项目，例如：

• 电子商务平台：发送包含订单确认、发货通知等内容的邮件。
• 新闻订阅服务：发送包含图文并茂的新闻简报。
• 企业内部系统：发送包含重要通知和提醒的邮件。

最佳实践

• 模块化设计：将邮件模板拆分为多个部分，便于复用和维护。
• 响应式设计：确保邮件在不同设备上都能良好显示。
• 测试驱动开发：在开发过程中使用单元测试和功能测试，确保邮件模板的功能和样式符合预期。

4、典型生态项目

Laravel-MJML 可以与其他 Laravel 生态项目结合使用，例如：

• Laravel Horizon：用于管理队列任务，确保邮件发送的可靠性和效率。
• Laravel Telescope：用于监控和调试应用程序，帮助开发者快速定位和解决邮件发送中的问题。
• Laravel Nova：用于构建管理后台，方便管理员查看和分析邮件发送情况。

通过这些生态项目的结合，可以进一步提升邮件发送的效率和可靠性，满足复杂业务场景的需求。

laravel-mjmlEasily use MJML in your Laravel Blade templates!项目地址:https://gitcode.com/gh_mirrors/la/laravel-mjml