oneup/contao-mailchimp

This extension connects a Contao installation with MailChimp.

4.10.0 2024-09-19 07:42 UTC

Requires

• php: ^7.4 || ^8.0
• ext-json: *
• codefog/contao-haste: ^5.0
• contao/core-bundle: ^4.13 || ^5.0
• oneup/mailchimp-api-v3: ^2.7
• patchwork/utf8: ^1.3
• symfony/event-dispatcher: ^4.4 || ^5.4 || ^6.4 || ^7.0

Requires (Dev)

• contao/manager-plugin: ^2.0
• friendsofphp/php-cs-fixer: ^3.9
• phpunit/phpunit: ^8.4

MIT

• David Greminger

• mailchimp
• email
• services
• marketing
• contao

README

This Contao bundle provides subscribe and unsubscribe forms for easy integration in Contao.

--

The fields that will be shown are managed through MailChimp's List fields and *|MERGE|* tags. You may also change the order of this fields: In MailChimp, go to Signup forms > General forms > Signup Form and rearrange the fields via drag'n'drop. You then have to import the new field order into Contao, by simply re-saving the MailChimp list in the back end.

How-to

Install using the command line composer require oneup/contao-mailchimp or by using the Contao Manager.

Requires of oneup/contao-mailchimp (Composer resolves this automatically)

• codefog/contao-haste
• contao/core-bundle
• oneup/mailchimp-api-v3
• patchwork/utf8

After installing the Contao MailChimp bundle you have to build a connection to MailChimp.

Login into the Contao Backend and go to Content > MailChimp:

• Create a new List
• Enter a name for your list
• Enter your MailChimp API Key
• Enter your subscriber List ID

Create four pages under Layout > Site Structure:

• Subscribe to the newsletter
• Subscribe confirmation
• Unsubscribe from the newsletter
• Unsubscribe confirmation

Go to Layout > Themes > Modules:

• Add a module of the type Subscribe form
• Choose your MailChimp List
• Choose the redirection page after subscription (Page: Subscribe to the newsletter)
• Choose whether you will use double opt-in for subscription
• Choose whether you will use the HTML5-Placeholder in the form fields or not
• Choose whether you will have the Contao captcha field
• Add a module of the type Unsubscribe form
• Choose your MailChimp List
• Choose the redirection page after unsubscription (Unsubscribe from the newsletter)
• Choose whether you will use the HTML5-Placeholder in the form fields or not
• Choose whether you will have the Contao captcha field

Go to Content > Articles:

• Insert the module of the type Subscribe form on the page Subscribe to the newsletter
• Insert the module of the type Unsubscribe form on the page Unsubscribe from the newsletter

Form Generator

You can also use forms of the form generator to subscribe to Mailchimp lists.

• Go to the settings of the form.
• In the Mailchimp section Enable Mailchimp.
• Select a Mailchimp list to subscribe to.
• Optionally select interest groups that new subscriptions should be assigned to by default.
• Optionally enter the name of a field which controls whether the subscription should take place or not (e.g. the field name of a newsletter checkbox).
• Optionally enable Mailchimp's double opt-in feature.
• Define the merge tags to map the form's input to the mailchimp list's fields. Note: you always need an EMAIL merge tag.
• Define optional added member tags.

Known limitations

• If the captcha option is activated and the same module is multiple times visible on the website, it won't work properly. E.g. if you have a subscription form in the footer and the same module somewhere in the content - it won't work. You'll have to have a different module for the footer then.