PHPackages                             silverware/mailchimp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. silverware/mailchimp

ActiveSilverstripe-vendormodule[Mail & Notifications](/categories/mail)

silverware/mailchimp
====================

SilverWare MailChimp Module.

1.2.1(7y ago)01811BSD-3-ClausePHPPHP >=5.6.0

Since Sep 12Pushed 7y ago1 watchersCompare

[ Source](https://github.com/praxisnetau/silverware-mailchimp)[ Packagist](https://packagist.org/packages/silverware/mailchimp)[ Docs](https://github.com/praxisnetau/silverware-mailchimp)[ RSS](/packages/silverware-mailchimp/feed)WikiDiscussions master Synced 6d ago

READMEChangelog (6)Dependencies (3)Versions (8)Used By (0)

SilverWare MailChimp Module
===========================

[](#silverware-mailchimp-module)

[![Latest Stable Version](https://camo.githubusercontent.com/df9a48e30014a8933650916075b482b37c52f8e1ee4f1d3ce6b77eda70f69f22/68747470733a2f2f706f7365722e707567782e6f72672f73696c766572776172652f6d61696c6368696d702f762f737461626c65)](https://packagist.org/packages/silverware/mailchimp)[![Latest Unstable Version](https://camo.githubusercontent.com/bf0b503158893abcbeee85c78178f22fea78ff3b283f80c6ee674a968e8a2735/68747470733a2f2f706f7365722e707567782e6f72672f73696c766572776172652f6d61696c6368696d702f762f756e737461626c65)](https://packagist.org/packages/silverware/mailchimp)[![License](https://camo.githubusercontent.com/3535b5f58df93f426a7da58cade3a34f1ca3078651b8ec996f3898de3a4a13b1/68747470733a2f2f706f7365722e707567782e6f72672f73696c766572776172652f6d61696c6368696d702f6c6963656e7365)](https://packagist.org/packages/silverware/mailchimp)

Provides an Ajax-powered [MailChimp](http://mailchimp.com) mailing list signup component and an API-driven mailing list dropdown field for use with [SilverWare](https://github.com/praxisnetau/silverware).

Contents
--------

[](#contents)

- [Requirements](#requirements)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Issues](#issues)
- [Contribution](#contribution)
- [Attribution](#attribution)
- [Maintainers](#maintainers)
- [License](#license)

Requirements
------------

[](#requirements)

- [SilverWare](https://github.com/praxisnetau/silverware)
- [SilverWare Validator](https://github.com/praxisnetau/silverware-validator)
- [MailChimp API](https://github.com/drewm/mailchimp-api)

Installation
------------

[](#installation)

Installation is via [Composer](https://getcomposer.org):

```
$ composer require silverware/mailchimp

```

Configuration
-------------

[](#configuration)

As with all SilverStripe modules, configuration is via YAML. Extensions and required JavaScript are defined by `config.yml`. You may also modify the default timeout for the API via YAML:

```
SilverWare\MailChimp\API\MailChimpAPI:
  default_timeout: 10
```

Before this module can be used, you will need to create a [MailChimp API key](https://kb.mailchimp.com/integrations/api-integrations/about-api-keys). Once you have created your API key, you can define it for your app in one of two ways:

- via site configuration (Settings tab)
- via YAML configuration file

This module will add a MailChimp tab to the Services tab under SilverWare in your site settings. You can paste your API key into the 'MailChimp API Key' field.

Alternatively, you can add your API key to YAML config for your app:

```
SilverWare\MailChimp\API\MailChimpAPI:
  api_key:
```

The key defined in site configuration will take precedence over the YAML key.

Usage
-----

[](#usage)

This module provides a `MailChimpSignup` component and a `MailChimpListField` for use within forms. The `MailChimpSignup` component can be added to your SilverWare templates and layouts using the CMS.

### MailChimp Signup Component

[](#mailchimp-signup-component)

[![MailChimp Signup Component](https://camo.githubusercontent.com/b43e4875ff0723ca46b6ec9f78051f7856298dc0d5d154833017d9c8443880ab/68747470733a2f2f692e696d6775722e636f6d2f525a6c743234332e706e67)](https://camo.githubusercontent.com/b43e4875ff0723ca46b6ec9f78051f7856298dc0d5d154833017d9c8443880ab/68747470733a2f2f692e696d6775722e636f6d2f525a6c743234332e706e67)

The `MailChimpSignup` component is an Ajax-powered signup form for a particular mailing list within your MailChimp account.

If you have added your API key correctly, when you create a new `MailChimpSignup` component you will see a 'Mailing List' dropdown field. Select the mailing list you would like users to subscribe to when using the form. You may also enter introductory content which will appear above the signup form.

On the Options tab, you can choose whether the fields for first and last names are shown and/or required. You may also modify the messages that are shown to users for certain events, such as when the user subscribes, is already subscribed, or encounters an error.

If the form validates correctly, it will be submitted via Ajax and the appropriate message will appear above the form. The controller will handle a regular POST submission if the Ajax submission does not work.

### MailChimp List Field

[](#mailchimp-list-field)

The `MailChimpListField` is an extension of a regular `DropdownField` that connects via the MailChimp API and retrieves the mailing lists within your account. You may use it anywhere you require a user to select a mailing list:

```
use SilverWare\MailChimp\Forms\MailChimpListField;

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

In order to improve performance and to also reduce traffic via the MailChimp API, the field will cache the mailing list results for five minutes by default. You can change this by calling the `setCacheTimeout()` method and passing the number of seconds as an argument:

```
$field->setCacheTimeout(60);
```

Issues
------

[](#issues)

Please use the [GitHub issue tracker](https://github.com/praxisnetau/silverware-mailchimp/issues) for bug reports and feature requests.

Contribution
------------

[](#contribution)

Your contributions are gladly welcomed to help make this project better. Please see [contributing](CONTRIBUTING.md) for more information.

Attribution
-----------

[](#attribution)

- Makes use of [MailChimp API](https://github.com/drewm/mailchimp-api) by [Drew McLellan](https://github.com/drewm).

Maintainers
-----------

[](#maintainers)

[![Colin Tucker](https://avatars3.githubusercontent.com/u/1853705?s=144)](https://github.com/colintucker)[![Praxis Interactive](https://avatars2.githubusercontent.com/u/1782612?s=144)](https://www.praxis.net.au)[Colin Tucker](https://github.com/colintucker)[Praxis Interactive](https://www.praxis.net.au)License
-------

[](#license)

[BSD-3-Clause](LICENSE.md) © Praxis Interactive

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~93 days

Recently: every ~117 days

Total

7

Last Release

2609d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f5d47a59cd183aa3f599c2b66dfce7c79c249c2eacb749f0ac8c38c4ca273d14?d=identicon)[PraxisNetAu](/maintainers/PraxisNetAu)

---

Top Contributors

[![colintucker](https://avatars.githubusercontent.com/u/1853705?v=4)](https://github.com/colintucker "colintucker (14 commits)")

---

Tags

mailchimpnewsletterssilverstripe-4silverwaresilverstripemailchimpnewsletterssilverware

### Embed Badge

![Health badge](/badges/silverware-mailchimp/health.svg)

```
[![Health](https://phpackages.com/badges/silverware-mailchimp/health.svg)](https://phpackages.com/packages/silverware-mailchimp)
```

###  Alternatives

[camfindlay/apes

The Automated Provision of Email Services (APES) module will allow you to set up an automated sync mechanism between the SilverStripe Member DataObject and MailChimp.

122.6k](/packages/camfindlay-apes)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)