This module provides integration with MailChimp, a popular email delivery service. The module makes it easy for website users or visitors to control which of your email lists they want to be on (or off), lets you generate and send MailChimp email campaigns from your site, and lets you and your users view a history of emails they have been sent from MailChimp. More generally, it aspires to makes your email delivery world efficient and to make your user's email receipt and control simple and precise. Thanks to MailChimp's ongoing sponsorship, this module is actively maintained and regularly adding features.
Features & Modules
The MailChimp core module provides all of the API integration functionality, and the ability to add your MailChimp API key and set a few settings. Unless you are writing your own functionality with MailChimp, it doesn't do much alone. The other features are broken out into the following sub-modules:
- Add a field to any entity with an email address field or property that connects directly to a list in MailChimp
- Display subscription status for Lists on entities, or a subscription form
- Subscription controlled on Entity creation (including User Registration if desired)
- Map entity fields to your MailChimp merge fields, including mapping fields on Field Collections and internal values on, for example, Addressfield fields
- Use Views Bulk Operations to create Mailchimp List Segments (Note: This VBO Patch may be needed depending on your versions)
- Create forms to allow site visitors to sign up for any Mailchimp List or combination of Lists
- Create Pages, Blocks, or both to display forms
- Create campaigns containing any Drupal entity, or entities, as content
- Send campaigns created in Drupal through MailChimp or Drupal
- View campaign statistics
- Display MailChimp history for any email address in Drupal
- Can be linked to any entity with an email address field, and can display on various entity types simultaneously
- As of November, 2010, MailChimp is sponsoring the maintenance and development of this project through its Integration Fund.
- Module development and maintenance by ThinkShout.
- Mandrill: MailChimp's transactional email service, replacing the deprecated STS service and module.
- MCC: An alternative campaign module.
All versions of this module rely on the Mailchimp API Library. The README provides instructions on where to install this library. If you use a drush make workflow, there is an example drush makefile as well. Don't forget this step!
The 8.x-1.x release uses version 3.0 of the MailChimp API and bundles the library with the module. This is a temporary solution until the process for installing libraries via composer is finalized in Drupal 8.
The 7.x-4.x release uses version 3.0 of the MailChimp API. A new library is available here and will need to replace the old library if you are upgrading the module from 7.x-3.x.
See README.txt for library installation instructions.
The 3.x release uses a new version of the MailChimp API library (2.0). If you are upgrading from 7.x-2.x, make sure to get the new version of the library.
The Upgrade Path from 7.x-2.x is entirely manual. You will need to disable & uninstall 2.x, then install 3.x to get started. To get your lists showing up on Users, you'll need to add the new Mailchimp Subscription field to your User bundle. To get your blocks, you must create them manually in the Mailchimp Signup interface. To recreate the 2.x Subscribe page, you also use the Signup UI. There are no more "Required Lists": if you have used Required Lists in conjunction with User Roles to control mailchimp list subscriptions based on Roles, you will need to use the Rules module in conjunction with the Mailchimp Lists module's custom Rules actions. For more details, see the README in the Mailchimp Lists module.
With the release of version 7.x-2.8, the MailChimp API library is no longer included with the module due to license incompatibility. This adds an extra step to the installation, and it may also add an extra step if you are upgrading from an earlier version. See the README for more details and proceed with care on upgrades to live sites.
As of 7.x-2.11, there are automated tests included with the mailchimp_lists module, and support built into the main module in form of a virtual API. We welcome additional tests, and you can help us help you by creating tests that match your particular use-cases. In order to run the tests, you must have the testing core module enabled, and you must be using an install profile that provides all of MailChimp's module dependencies, as the tests set themselves up using the active install profile.
Make sure your libraries module is version 2.0 before you install or upgrade MailChimp. Drupal will let this module install even if you have 1.0 despite the requirements specification in the MailChimp module, and the MailChimp install routine will break.