asahasrabuddhe/laravel-mjml

一个允许在 Laravel Mailables 中使用 MJML 的软件包。


README

使用 MJML 和 Laravel Mailables 轻松构建响应式电子邮件。

MJML

MJML 是 MailJet 提供的一个出色的工具,它允许我们非常容易地创建响应式电子邮件。有关如何使用的更多信息,请参阅他们的文档这里

安装

要安装此软件包,请使用以下命令使用 composer 需求此软件包:

composer require asahasrabuddhe/laravel-mjml

在 composer 安装软件包及其所有依赖项后,使用 artisan 命令发布软件包配置:

php artisan vendor:publish

在列表中选择 laravel-mjml。您还需要安装 MJML CLI

npm install --save mjml

入门

  1. 在您的 resources/views 目录中创建一个包含 MJML 的视图。

  2. 使用 artisan 命令创建一个 mailable 类:php artisan make:mail MJMLEmail

  3. 在 mailable 类中,将

    use Illuminate\Mail\Mailable;

    替换为

    use Asahasrabuddhe\LaravelMJML\Mail\Mailable;

  4. Laravel 8 及以下版本中,在 build 方法中使用

    public function build()
    {
        return $this->mjml('view.name')
    }

    Laravel 9 中,在 content 方法中使用

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

配置

默认情况下,软件包将自动检测项目中本地安装的 MJML CLI 的路径。如果未发生这种情况或 MJML CLI 是全局安装的,请相应地更新配置文件。

就这样!您已成功安装和配置了 MJML 软件包以供使用。只需创建新的视图并在 mailables 类中使用它们即可。