2017 © Pedro Peláez
 

library mailchimp-api-php

PHP library for v3 of the MailChimp API

image

thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  • Tuesday, February 27, 2018
  • by tauno
  • Repository
  • 10 Watchers
  • 56 Stars
  • 224,223 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 30 Forks
  • 10 Open issues
  • 18 Versions
  • 18 % Grown

The README.md

PHP library for v3 of the Mailchimp API

This library provides convenient wrapper functions for Mailchimp's REST API. The API is documented here., (*1)

Requirements

  • PHP 5.4.0 or greater (7.0 or greater if you wish to use phpunit)
  • Composer
  • Guzzle

Installation

Dependencies are managed by Composer. After installing Composer, run the following command from the library root:, (*2)

composer install --no-dev --ignore-platform-reqs, (*3)

Or to install with phpunit:, (*4)

composer install, (*5)

Usage

Get your account information

A basic test to confirm the library is set up and functional., (*6)

<?php
require 'PATH_TO_LIBRARY/mailchimp-api-php/vendor/autoload.php';
$api_key = 'YOUR_API_KEY';
$mailchimp = new Mailchimp\Mailchimp($api_key);

// Get the account details of the authenticated user.
$response = $mailchimp->getAccount();

// Output the account details.
if (!empty($response) && isset($response->account_id)) {
  echo "ID: {$response->account_id}\n"
  . "Name: {$response->account_name}\n";
}

Get lists and their interest categories

A more complicated example that takes the response from one API call and uses that data to make another., (*7)

<?php
require 'PATH_TO_LIBRARY/mailchimp-api-php/vendor/autoload.php';
$api_key = 'YOUR_API_KEY';
$mailchimp_lists = new Mailchimp\MailchimpLists($api_key);

// Get all lists.
$response = $mailchimp_lists->getLists();

if (!empty($response) && isset($response->lists)) {
  foreach ($response->lists as $list) {
    // Output the list name.
    echo "List name: {$list->name}\n";

    // Get the list's interest categories.
    $interests = $mailchimp_lists->getInterestCategories($list->id);

    // Output the names of the list's interest categories.
    if (!empty($interests) && isset($interests->categories)) {
      foreach ($interests->categories as $category) {
        echo "Interest category: {$category->title}\n";
      }
    }
  }
}

Testing

This library includes a PHPUnit test suite., (*8)

Running PHPUnit tests

Add Composer's vendor directory to your PATH by adding the following line to your profile. This is dependent on your system, but on a Linux or Mac OSX system using Bash, you'll typically find the file at ~/.bash_profile., (*9)

export PATH="./vendor/bin:$PATH", (*10)

Bash example:, (*11)

echo 'export PATH="./vendor/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile

Then run PHPUnit:, (*12)

phpunit, (*13)

Mailchimp API Playground

Mailchimp's API Playground provides access to all API methods via a web-based UI. You can use this to test API calls and review data you've sent to Mailchimp., (*14)

The Versions

27/02 2018

dev-master

9999999-dev https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

27/02 2018

2.0.0

2.0.0.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

27/12 2017

1.0.10

1.0.10.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

20/11 2017

1.0.9

1.0.9.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

15/11 2017

dev-connected-sites

dev-connected-sites https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

02/10 2017

1.0.8

1.0.8.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

29/09 2017

dev-get-member-by-id

dev-get-member-by-id https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

14/07 2017

dev-http-client

dev-http-client https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

16/06 2017

1.0.7

1.0.7.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

18/02 2017

1.0.6

1.0.6.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

08/11 2016

1.0.5

1.0.5.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

08/11 2016

dev-http-fallback

dev-http-fallback https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

06/09 2016

1.0.4

1.0.4.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

27/07 2016

dev-ecommerce

dev-ecommerce https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

19/07 2016

1.0.3

1.0.3.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

10/06 2016

1.0.2

1.0.2.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

09/05 2016

1.0.1

1.0.1.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp

14/04 2016

1.0

1.0.0.0 https://github.com/thinkshout/mailchimp-api-php

PHP library for v3 of the MailChimp API

  Sources   Download

The Requires

 

The Development Requires

mail mailchimp