README

提供了一个基于Ajax的MailChimp邮件列表注册组件和一个用于与SilverWare一起使用的API驱动的邮件列表下拉字段。

内容

安装通过Composer

$ composer require silverware/mailchimp

与所有SilverStripe模块一样，配置通过YAML完成。扩展和所需的JavaScript由config.yml定义。您还可以通过YAML修改API的默认超时时间。

SilverWare\MailChimp\API\MailChimpAPI:
  default_timeout: 10

在此模块可以使用之前，您需要创建一个MailChimp API密钥。一旦创建您的API密钥，您可以通过以下两种方式之一定义它

此模块将在您的站点设置中的SilverWare下添加一个MailChimp选项卡。您可以将API密钥粘贴到“MailChimp API密钥”字段中。

或者，您可以添加您的API密钥到您的应用的YAML配置中

SilverWare\MailChimp\API\MailChimpAPI:
  api_key: <paste the key here>

站点配置中定义的密钥将优先于YAML密钥。

此模块提供了一个MailChimpSignup组件和一个MailChimpListField，用于在表单中使用。您可以使用CMS将MailChimpSignup组件添加到SilverWare模板和布局中。

MailChimpSignup组件是Ajax驱动的特定于MailChimp账户中某个邮件列表的注册表单。

如果您正确添加了API密钥，当您创建一个新的MailChimpSignup组件时，您将看到一个“邮件列表”下拉字段。选择您希望用户通过表单订阅的邮件列表。您还可以输入介绍性内容，该内容将显示在注册表单上方。

在选项选项卡上，您可以选择是否显示和/或必填姓和名字段。您还可以修改显示给用户的消息，例如当用户订阅、已订阅或遇到错误时。

如果表单验证正确，它将通过Ajax提交，并在表单上方显示适当的消息。如果Ajax提交不工作，控制器将处理常规POST提交。

MailChimpListField是普通DropdownField的扩展，通过MailChimp API连接并检索您的账户中的邮件列表。您可以在需要用户选择邮件列表的任何地方使用它

use SilverWare\MailChimp\Forms\MailChimpListField;

$field = MailChimpListField::create(
    'MailingListID',
    'Choose a mailing list'
);

为了提高性能并减少通过MailChimp API的流量，字段默认情况下将缓存邮件列表结果五分钟。您可以通过调用setCacheTimeout()方法并传递秒数作为参数来更改此设置

$field->setCacheTimeout(60);

请使用GitHub问题跟踪器提交错误报告和功能请求。

我们非常欢迎您的贡献，以帮助使此项目更完善。请参阅贡献指南获取更多信息。