PHPackages                             wwwision/neos-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 &amp; Notifications](/categories/mail)
4. /
5. wwwision/neos-mailchimp

ActiveNeos-package[Mail &amp; Notifications](/categories/mail)

wwwision/neos-mailchimp
=======================

Flow package that integrates MailChimp into your Neos site / Flow Application

5.6.0(2y ago)2310.7k21[1 issues](https://github.com/bwaidelich/Wwwision.Neos.MailChimp/issues)GPL-3.0+PHP

Since Dec 25Pushed 2y ago3 watchersCompare

[ Source](https://github.com/bwaidelich/Wwwision.Neos.MailChimp)[ Packagist](https://packagist.org/packages/wwwision/neos-mailchimp)[ GitHub Sponsors](https://github.com/sponsors/bwaidelich)[ Fund](https://www.paypal.me/bwaidelich)[ RSS](/packages/wwwision-neos-mailchimp/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (28)Used By (0)

Wwwision.Neos.MailChimp
=======================

[](#wwwisionneosmailchimp)

Package that integrates [MailChimp](http://mailchimp.com/)® to your [Neos](https://www.neos.io) site or [Flow](https://flow.neos.io) application.

Features
--------

[](#features)

This package comes with two main features:

1. A *MailChimp® subscription finisher* for the [Flow Form Framework](https://flow-form-framework.readthedocs.io/en/stable/)
2. A simple *Neos* module that allows Neos administrators to manage MailChimp® lists and recipients

Usage
-----

[](#usage)

Install this package and make sure to resolve all dependencies. The easiest way to install this package is to use [composer](https://getcomposer.org/):

```
composer require wwwision/neos-mailchimp

```

After successful installation make sure to configure the MailChimp® API key in the `Settings.yaml`of your Site package:

```
Wwwision:
  Neos:
    MailChimp:
      apiKey: ''
```

**Note:** The API key can be obtained from `mailchimp.com > Account > Extras > API keys`

Done. You can now log-in to the Neos backend (as administrator) and manage your newsletter lists and recipients in the new Module `administration/mailchimp` (Make sure to flush the browser caches if the module should not appear in the menu).

Neos Module
-----------

[](#neos-module)

The module is pretty simple and self-explanatory. Currently it allows for:

1. Displaying all lists
2. Displaying details of single lists including creation date, sender information, number of recipients
3. Displaying all members of a selected list
4. Removing members from a list
5. Subscribing new members to a list

[![Screenshot of the lists module](/Module_Lists.png "Neos module for managing MailChimp® lists")](/Module_Lists.png)[![Screenshot of the members](/Module_Members.png "Neos module for managing MailChimp® members")](/Module_Members.png)

Form Finisher
-------------

[](#form-finisher)

This package also comes with a simple form finisher that allows for creation of simple Newsletter subscription forms using the *Flow Form Framework*.

Alternatively you can save the following snippet to `Data/Forms/newsletter.yaml` to create a simple newsletter subscription form:

```
type: 'Neos.Form:Form'
identifier: mailchimp
label: Mailchimp
renderables:
    -
        type: 'Neos.Form:Page'
        identifier: page1
        label: 'Page 1'
        renderables:
            -
                type: 'Neos.Form:SingleLineText'
                identifier: 'firstName'
                label: 'First name'
                validators:
                    -
                        identifier: 'Neos.Flow:NotEmpty'
                properties:
                    placeholder: 'Your first name'
                defaultValue: ''
            -
                type: 'Neos.Form:SingleLineText'
                identifier: 'lastName'
                label: 'Last name'
                validators:
                    -
                        identifier: 'Neos.Flow:NotEmpty'
                properties:
                    placeholder: 'Your last name'
                defaultValue: ''
            -
                type: 'Neos.Form:SingleLineText'
                identifier: 'email'
                label: 'E-Mail'
                validators:
                    -
                        identifier: 'Neos.Flow:NotEmpty'
                    -
                        identifier: 'Neos.Flow:EmailAddress'
                    -
                        identifier: 'Wwwision.Neos.MailChimp:UniqueSubscription'
                        options:
                          listId: ''
                properties:
                    placeholder: 'Your email address'
                defaultValue: ''
finishers:
    -
        identifier: 'Wwwision.Neos.MailChimp:MailChimpSubscriptionFinisher'
        options:
            listId: ''
            additionalFields:
              'FNAME': '{firstName}'
              'LNAME': '{lastName}'
    -
        identifier: 'Neos.Form:Confirmation'
        options:
            message: 'Thank you, your subscription was successful. Please check your email.'
renderingOptions:
    submitButtonLabel: ''
```

**Note:** Replace the two "&lt;MAILCHIMP-AUDIENCE-ID&gt;" with a valid audience (list) identifier that can be obtained from `mailchimp.com > Audience >  > Settings > Audience name & defaults`. An Audience ID usually contains numbers such as "1243568790".

With `interestGroups` option you can set fixed or dynamic interest groups for the user to subscribe to.

```
# ...
finishers:
    -
        identifier: 'Wwwision.Neos.MailChimp:MailChimpSubscriptionFinisher'
        options:
            listId: ''
            additionalFields:
              'FNAME': '{firstName}'
              'LNAME': '{lastName}'
            interestGroups:
              - 'abc123abc1'
              - 'def123def1'
              - '{interestGroups}' // Placeholder for single value fields (e.g. select box)
              ...
              - '{interestGroups.0}' // Placeholder for multi value fields (e.g. check boxes)
              - '{interestGroups.1}'
```

The Form finisher can of course be used without Neos (i.e. for Newsletter-subscriptions within plain Flow applications).

DataSources
-----------

[](#datasources)

### Interest Categories

[](#interest-categories)

Returns a list of all interest categories with ids and label in the subscription list.

DataSourceIdentifier: `mailchimp-interest-category`

dataSourceAdditionalData:

- `listId` - (string) Id of subscription list

### Interests

[](#interests)

Returns a list of all interests with ids and label of the given category in the subscription list.

DataSourceIdentifier: `mailchimp-interest`

dataSourceAdditionalData:

- `listId` - (string) Id of subscription list
- `categoryId` - (string) Id of interest category

### Example NodeType configuration

[](#example-nodetype-configuration)

```
  ...
  properties:
    subscriptionList:
      type: string
      defaultValue: ''
      ui:
        label: Subscription list id
    category:
      type: string
      defaultValue: ''
      ui:
        label: Category
        inspector:
          hidden: 'ClientEval:node.properties.subscriptionList != "" ? false : true'
          editor: Neos.Neos/Inspector/Editors/SelectBoxEditor
          editorOptions:
            allowEmpty: true
            dataSourceIdentifier: mailchimp-interest-category
            dataSourceAdditionalData:
              listId: ClientEval:node.properties.subscriptionList
    interestId:
      type: string
      defaultValue: ''
      ui:
        label: Interest
        inspector:
          group: categories
          hidden: 'ClientEval:node.properties.category != "" ? false : true'
          editor: Neos.Neos/Inspector/Editors/SelectBoxEditor
          editorOptions:
            allowEmpty: true
            dataSourceIdentifier: mailchimp-interest
            dataSourceAdditionalData:
              listId: ClientEval:node.properties.subscriptionList
              categoryId: ClientEval:node.properties.category
```

Trivia
------

[](#trivia)

This package demonstrates...

...how to reuse Neos layouts and partials with [Views.yaml](http://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartIII/ModelViewController.html#configuring-views-through-views-yaml)

...how to create &amp; configure a form finishers so that it can be used in the Form definition

...how to make use of [Objects.yaml](http://flowframework.readthedocs.io/en/stable/TheDefinitiveGuide/PartIII/ObjectManagement.html#configuring-objects) to initialize custom API clients

...how to make arbitrary result sets countable and "paginatable" using a `CallbackQueryResult` object

FAQ
---

[](#faq)

- I get an error `No MailChimp lists found. Did you configure the API key correctly at Wwwision.Neos.MailChimp.apiKey?`, what's wrong with me?
    - Make sure you have configured the API key in the Settings *and* in the form finisher configuration as described above. If that's the case, make sure your Package dependency is correct. That means: The package that configures the API key must require the `wwwision/neos-mailchimp` package in the `composer.json` manifest. Otherwise the loading order is incorrect and the API key might be overridden by the default settings

License
-------

[](#license)

Licensed under GPLv3+, see [LICENSE](LICENSE)

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity73

Established project with proven stability

 Bus Factor1

Top contributor holds 60.9% 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 ~137 days

Recently: every ~338 days

Total

24

Last Release

994d ago

Major Versions

1.0.x-dev → 2.0.02016-07-13

2.2.0 → 3.0.02017-01-04

3.0.0 → 4.0.02017-01-31

3.0.x-dev → 5.0.02018-05-09

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/307571?v=4)[Bastian Waidelich](/maintainers/bwaidelich)[@bwaidelich](https://github.com/bwaidelich)

---

Top Contributors

[![bwaidelich](https://avatars.githubusercontent.com/u/307571?v=4)](https://github.com/bwaidelich "bwaidelich (39 commits)")[![dlubitz](https://avatars.githubusercontent.com/u/13046100?v=4)](https://github.com/dlubitz "dlubitz (13 commits)")[![kdambekalns](https://avatars.githubusercontent.com/u/95873?v=4)](https://github.com/kdambekalns "kdambekalns (7 commits)")[![jobee](https://avatars.githubusercontent.com/u/5636715?v=4)](https://github.com/jobee "jobee (2 commits)")[![dfeyer](https://avatars.githubusercontent.com/u/221173?v=4)](https://github.com/dfeyer "dfeyer (1 commits)")[![bweinzierl](https://avatars.githubusercontent.com/u/30659291?v=4)](https://github.com/bweinzierl "bweinzierl (1 commits)")[![mrimann](https://avatars.githubusercontent.com/u/1093784?v=4)](https://github.com/mrimann "mrimann (1 commits)")

### Embed Badge

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

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

###  Alternatives

[minishlink/web-push

Web Push library for PHP

1.9k12.0M53](/packages/minishlink-web-push)[laravel-notification-channels/twilio

Provides Twilio notification channel for Laravel

2587.7M12](/packages/laravel-notification-channels-twilio)[spatie/url-signer

Generate a url with an expiration date and signature to prevent unauthorized access

4422.3M16](/packages/spatie-url-signer)[mattketmo/email-checker

Throwaway email detection library

2742.0M5](/packages/mattketmo-email-checker)[eduardokum/laravel-mail-auto-embed

Library for embed images in emails automatically

1702.0M5](/packages/eduardokum-laravel-mail-auto-embed)[netflie/laravel-notification-whatsapp

Laravel notification driver for WhatsApp

176173.9k](/packages/netflie-laravel-notification-whatsapp)

PHPackages © 2026

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