Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/1up-lab/contao-mailchimp
Contao bundle for MailChimp subscribe/unsubscribe forms (using MailChimp API V3.0)
https://github.com/1up-lab/contao-mailchimp
contao contao-mailchimp contao-module mailchimp
Last synced: about 2 months ago
JSON representation
Contao bundle for MailChimp subscribe/unsubscribe forms (using MailChimp API V3.0)
- Host: GitHub
- URL: https://github.com/1up-lab/contao-mailchimp
- Owner: 1up-lab
- License: mit
- Created: 2015-10-19T11:08:44.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T15:29:58.000Z (3 months ago)
- Last Synced: 2024-09-19T01:12:06.764Z (3 months ago)
- Topics: contao, contao-mailchimp, contao-module, mailchimp
- Language: PHP
- Homepage:
- Size: 129 KB
- Stars: 7
- Watchers: 6
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Contao Mailchimp Bundle
==========================
This Contao bundle provides subscribe and unsubscribe forms for easy integration in Contao.
[](https://twitter.com/1upgmbh)
[](LICENSE)
[](https://packagist.org/packages/oneup/contao-mailchimp)
--
The fields that will be shown are managed through MailChimp's [`List fields and *|MERGE|* tags`](http://kb.mailchimp.com/lists/managing-subscribers/set-default-merge-values-for-a-list). 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](https://contao.org/de/download.html).
### Requires of oneup/contao-mailchimp (Composer resolves this automatically)
- [codefog/contao-haste](https://github.com/codefog/contao-haste)
- [contao/core-bundle](https://github.com/contao/core-bundle)
- [oneup/mailchimp-api-v3](https://github.com/1up-lab/mailchimp-api-v3)
- [patchwork/utf8](https://github.com/tchwork/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](https://mailchimp.com/help/about-api-keys/#find+or+generate+your+api+key)
- Enter your subscriber [List ID](https://mailchimp.com/help/find-your-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.