README

这是一个用于连接Mailchimp电子邮件营销API的Craft CMS插件。

安装

您可以从命令行或插件页面安装此插件。

配置

设置可以通过设置页面提供 /admin/settings/plugins/craft-mailchimp。

或者可以在php文件中提供 /config/craft-mailchimp.php

<?php
return [
    'apiKey' => 'b3e485720d0fb51f01884d4289e62d15-us10',
    'dataCenter' => 'us10',
    'defaultListId' => '2345b79e5f',
];

这些也可以在.env中设置，这将具有最高优先级。

MAILCHIMP_API_KEY=b3e485720d0fb51f01884d4289e62d15-us10
MAILCHIMP_API_PREFEX=us10
MAILCHIMP_LIST_ID=2345b79e5f

API密钥可以在Mailchimp管理员面板的用户设置下找到。ds.admin.mailchimp.com/account/api，其中ds是您的数据中心（例如us10）。

此设置对于插件正确运行是必需的。

数据中心将是API密钥的前缀或后缀，例如us10。这是可选的，并且将尝试从提供的API密钥中解析。

要使用您账户中的特定受众，请使用在ds.admin.mailchimp.com/lists/settings/default?id=web-id设置页面上的该列表的受众ID。默认情况下，您的账户上的第一个受众将被使用，因此如果您在账户中只使用一个列表，可能不需要此设置。

使用方法

Mailchimp PHP API

如果插件已正确安装和配置，整个Mailchimp PHP API应该会暴露在前端使用。

例如，如果API文档中的PHP代码如下所示

$response = $client->lists->getAllLists();

检索账户上的所有受众/列表。您可以在twig中编写以下内容

{% set response = craft.mailchimp.client.lists.getAllLists() %}
{% for list in response.lists %}
    <a href="{{ list.subscribe_url_short }}" target="_blank">{{ list.name }}</a>
{% endfor %}

这将列出您的账户上的每个受众，并列出其注册表单。

虽然所有方法都应该可用，但在运行查询时要非常小心。请记住，twig应显示数据，而不是修改数据，因此请避免使用POST / PUT / DELETE方法，并专注于使用GET方法的函数。

列表API 是了解您想做什么的好起点。

连接网站（专业版）

此插件支持连接网站，通过Mailchimp界面向您的Craft网站添加弹出窗口等元素。

开始很容易，只需将此脚本添加到文档的<head>部分。

{{ craft.mailchimp.connectSite() | raw }}

这将输出正确的<script>标签，以便您的网站可以与Mailchimp连接。

表单输入标签（专业版）

我创建了一个系统，可以帮助用户通过隐藏输入字段从任何表单注册到Mailchimp列表。

必需标签

{{ hiddenInput('MAILCHIMP_SUBSCRIBE_CHECKBOX', 'mailchimpSubscribe') }}
{{ hiddenInput('MAILCHIMP_SUBSCRIBE_EMAIL', 'emailAddress') }}

MAILCHIMP_SUBSCRIBE_CHECKBOX 字段确定是否将用户从列表中订阅或取消订阅。这可以是true或false，或者是一个字符串，在这种情况下，它将被假定为复选框字段的name属性，该属性将确定真假。

MAILCHIMP_SUBSCRIBE_EMAIL 字段是电子邮件地址输入字段的名称属性，该字段将被订阅到列表。例如

<input type="checkbox" name="mailchimpSubscribe" checked>
<input type="email" name="emailAddress" placeholder="email@domain.com">

这样，您应该能够将Mailchimp功能添加到任何现有表单中。

可选标签

{{ hiddenInput('MAILCHIMP_SUBSCRIBE_LIST_ID', '2345b79e4f') }}

{{ hiddenInput('MAILCHIMP_SUBSCRIBE_FNAME', 'firstName') }}
{{ hiddenInput('MAILCHIMP_SUBSCRIBE_LNAME', 'lastName') }}
{{ hiddenInput('MAILCHIMP_SUBSCRIBE_PHONE', 'phoneNumber') }}

MAILCHIMP_SUBSCRIBE_LIST_ID 输入可以用来添加到特定的 Mailchimp 列表中。否则将使用账户中的第一个列表。

MAILCHIMP_SUBSCRIBE_FNAME、MAILCHIMP_SUBSCRIBE_LNAME 和 MAILCHIMP_SUBSCRIBE_PHONE 都是指 Mailchimp 列表中的合并字段。这些都是与用户关联的额外信息。任何不以 CHECKBOX、EMAIL 或 LIST_ID 结尾的 MAILCHIMP_SUBSCRIBE_ 输入都被假定为合并字段。

clarknelson / craft-mailchimp

维护者

详细信息