Recommended releases

Download Links

This module provides integration with the MailChimp email delivery service.
While tools for sending email from your own server, like SimpleNews, are great,
they lack the sophistication and ease of use of dedicated email providers like
MailChimp. Other players in the field are Constant Contact and Campaign Monitor.

The core module provides basic configuration and API integration. Features and
site functionality are provided by a set of submodules that depend upon the core
"mailchimp" module. These are in the "modules" subdirectory: See their
respective README's for more details.

Features

  • API integration
  • Support for an unlimited number of mailing lists
  • Have anonymous sign up forms to subscribe site visitors to any combination
    of Mailchimp lists
  • Mailchimp list subscription via entity fields, allowing subscription rules
    to be governed by entity controls, permissions, and UI
  • Compatibility with Views Bulk Operations
  • Special VBO function for creating & updating static list segments
  • Allow users to subscribe during registration by adding a field to Users
  • Map Entity field values to your MailChimp merge fields
  • Standalone subscribe and unsubscribe forms
  • Subscriptions can be maintained via cron or in real time
  • Subscription forms can be created as pages or as blocks, with one or more
    list subscriptions on a single form
  • Include merge fields & interest groups on anonymous subscription forms
  • Create & send Mailchimp Campaigns from within Backdrop, using Backdrop entities
    as content.
  • Display a history of Mailchimp email and subscription activity on a tab for
    any Entity with an email address.

Upgrading from Drupal

An upgrade path is provided from Drupal's version 7.x-4.7 and later. Please
backup your database before attempting an upgrade.

Installation Notes

  • You need to have a MailChimp API Key.
  • You need to have at least one list created in MailChimp to use the
    mailchimp_lists module.
  • If you use a drush make workflow, see the example drush makefile:
    mailchimp.make.example.
  • The MailChimp PHP library must exist in your Backdrop installation.

MailChimp Library Installation

If you are using Libraries module for MailChimp version 7.x-4.x:

The library has dependencies managed by Composer. If you would prefer
not to use Composer, you can download the pre-built library package:
https://github.com/thinkshout/mailchimp-api-php/releases/download/v1.0.5/v1.0.5-package.zip

To use Composer:

  - Download Composer if you don't already have it installed:
    https://getcomposer.org/download/

  - Download the most recent release of the v3 API library:
    https://github.com/thinkshout/mailchimp-api-php/releases

  - Extract the library archive to libraries/mailchimp

  - Ensure the directory structure looks like this:

    - libraries/
      - mailchimp/
        - src/
          - Mailchimp.php
          - MailchimpAPIException.php
          - MailchimpCampaigns.php
          - MailchimpLists.php
          - MailchimpReports.php
          - MailchimpTemplates.php
        - composer.json
        - README.md

  - In the mailchimp library directory, run:
    composer install

If you are using Composer Manager for MailChimp version 7.x-4.x:

  - Download Composer if you don't already have it installed:
    https://getcomposer.org/download/

  - Download and install the Composer Manager module:
    https://www.drupal.org/project/composer_manager

  - Install Drush on your system if you haven't already:
    http://www.drush.org/en/master/

  - Run Composer manager with Drush within your Backdrop installation:
    drush composer-manager update --no-dev

Configuration

  1. Direct your browser to admin/config/services/mailchimp to configure the
    module.

  2. You will need to put in your Mailchimp API key for your Mailchimp account.
    If you do not have a Mailchimp account, go to
    http://www.mailchimp.com and sign up for a new
    account. Once you have set up your account and are logged in, visit:
    Account Settings -> Extras -> API Keys to generate a key.

  3. Copy your newly created API key and go to the
    Mailchimp config page in
    your Backdrop site and paste it into the Mailchimp API Key field.

  4. Batch limit - Maximum number of changes to process in a single cron run.
    Mailchimp suggest keeping this below 10000.

Submodules

  • mailchimp_signup: Create anonymous signup forms for your Mailchimp Lists,
    and display them as blocks or as standalone pages. Provide multiple-list
    subscription from a single form, include merge variables as desired, and
    optionally include Interest Group selection.

  • mailchimp_lists: Subscribe any entity with an email address to MailChimp
    lists by creating a mailchimp_list field, and allow anyone who can edit such
    an entity to subscribe, unsubscribe, and update member information. Also
    allows other entity fields to be synced to Mailchimp list Merge Fields. Add
    a Mailchimp Subscription field to your User bundle to allow Users to control
    their own subscriptions and subscribe during registration.

  • mailchimp_campaigns: Create and send campaigns directly from Backdrop, or just
    create them and use the Mailchimp UI to send them. Embed content from your
    Backdrop site by dropping in any Entity with a title and a View Mode
    configured into any area of your email template.

  • mailchimp_activity: Display a tab on any entity with an email address
    showing the email, subscribe, and unsubscribe history for that email address
    on your Mailchimp account.

LICENSE

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.

Credits and maintainers

The Drupal maintainers team https://www.drupal.org/project/mailchimp

Ported to Backdrop by docwilmot https://github.com/docwilmot