escolalms / templates-email
Escola 无头 LMS 邮件模板
0.1.65
2024-02-14 14:31 UTC
Requires
- php: >=7.4
- escolalms/core: ^1.2.2
- escolalms/templates: ^0.2.1
- ezyang/htmlpurifier: ^4.13
- laravel/framework: >=8.0
- qferr/mjml-php: ^2
Requires (Dev)
- escolalms/assign-without-account: ^0
- escolalms/auth: ^0.2
- escolalms/cart: ^0
- escolalms/consultation-access: ^0
- escolalms/consultations: ^0
- escolalms/course-access: ^0
- escolalms/courses: ^0.4
- escolalms/csv-users: ^0.1.0
- escolalms/payments: ^0
- escolalms/permissions: ^0
- escolalms/settings: ^0.1.2
- escolalms/tasks: ^0
- escolalms/topic-type-project: ^0
- escolalms/topic-types: ^0
- escolalms/video: ^0
- escolalms/webinar: ^0
- escolalms/youtube: ^0
- orchestra/testbench: ^5.0|^6.0
- phpunit/phpunit: ^9.0
Suggests
- escolalms/auth: ^0.1.54
- escolalms/consultations: ^0
- escolalms/courses: ^0.3.8
- escolalms/settings: ^0.1.2
- escolalms/webinar: ^0
- dev-main
- 0.1.65
- 0.1.64
- 0.1.63
- 0.1.62
- 0.1.61
- 0.1.60
- 0.1.59
- 0.1.58
- 0.1.57
- 0.1.56
- 0.1.55
- 0.1.54
- 0.1.53
- 0.1.52
- 0.1.51
- 0.1.50
- 0.1.49
- 0.1.48
- 0.1.47
- 0.1.46
- 0.1.45
- 0.1.44
- 0.1.43
- 0.1.42
- 0.1.41
- 0.1.40
- 0.1.39
- 0.1.38
- 0.1.37
- 0.1.36
- 0.1.35
- 0.1.34
- 0.1.33
- 0.1.32
- 0.1.31
- 0.1.30
- 0.1.29
- 0.1.28
- 0.1.27
- 0.1.26
- 0.1.25
- 0.1.24
- 0.1.23
- 0.1.22
- 0.1.21
- 0.1.20
- 0.1.19
- 0.1.18
- 0.1.17
- 0.1.16
- 0.1.15
- 0.1.14
- 0.1.13
- 0.1.12
- 0.1.11
- 0.1.10
- 0.1.9
- 0.1.8
- 0.1.7
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- 0.0.4
- 0.0.3
- 0.0.2
- 0.0.1
- dev-feature/admin-readme
- dev-feature/php82
- dev-feature/readme
This package is auto-updated.
Last update: 2024-09-22 08:43:39 UTC
README
用于编辑模板的邮件通知包(用于重要的用户相关事件)
用途
此包允许您为 Laravel 应用中发出的事件创建邮件通知。
每个通知都作为描述可用于模板的变量(模板将在数据库中创建并通过管理面板进行编辑)的类来创建。此类必须使用模板包中的 Template 门面进行注册,您指定它关联的事件以及它通过哪个渠道发送(例如,当在此包中定义时,为电子邮件渠道)。
安装
composer require escolalms/templates-email
php artisan db:migrate
php artisan db:seed --class="EscolaLms\TemplatesEmail\Database\Seeders\TemplatesEmailSeeder"
依赖项
使用方法
定义模板
- 创建触发使用指定模板发送电子邮件的事件。此事件必须实现返回 LMS 核心包中的 User 模型的 getUser() 方法。
- 创建定义模板变量的类,您将在电子邮件通知中使用这些变量。
- 通过使用
EscolaLms\Templates\Facades\Template::register(Event class, EscolaLms\TemplatesEmail\Core\EmailChannel::class, Variable class);
将描述模板变量的类与事件和通知应通过哪个渠道发送相关联。 - 在数据库中注册模板以供管理面板使用或使用
/api/admin/templates
,在 模板包 中有更详细的描述
Mjml (预)渲染
- 电子邮件使用 MJML 编写,然后在保存模板时预先渲染成 HTML(这样发送电子邮件时就不会为每条消息调用渲染器)。
- 要渲染 MJML,您需要
- 安装
mjml
npm 包并在该包配置中配置可执行二进制文件的路径binary_path
键 - 注册到 MJML API 并在配置文件中配置 api id & secret
- 安装
测试
运行 ./vendor/bin/phpunit --filter 'EscolaLms\\TemplatesEmail\\Tests'
来运行测试。请参阅 tests 文件夹,其中包含一个带有最小定制的变量(或模板描述)类的基本实现 - 创建您自己的一个相当好的起点。
权限
此包未定义权限。