laravel-mailchimp

KO | EN

gitlite — search

#python #hacktoberfest #flask #discord #automation #python3 #react #api #machine-learning #css #javascript #nodejs

laravel-mailchimp

★ 96 Open GitHub ↗

A composer package for the MailChimp API PHP class (as provided by MailChimp) which supports the Laravel 4 framework.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Mailchimp API w. support for Laravel
---

The package supports use with the [Laravel framework][2] (v4) providing a `MailchimpWrapper` facade.

----

###Setup:

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

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

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

Add the following to the `providers` array:

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

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

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

Publish the configuration

```sh
$ 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][3]. Examples of actual usage can be found [Here][4] (**Warning**: Examples use CakePHP). Thanks to Laravel's use of the "Facade" design pattern, all methods may be called in the following manner:

```php
…
//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:

```php
<?php

use Hugofirth\Mailchimp\Facades\MailchimpWrapper;

class SomeClass
{
    public function someMethod()
    {
        MailchimpWrapper:: //You should be able to get auto completion here for the API methods/properties
    }
}
```

Enjoy!

[1]: http://apidocs.mailchimp.com/api/downloads/#php
[2]: http://laravel.com/
[3]: http://apidocs.mailchimp.com/api/1.3/
[4]: https://github.com/mailchimp/mcapi2-php-examples

laravel-mailchimp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README