Mailchimp API v3 wrapper, includes Laravel support.
Basic abstraction with Laravel integration for Mailchimp API v3
composer require nztim/mailchimp
config/app.php
: NZTim\Mailchimp\MailchimpServiceProvider::class,
'Mailchimp' => NZTim\Mailchimp\MailchimpFacade::class,
.env
value for MC_KEY
(your API key)php artisan vendor:publish --provider=NZTim\Mailchimp\MailchimpServiceProvider
Mailchimp
facade or inject NZTim\Mailchimp\Mailchimp
using the container.$mc = new NZTim\Mailchimp\Mailchimp($apikey)
// Get an array of all available lists:
Mailchimp::getLists();
// Get lists with parameters - get IDs of lists a user is subscribed to:
Mailchimp::getLists(['email' => '[email protected]', 'fields' => 'lists.id']);
// Check to see if an email address is subscribed to a list:
Mailchimp::check($listId, $emailAddress); // Returns boolean
// Check the staus of a subscriber:
Mailchimp::status($listId, $emailAddress); // Returns 'subscribed', 'unsubscribed', 'cleaned', 'pending', 'transactional' or 'not found'
// Get subscriber tags:
Mailchimp::getTags($listId, $emailAddress); // Returns array of Tag objects
// Add tags to a subscriber
Mailchimp::addTags($listId, $emailAddress, $tags); // $tags = ['tag1', 'tag2']
// Remove tags from a subscriber
Mailchimp::removeTags($listId, $emailAddress, $tags); // $tags = ['tag1', 'tag2']
// Remove all tags from a subscriber
Mailchimp::removeAllTags($listId, $emailAddress);
// Adds/updates an existing subscriber:
Mailchimp::subscribe($listId, $emailAddress, $merge = [], $confirm = true);
// Use $confirm = false to skip double-opt-in if you already have permission.
// This method will update an existing subscriber and will not ask an existing subscriber to re-confirm.
// Unsubscribe a member (set status to 'unsubscribed'):
Mailchimp::unsubscribe($listId, $emailAddress);
// Archive a member (no longer counts towards audience limits):
Mailchimp::archive($listId, $emailAddress);
// Permanently delete a member record:
Mailchimp::delete($listId, $emailAddress);
// Use with care: deleted members cannot be re-added without the user subscribing via a Mailchimp-hosted form with double-opt-in confirmation.
// Directly call the API:
Mailchimp::api($method, $endpoint, $data = []); // Returns an array.
For access to all the member properties available in the v3 API, use the Member class to subscribe and update list members:
$member = (new NZTim\Mailchimp\Member($email))
->merge_fields(['FNAME' => 'First name'])
->email_type('text')
->confirm(false);
Mailchimp::addUpdateMember($listId, $member);
As with the subscribe()
method, double-opt-in is default but existing members will not be asked to re-verify so you can use the same methods for create and update without needing to check.
ConnectionException
.NZTim\Mailchimp\MailchimpException
, e.g. incorrect API key, list does not exist.NZTim\Mailchimp\Exception\MailchimpBadRequestException
includes a response()
method that attempts to provide the response body as an array, for automated handling of some error types.Mailchimp::addUpdateMemberSkipMergeValidation()
is available if needed.// Laravel:
// Subscribe a user to your list, existing subscribers will not receive confirmation emails
Mailchimp::subscribe('listid', '[email protected]');
// Subscribe a user to your list with merge fields and double-opt-in confirmation disabled
Mailchimp::subscribe('listid', '[email protected]', ['FNAME' => 'First name', 'LNAME' => 'Last name'], false);
// Subscribe/update a user using the Member class
$member = (new NZTim\Mailchimp\Member($email))->interests(['abc123fed' => true])->language('th');
Mailchimp::addUpdateMember('listid', $member);
Mailchimp::subscribe()
as required