Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Easychimp

Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality

Easychimp makes integrating a PHP/Laravel app with Mailchimp's API (version 3) dead simple. Functionality is currently limited to managing subscriptions on a list because that's what I needed for a project. I'd welcome pull requests that add additional functionality.

Usage

$easychimp = new Easychimp\Easychimp($apiKey);
$easychimp->validateKey(); // throws InvalidApiKey
$list = $easychimp->mailingList($listId);

$list->exists(); // boolean
$list->isOnList($email); // boolean
$list->subscribe($email, $firstName = null, $lastName = null, ...); // boolean
$list->unsubscribe($email); // boolean
$list->subscriberInfo($email); // []
$list->updateSubscriber($email, $firstName = null, $lastName = null, ...); // boolean

// Interests are labeled as "Groups" in the Mailchimp UI
$list->interestCategories(); // []
$list->interests($interestCategoryId); // []

Installation

composer require bkuhl/easychimp:~1.0

<= Laravel 5.4

You can register the service provider in config/app.php

'providers' => [
    ...
    Easychimp\ServiceProvider::class,
]

To use the facade, add the following to config/app.php:

'aliases' => [
    ...
    'Easychimp' => Easychimp\MailchimpFacade::class,
]

Environment Variables

Define the MANDRILL_API_KEY environmental variable. Get your API key here.

About

Easychimp makes integrating a PHP/Laravel app with Mailchimp's API (version 3) dead simple.

Resources

License

Packages

No packages published

Languages

You can’t perform that action at this time.