prabpornpra/cakephp-mailchimp

CakePHP 2.x plugin for MailChimp

MailChimp

It is specific use for CakePHP plugin., _(*1)

Installation

Can install it via Composer or git submodule., _(*2)

Composer

composer install

or if you are already using composer, _(*3)

composer update 

Git Submodule

git submodule add https://github.com/prabpornpra/MailChimp.git pathForYourPluginFolder/nameThePlugin

Configuration

New for CakePHP 2.0, plugins need to be loaded manually in app/Config/bootstrap.php., _(*4)

CakePlugin::load('MailChimp')

In app/Config, create a php file and name it mail_chimp.php. Inside mail_chimp.php add these code below., _(*5)

$config['Chimp']['url'] = 'api.mailchimp.com/';
$config['Chimp']['key'] = "Your API Key from your MailChimp account"
$config['Chimp']['version'] = '2.0';
$config['Chimp']['lists_subscribe'] = '/lists/subscribe';
$config['Chimp']['lists_member_info'] = '/lists/member-info';

Usage

Version 1.0* has two methods, _(*6)

Subscribe email

Add an email into subscribe list, _(*7)

listSubscribe($listId, $params)

$listId: The list id to connect to, you can get it from your MailChimp account., _(*8)

$params: email for subscribe Ex:, _(*9)

$params = array (
  'email' => array('email' => 'your email')
);

You can add more option into $params, see the format in, http://apidocs.mailchimp.com/api/2.0/lists/subscribe.php If the method is called successfully, an confirmation email will be sent to the email that want to get subscribe., _(*10)

Check email status in subscribe list

getEmailStatus($listId, $email) 

$listId: The list id to connect to, you can get it from your MailChimp account., _(*11)

$email: The email that you want to check the status, _(*12)

This method will return a string status., _(*13)

Pending: The email confirmation is sent to this email, but the user haven't response yet.
Subscribe: This email is already subscribe in the list.
Unsubscribe: This email is unsubscribe in the list.
Not subscribe: This email haven't been subscribe in the list before.

License

MIT License See LICENSE file., _(*14)