coderbyheart/mailchimp-bundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Thin abstraction layer for the MailChimp API 2.0.

v1.1.1 2014-11-10 12:04 UTC

Requires

• php: >=5.3.0
• doctrine/annotations: ~1.2.1
• kriswallsmith/buzz: >=0.11

Requires (Dev)

• codeclimate/php-test-reporter: ~0.1
• phpunit/phpunit: ~4.3

MIT

• Markus Tacker

README

Thin abstraction layer for the MailChimp API 2.0.

All API endpoints are implemented … by not implementing them but taking advantage of the API's naming conventions.

Getting started

Install with composer:

php composer.phar require coderbyheart/mailchimp-bundle

Enable the Bundle:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Coderbyheart\MailChimpBundle\CoderbyheartMailChimpBundle(),
    );
}

Configure the Bundle:

// app/config/config.yml

coderbyheart_mail_chimp:
    api_key:     123-us1  # the api key provided by mailchimp
    return_type: object   # return response data as 'object' or 'array'

Usage

$mailchimp = $container->get('mailchimp');
$lists = $mailchimp->listsList();

Documentation

The api endpoints are reached via a method call on the MailChimp API object instance. The method name is composed by concatenating the endpoint url. Parameters are provided via a hash as the methods argument.

API endpoint	Method	Arguments
lists/list	listsList
lists/batch-unsubscribe	listsBatch_unsubscribe	array('batch' => $batch)