README

此软件包使得 Neos 能够通过 Mautic 发送个性化的通讯稿，将 Mautic 的表单作为内容元素包含在内，并添加 Mautic 跟踪。表单通过 JavaScript API 集成。所有后端对 Mautic 的请求都是事件驱动的。这确保了即使 Mautic 不可用，任务也能被处理。

安装

将软件包添加到您的站点软件包中

composer require --no-update garagist/mautic

在项目根目录中运行 composer update

最后，您需要运行以下命令

flow doctrine:migrate
flow eventstore:setupall

配置 Mautic

1. 访问您的 Mautic 安装并 为 API 创建用户。
2. 启用 API 和 HTTP 基本认证。可选：请确保您的 Mautic 安装运行在 HTTPS 上以提高安全性。
3. 如果您想发送测试邮件，请安装我们的 GaragistMauticApiBundle 插件。
4. 如果您的网站和 Mautic 在同一服务器上运行，请跳过此步骤
   • 启用 CORS，将您的站点添加到 有效域名 中。

配置 Neos

默认值在 Settings.Garagist.yaml 中设置。

routeArgument 设置

htmlTemplate 设置用于调用通讯稿的 HTML 变体并将其发送到 Mautic 的参数。

plaintextTemplate 设置用于调用通讯稿的纯文本变体并将其发送到 Mautic 的参数。

如果您使用 Garagist.Mjml，则 htmlTemplate 将自动设置为 mjml。重要的是简单地遵守 composer 的加载顺序，并在 Garagist.Mautic 之后加载 Garagist.Mjml。

api 设置

设置您的 Mautic 凭据 userName 和 password。 baseUrl 是 Mautic 可以通过 PHP 访问的 URL。如果 Mautic 在其自己的 Docker 容器中运行，则可能不同于 publicUrl（见下一节）。

publicUrl 设置

在此处设置 Mautic 安装公开可访问的 URL。这将用于跟踪、表单和通讯稿模块中的链接。

enableTracking 设置

启用 Mautic 的 JavaScript 跟踪代码。默认情况下，在开发环境中设置为 false，在生产环境中设置为 true。

mail 设置

trackingPixel 在关闭 body 标签前注入 Mautic 的跟踪像素。

form 设置

hide 设置您想在检查器中隐藏的表单的 ID。您可以传递一个数组（例如，[1, 2, 3]）或一个整数。

category 设置

newsletter 设置您要用于通讯稿的类别的 ID。请注意，该类别必须在 Mautic 中存在。

testMail 设置

recipients 用于定义发送测试邮件时使用的电子邮件地址。您可以传递一个数组（例如 ['test@mail.example', 'user@mail.example']）或一个字符串（例如 'test@mail.example'）。请注意，必须在您的 Mautic 安装中安装 GaragistMauticApiBundle 插件。此外，设置 action.test 需要设置为 true。

segment 设置

• lockPrefilled 如果从创建/编辑对话框预先填充了段，则用户无法取消选择。默认为 true
• mapping：用于新闻通讯的段的 ID。但您也可以定义一个数组/对象来处理您自己的数据提供程序中的段。
• choose：在此处添加要在创建/编辑对话框中选择的段。您可以传递一个数组（例如 [1, 2, 3]）或一个整数。
• hide：在此处添加要隐藏的段的 ID（例如，对于未确认的联系人）。您可以传递一个数组（例如 [1, 2, 3]）或一个整数。

action 设置

在此组中，您可以启用/禁用以下操作

• delete 删除电子邮件的能力，默认为 true
• publish 发布电子邮件的能力，默认为 true
• unpublish 取消发布电子邮件的能力，默认为 true
• send 发送电子邮件的能力，默认为 true
• update 更新电子邮件的能力，默认为 true
• edit 改变主题、预览文本和/或收件人的能力，默认为 true
• test 发送测试（即示例）电子邮件的能力，默认为 false。您需要在您的 Mautic 安装中安装 GaragistMauticApiBundle 插件

个性化

可以发送个性化的电子邮件。要使用此功能，只需在页面文本中应用以下标记

{#ifNewsletter}Hello #FIRSTNAME# #Lastname#, this is your newsletter{:else}Fallback for Webview{/if}

可用的字段是 contactfield 中的每个字段，两侧均以 # 包围（不区分大小写）

NodeTypes

Garagist.Mautic:Mixin.Email

将此 mixin 添加到任何文档中，以启用发送新闻通讯的能力。

Garagist.Mautic:Mixin.Category

将此 mixin 添加到任何文档中，将其定义为新闻通讯的分类。这在新闻通讯模块的概述中使用。

Garagist.Mautic:Mixin.DoNotTrack

将此 mixin 添加到任何文档中，以具有禁用此特定页面 Mautic 跟踪的能力。

Garagist.Mautic:Mixin.Form

将此 mixin 添加到节点中，以添加 Mautic 表单的选择器。请注意，您需要在您的标记中包含 Fusion 原型 Garagist.Mautic:Component.Form