README

一个简化任何输入表单订阅过程实现的插件。

这是一个为开发者准备的插件，因为你需要提供自己的模板文件。

先决条件

此插件需要Craft CMS 4.0.0或更高版本

安装

进入项目目录

cd /path/to/my-project.test

告诉Composer加载插件

composer require misterbk/optinmail

告诉Craft安装插件

./craft install/plugin opt-in-mail

设置

要使此插件工作，您需要创建或链接自己的模板文件。

1. 设置

为此，请打开Craft管理区域控制中心设置页面
"设置 > 插件 > Opt In Mail"
设置所有三个模板文件的路径。此插件示例文件夹中提供了一个示例。您可以看到如何访问这些视图中的变量以及电子邮件/站点的示例实现

2. 允许的字段名称

为了防止数据库注入，您必须提供“允许的字段名称”，这意味着，您需要在“opt-in-mail.php”配置文件中为要连接到订阅程序的表单白名单字段。只需在相应的formHandle下添加您的输入字段名称到“opt-in-mail.php”文件中。您可以在“config/opt-in-mail.php”下找到此文件
如果该文件不存在，您可以从“craft-plugin-optInMail/src/examples/opt-in-mail.php”中复制我们的示例配置文件到Craft的配置文件夹，并在那里添加您的字段名称。

3. 连接您的表单

设置完成后，您可以通过向您的表单中添加以下格式的隐藏输入字段来将表单连接到插件：

<input name="action" type="hidden" value="opt-in-mail/form/save-form-data">
<input type="hidden" name="optInFormHandle" value="{{handle}}">

其中{{handle}}是在步骤2中在“opt-in-mail.php”配置文件中提供的formHandle

4. 测试您的表单

如果Craft的邮件设置已设置，您可以提交表单，并查看是否收到订阅邮件。

附加信息

这是我们为Craft 3开发的第一批插件之一，所以我们依靠您的反馈。如果您有任何建议或发现任何错误，请通过我们的GitHub账户联系我们：[https://github.com/mister-bk](https://github.com/mister-bk) 或通过电子邮件：[mister-bk](mailto:s.karst@mister-bk.de)!

misterbk / optinmail

维护者

详细信息