E-mail Marketing Framework Module released : a framework for direct marketing services like Campaign Monitor and Mailchimp

Some time ago I released the Campaign Monitor Advanced module. A module that provides advanced integration with the excellent Campaign Monitor mailing list service. Cool stuff was available in it like support for multiple lists, automatic fetching of lists and fields from your Campaign Monitor account, asynchronous pushing of subscription and unsubscription requests and the ability to match Campaign Monitor custom fields to Drupal tokens, profile fields and PHP code. Cool huh?

Well, you'll be happy to know that all this stuff is available for more services then Campaign Monitor only. I have completely rewritten the module as a framework, called E-mail Marketing Framework, to make it work with virtually every mailing list service that provides an API to some of its functionality. Right now, out the box only MailChimp and Campaign Monitor integration is provided.

Do you work with another service and want to integrate it with Drupal? Well, other then starting from scratch have a look at this module. You can get all of its functionality for your own service if you just tell it how to do some simple tasks like (un)subscribing a user, fetch all available lists, fetch a list of custom fields on a list, ...

If you know some cool features that are missing, help them implement or let us know. We only have to implement them once and they'll be available for all all mailing list services that provide a plugin for this framework.

Have fun using this module.

Extra : writing plugins

Writing plugins for the framework to extend it with other services is quite easy. You just have to create a simple module (like you normally do in Drupal), implement hook_emf_info and you're done. Have a look at the MailChimp implementation that's in the tarball. Below is just a skelleton you could use for your own module.

<?php

/**
 * Implementation of hook_emf_info().
 */
function mailchimp_emf_info() {
  return array(
    'name' => 'MailChimp',
    'file' => 'mailchimp.api.inc',
  );
}

/**
 * Subscribe a user to a list.
 *
 * @param $email
 *   String; E-mail address to subscribe
 * @param $fields
 *   Array; Array of custom field values. Key is field. Value is value for the field.
 * @param $lid
 *   String; List ID of the list to subscribe to.
 * @return
 *   Boolean; TRUE if user is subscribed. FALSE if not.
 */
mailchimp_api_subscribe($email, $fields, $lid);

/**
 * Unsubscribe a user from a list.
 *
 * @param $email
 *   String; E-mail address to subscribe
 * @param $lid
 *   String; List ID of the list to subscribe to.
 * @return
 *   Boolean; TRUE if user is subscribed. FALSE if not.
 */
mailchimp_api_unsubscribe($email, $lid);

/**
 * Fetch subscribed subscribers from API.
 *
 * @param $date
 *   Mixed; If a string, should be in the date() format of 'Y-m-d H:i:s', otherwise, a Unix timestamp.
 * @param $lid
 *   String; List ID
 * @return
 *   Array; List of subscriber lists.
 */
mailchimp_api_get_subscribers_subscribed($date = 0, $lid = NULL);

/**
 * Fetch unsubscribed subscribers from API.
 *
 * @param $date
 *   Mixed; If a string, should be in the date() format of 'Y-m-d H:i:s', otherwise, a Unix timestamp.
 * @param $lid
 *   String; List ID
 * @return
 *   Array; List of subscriber lists.
 */
mailchimp_api_get_subscribers_unsubscribed($date = 0, $lid = NULL);

/**
 * Fetch lists from API.
 *
 * @return
 *   Array; List of subscriber lists.
 */
mailchimp_api_get_lists();

/**
 * Fetch custom fields for some list from API.
 *
 * @param $lid
 *   String; List ID of the list.
 * @return
 *   Array; List of custom fields.
 */
mailchimp_api_get_custom_fields($lid);