digiageltd/mailchimp-laravel

A minimal service provider to set up and use the Mailchimp Api v2 PHP library in Laravel 5.*

1.0.10 2018-09-30 09:28 UTC

This package is not auto-updated.

Last update: 2021-12-02 23:11:03 UTC


README

The Mailchimp API v2.0 was deprecated from jan 1st 2017. This package uses the v2 API, because it relies on the Mailchimp PHP API Client, which uses the v2 API.

This package will not recieve updates for future Laravel versions.

Please use an api v3-compatible package instead, several are available on Packagist

skovmand/mailchimp-laravel

A minimal service provider to set up and use the Mailchimp API v2 PHP library in Laravel v5.*

For Laravel v4 check https://packagist.org/packages/hugofirth/mailchimp

How it works

This package contains a service provider, which binds an instance of an initialized Mailchimp client to the IoC-container.

You recieve the Mailchimp client through depencency injection already set up with your own API key.

Usage example

class NewsletterManager
{
    protected $mailchimp;
    protected $listId = '1234567890';        // Id of newsletter list

    /**
     * Pull the Mailchimp-instance from the IoC-container.
     */
    public function __construct(\Mailchimp $mailchimp)
    {
        $this->mailchimp = $mailchimp;
    }

    /**
     * Access the mailchimp lists API
     */
    public function addEmailToList($email)
    {
        try {
            $this->mailchimp
              ->lists
              ->subscribe(
                $this->listId,
                ['email' => $email]
              );
        } catch (\Mailchimp_List_AlreadySubscribed $e) {
            // do something
        } catch (\Mailchimp_Error $e) {
            // do something
        }
    }
}

Or you can manually instantiate the Mailchimp client by using:

$mailchimp = app('Mailchimp');

Setup

Step 1: Adding the dependency to composer.json

Add this to your composer.json in your Laravel folder. Note: Adding this dependency will automatically setup "mailchimp/mailchimp": "~2.0" too.

"require": {
    "skovmand/mailchimp-laravel": "1.*",
}

Step 2: Register the service provider

Register the service provider in config/app.php by inserting into the providers array

'providers' => [
  Skovmand\Mailchimp\MailchimpServiceProvider::class,
]

Step 3: From the command-line run

php artisan vendor:publish --provider="Skovmand\Mailchimp\MailchimpServiceProvider"

This will publish config/mailchimp.php to your config folder.

Step 4: Edit your .env file

MAILCHIMP_API_KEY="your-api-key-here"

Good to go!