README

它做什么？

此扩展使用 Mailjet API，用户可以订阅您的时事通讯并添加到您的 Mailjet 邮件列表。它包含两个插件。一个是带有 mailjet 订阅表单的插件，另一个是带有 mailjet 验证表单的插件。

您可以根据自己的（Mailjet）需求自定义订阅表单。您可以选择要显示哪些字段以及它们如何映射到 Mailjet 中相应的联系字段，哪些字段应用于接收者姓名，哪个字段应用于电子邮件。

要求

TYPO3 >= 11.5.0
PHP >= 7.4
Mailjet API 密钥和密钥

安装

composer require "passionweb/mailjet-api"

通过 composer 安装扩展
添加必要的 RouteEnhancer（见 #necessary-routeenhancer）
在使用扩展之前，将您的 Mailjet API 密钥和密钥添加到扩展配置中
刷新 TYPO3 和 PHP 缓存

配置

必要的 RouteEnhancer

将以下 RouteEnhancer 添加到您的网站配置（config.yaml）中的 routeEnhancers 部分

    MailjetDoubleOptIn:
        type: Simple
        limitToPages: [ YOUR_PID ]
        routePath: '/{contact_id}'
        requirements:
            contact_id: '[0-9]{1,10}'
        _arguments: {}

前端配置 "enforceValidation" 和 "excludedParameters"（TYPO3 v12）

如果您不使用 RouteEnhancer 的 limitToPages 选项，并且如果应该可以调用具有 contact_id 作为参数的同一页面（其中包含您的 mailjet 验证插件）而没有 contact_id，则需要将 contact_id 参数添加到 excludedParameters 中。

$GLOBALS['TYPO3_CONF_VARS']['FE']['cacheHash'] = [
    'enforceValidation' => true,
    'excludedParameters' => [
        'contact_id',
    ],
];

扩展配置

以下扩展设置可用。

# cat=Mailjet settings; type=string; label=Mailjet API key;
mailjetApiKey= YOUR_MAILJET_API_KEY

输入您的 Mailjet API 密钥。

# cat=Mailjet settings; type=string; label=Mailjet secret key;
mailjetSecretKey= YOUR_MAILJET_SECRET_KEY

输入您的 Mailjet 密钥。

# cat=Mailjet settings; type=string;  label=Mailjet API version
mailjetApiVersion = v3

输入当前的 Mailjet API 版本。

编辑器如何使用扩展

添加所需属性

属性用于定义订阅表单的字段以及与 Mailjet 字段的关联映射。以下字段可用

表单属性名称：订阅表单中属性的名称
Mailjet 属性名称：Mailjet 中（联系）属性的名称
表单属性类型：选择订阅表单中字段的类型（可能值：text、email、tel、number、url）
表单字段占位符：订阅表单中字段的占位符文本
表单字段必填：选择当前字段是否在订阅表单中必填（默认：false）
用于 Mailjet 名称：选择当前字段是否用于 Mailjet 订阅和验证电子邮件中的名称（默认：false）
用于 Mailjet 电子邮件：选择当前字段是否用于 Mailjet 订阅和验证电子邮件中的电子邮件（默认：false）

添加并配置插件 "Mail 订阅表单"

将插件 "Mailjet 订阅表单" 添加到您选择的页面
配置插件设置
- 存储 Pid：选择订阅记录应存储的存储位置
- 表单字段/属性：选择您要在订阅表单中使用的所有属性
- 电子邮件地址的表单字段：选择您要在订阅电子邮件中使用的属性
- 电子邮件接收者名称的表单字段：选择您要在订阅电子邮件中使用的接收者名称的属性或属性
- Mailjet ListID：输入您要用于订阅的 Mailjet 列表的 ID
- 订阅电子邮件的发送者电子邮件：输入您要作为订阅电子邮件发送者的电子邮件
- 订阅电子邮件的发件人姓名：输入您想用作订阅电子邮件发件人姓名的名称
- 订阅电子邮件的主题：输入您想用作订阅电子邮件主题的内容
- 订阅电子邮件的Mailjet模板ID：输入您想用作订阅电子邮件的Mailjet模板的ID
- 表单提交后重定向到页面：选择用户提交订阅表单后应重定向到的页面

添加并配置插件"邮件验证订阅"

将插件"Mailjet验证订阅"添加到您选择的页面（应与订阅表单的页面不同）
配置插件设置
- Mailjet列表ID：输入您想用作验证的Mailjet列表的ID（必须与插件"邮件订阅表单"中的ID相同）
- 验证电子邮件的发件人电子邮件：输入您想用作验证电子邮件发件人电子邮件的地址
- 验证电子邮件的发件人姓名：输入您想用作验证电子邮件发件人姓名的名称
- 验证电子邮件的主题：输入您想用作验证电子邮件主题的内容
- 验证电子邮件的Mailjet模板ID：输入您想用作验证电子邮件的Mailjet模板的ID

重要提示

此扩展使用外部服务Mailjet。要使用此扩展，您需要一个Mailjet账户和一个API密钥。更多信息请访问Mailjet网站。

故障排除和日志记录

如果某些操作不符合预期，请首先查看日志文件。每个问题都会记录到TYPO3日志中（通常位于var/log/typo3_*.log）

共同取得更大成就或反馈，反馈，反馈

感谢任何反馈！无论是改进建议、扩展请求还是对扩展好坏的（建设性）反馈。

请随时将您的反馈发送至service@passionweb.de或在Slack上联系我

passionweb / mailjet-api

维护者

详细信息