Mailchimp Module: Introduction

Last updated on
5 August 2021

Note: more documentation for the Mailchimp module is available in the README files of the submodules.

About

The Mailchimp module integrates with Mailchimp, the popular email delivery service. It is available for Drupal 6 - 9, although Drupal 6 is no longer supported and Drupal 7 is security-fixes-only at present.

Features

  1. Create subscription forms for any Mailchimp list and display as a Block and/or Page, with myriad configuration options.
  2. Enables logged-in users to manage their subscriptions from their account page.
  3. Allows users to subscribe to lists during registration.
  4. Map user tokens to Mailchimp merge fields.
  5. Allows subscriptions to be maintained via a batch process during cron or in real time.
  6. Optionally enable list "interest group" subscriptions, for more fine grained mailing list control.
  7. Integrate with the Mailchimp Events API to track user interactions with Webforms (or other events) in Mailchimp. (as of 2.1.x)

Installation Notes

All versions of Mailchimp require a version of the Mailchimp PHP library. If using Drupal 7, there is a makefile example for how to pull down this library, plus instructions in the README. For all versions, it is recommended that you install the module using composer, which will automatically retrieve the necessary library.

Enabling the "Mailchimp" module alone won't do much other than allow you to configure your connection to Mailchimp. To get additional features, enable the submodules:

  • Audiences (formerly "lists") -- Use this to attach signups to Users or other Drupal entities, where the entity or User is the one being subscribed using a (required) email field.
  • Signup -- Use this to create signup blocks or pages.
  • Campaign -- Use this to generate campaigns in Mailchimp using content on your Drupal site.
  • Events -- (introduced in 2.1.x) Create events in Mailchimp based on user interactions, especially Webform submissions.

Configure

  1. Configure the module at Administration > Configuration > Web services > Mailchimp (/admin/config/services/Mailchimp)
  2. Enter a Mailchimp API key

Tips

  1. Don't use test@example.com when testing Mailchimp; it's an invalid address and Mailchimp is good at validation so the tests will fail.
  2. Mailchimp has a TON of additional resources and documentation on their site at https://mailchimp.com/resources

More information

For support, questions, feature requests etc:

Help improve this page

Page status: No known problems

You can: