A plugin to manage your Mailchimp campaigns from RefineryCMS
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Mailchimp engine for Refinery CMS

This project was originally sponsored by Mailchimp! Many thanks to them for supporting open source development.

How to use this engine with a Refinery CMS project

To set up a Refinery app from scratch, you'll need to install Refinery and create a new app:

gem install refinerycms
refinerycms new_project
cd new_project

Once you have a Refinery app created, add this engine to your Gemfile in the USER DEFINED area:

gem 'refinerycms-mailchimp'

Then, from the command line:

bundle install
rails generate refinerycms_mailchimp
rake db:migrate


You'll need to set up your Mailchimp API key in the Settings area. Get your API key here.

All available settings are:

  • mailchimp_api_key The API key of the Mailchimp account you wish to send campaigns from.
  • mailchimp_default_to_name The default To: name recipients will see (not email address). This can be changed for each campaign.
  • mailchimp_default_from_name The default From: name for your campaign message (not an email address). This can be changed for each campaign.
  • mailchimp_default_from_email The default From: email address for your campaign message. This can be changed for each campaign.

Using Templates

This plugin currently only supports one editable text area per campaign. If you use a template, the body will replace the template's MAIN area (see the Mailchimp docs on editable content areas).

How to run the test suite

Uncomment the following line in your Gemfile:

gem 'refinerycms-testing',    '~>'

Then install the testing functionality with

rails generate refinerycms_testing

You can now run all engine specs and features with rake, or run them separately with rake spec and rake cucumber.