sebastienheyd/boilerplate-email-editor

sebastienheyd/boilerplate 的电子邮件可视化编辑器

8.1.7 2021-10-12 08:45 UTC

README

Packagist Build Status StyleCI Scrutinizer Code Quality Laravel Nb downloads MIT License

此包为 sebastienheyd/boilerplate 提供功能,允许开发者管理其应用的电子邮件。它允许您创建布局,然后定义只能编辑文本而无法修改布局的编辑器。

安装

  1. 要安装 Laravel Boilerplate Email Editor,请运行
composer require sebastienheyd/boilerplate-email-editor
  1. 然后运行
php artisan migrate

您可以去后台并开始使用电子邮件管理面板。

可选:发布配置文件

php artisan vendor:publish --tag=email-editor-config

修改默认 HTML 布局

要编辑默认 HTML 布局,您可以使用以下命令

php artisan vendor:publish --tag=email-editor-layout

您将在 /resources/views/vendor/boilerplate-email-editor/layout 中找到布局

生成新的电子邮件布局

要生成新布局,您可以使用以下 artisan 命令

php artisan email:layout {name} 

此命令将在 resources/views/email-layouts 文件夹中生成新的 blade 文件。

要更改默认文件夹,请更改 email-editor 配置文件中的 layouts_path 的值。

但是,您必须发布配置文件才能这样做。为此,请使用以下命令

php artisan vendor:publish --tag=email-editor-config

您还可以使用 --remove 选项删除布局

php artisan email:layout --remove {name}

定义编辑器

此包提供了两个权限,可以根据所需的配置使用。

  • 电子邮件开发:保留给开发者,允许定义 slug、描述和布局。
  • 电子邮件编辑:供将能够编辑电子邮件内容的用户使用。

权限和角色默认可由 sebastienheyd/boilerplate 管理

电子邮件变量

在编辑电子邮件内容时,您将找到一个“插入变量”按钮。此按钮允许您在电子邮件中插入变量并使其不可编辑。

然而,您也可以通过用 [ 和 ] 框起来手动输入变量。这样,您还可以将变量添加到电子邮件的主题行。

示例:“[first_name] 您好”

发送电子邮件

use Sebastienheyd\BoilerplateEmailEditor\Models\Email;

// Setting data
$data = ['first_name' => 'John', 'last_name' => 'Doe'];

// Sending email by his slug
Email::findBySlug('my_slug')->send('email@tld.com', $data);

// Or by his id
Email::find(1)->send('email@tld.com', $data);

测试 / 编码标准

此包附带一个 Makefile,用于启动遵守编码标准和单元测试的检查。

只需调用 make 即可查看命令列表。

鸣谢

许可证

此包是免费软件,根据 MIT 许可证 的条款分发。