Wwwision.Neos.MailChimp

Package that integrates MailChimp® to your Neos site or Flow application.

Features

This package comes with two main features:

A MailChimp® subscription finisher for the Flow Form Framework
A simple Neos module that allows Neos administrators to manage MailChimp® lists and recipients

Usage

Install this package and make sure to resolve all dependencies. The easiest way to install this package is to add

"wwwision/neos-mailchimp": "^4.0"

To your Site package (or whichever package that uses the module or service) and install it and its dependencies via composer install.

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

Wwwision:
  Neos:
    MailChimp:
      apiKey: '<VALID_MAILCHIMP_API_KEY>'

Note: The API key can be obtained from mailchimp.com > Account > Extras > API Key

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

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

Displaying all lists
Displaying details of single lists including creation date, sender information, number of recipients
Displaying all members of a selected list
Removing members from a list
Subscribing new members to a list

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. It also adds the corresponding FormBuilder configuration so that the finisher can be used directly in the visual editor.

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: '<MAILCHIMP-LIST-ID>'
                properties:
                    placeholder: 'Your email address'
                defaultValue: ''
finishers:
    -
        identifier: 'Wwwision.Neos.MailChimp:MailChimpSubscriptionFinisher'
        options:
            listId: '<MAILCHIMP-LIST-ID>'
            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 "<MAILCHIMP-LIST-ID>" with a valid list identifier that can be obtained from mailchimp.com > Lists > <YOUR-LIST> > Settings > List name & defaults. A list ID usually contains letters and numbers such as "d2a96c360f".

The additionalFields option can be nested, for example in order to specify interest groups:

# ...
finishers:
    -
        identifier: 'Wwwision.Neos.MailChimp:MailChimpSubscriptionFinisher'
        options:
            listId: '<MAILCHIMP-LIST-ID>'
            additionalFields:
              'FNAME': '{firstName}'
              'LNAME': '{lastName}'
              'groupings':
                  -
                      id: '12345'
                      groups: ['Some group', 'Some other group']

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

Trivia

This package demonstrates...

...how to reuse Neos layouts and partials with Views.yaml

...how to create & configure a form finishers so that it can be used in the FormBuilder

...how to make use of Objects.yaml to initialize custom API clients

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

License

Licensed under GPLv3+, see LICENSE

Nikdro / Wwwision.Neos.MailChimp