PHPackages                             hugofirth/mailchimp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. hugofirth/mailchimp

ActiveLibrary

hugofirth/mailchimp
===================

Wrapper on the Mailchimp class provided by Mailchimp - with support for Laravel 4. v2.0.0 supports Mailchimp API verion 2.0

v2.0.3(12y ago)96121.6k↓26.7%26[13 issues](https://github.com/hugofirth/laravel-mailchimp/issues)[2 PRs](https://github.com/hugofirth/laravel-mailchimp/pulls)MITPHPPHP >=5.3.0

Since Aug 30Pushed 7y ago6 watchersCompare

[ Source](https://github.com/hugofirth/laravel-mailchimp)[ Packagist](https://packagist.org/packages/hugofirth/mailchimp)[ RSS](/packages/hugofirth-mailchimp/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (2)Versions (6)Used By (0)

Mailchimp API w. support for Laravel
------------------------------------

[](#mailchimp-api-w-support-for-laravel)

The package supports use with the [Laravel framework](http://laravel.com/) (v4) providing a `MailchimpWrapper` facade.

---

\###Setup:

In order to install add the following to your `composer.json` file within the `require` block:

```
"require": {
    …
    "hugofirth/mailchimp": "2.0.*",
    …
}
```

Within Laravel, locate the file `..app/config/app.php` \*.

Add the following to the `providers` array:

```
'providers' => array(
    …
    'Hugofirth\Mailchimp\MailchimpServiceProvider',
    …
),
```

Furthermore, add the following the the `aliases` array:

```
'aliases' => array(
    …
    'MailchimpWrapper'       => 'Hugofirth\Mailchimp\Facades\MailchimpWrapper',
    …
),
```

Publish the configuration

```
$ php artisan config:publish hugofirth/mailchimp
```

Lastly, run the command `composer update`.

*\* The subsequent steps should be repeated for any file `app.php` created for additional environments.*

---

\###Usage:

Your unique MailChimp API key should be set in the package's config found in `app/config/packages/hugofirth/mailchimp/config.php`

Methods of the MailChimp api class work as described by the MailChimp API docs found [Here](http://apidocs.mailchimp.com/api/1.3/). Examples of actual usage can be found [Here](https://github.com/mailchimp/mcapi2-php-examples) (**Warning**: Examples use CakePHP). Thanks to Laravel's use of the "Facade" design pattern, all methods may be called in the following manner:

```
…
//Retrieve an array of lists for your account
$lists = MailchimpWrapper::lists()->getList()['data'];
…
//Subscribe a user, with email: $email_address, to a list with id: $list_id
MailchimpWrapper::lists()->subscribe($list_id, array('email'=>$email_address));
```

In order to allow for auto-completion, you can include a use statement for the Facade:

```