PHPackages mbouclas/mcms-mailchimp - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Mail & Notifications](/categories/mail) 4. / 5. mbouclas/mcms-mailchimp ActiveLibrary[Mail & Notifications](/categories/mail) mbouclas/mcms-mailchimp ======================= Mailchimp package for mcms v1.1.0(7y ago)057MITPHPPHP ~5.5|~7.0 Since Oct 29Pushed 7y ago1 watchersCompare [ Source](https://github.com/mbouclas/mcms-mailchimp)[ Packagist](https://packagist.org/packages/mbouclas/mcms-mailchimp)[ RSS](/packages/mbouclas-mcms-mailchimp/feed)WikiDiscussions master Synced 3w ago READMEChangelogDependencies (5)Versions (11)Used By (0) ### MCMS Mailchimp [](#mcms-mailchimp) This package provides an easy way to integrate MailChimp with Laravel 5. Behind the scenes v3 for the MailChimp API is used. Here are some examples of what you can do with the package: ``` Newsletter::subscribe('rincewind@discworld.com'); Newsletter::unsubscribe('the.luggage@discworld.com'); //Merge variables can be passed as the second argument Newsletter::subscribe('sam.vines@discworld.com', ['firstName'=>'Sam', 'lastName'=>'Vines']); //Subscribe someone to a specific list by using the third argument: Newsletter::subscribe('nanny.ogg@discworld.com', ['firstName'=>'Nanny', 'lastName'=>'Ogg'], 'Name of your list'); //Get some member info, returns an array described in the official docs Newsletter::getMember('lord.vetinari@discworld.com'); //Returns a boolean Newsletter::hasMember('greebo@discworld.com'); //If you want to do something else, you can get an instance of the underlying API: Newsletter::getApi(); ``` Installation ------------ [](#installation) You can install this package via Composer using: ``` composer require mbouclas/mcms-mailchimp ``` You must also install this service provider. ``` // config/app.php 'providers' => [ ... Mcms\Mailchimp\McmsMailchimpServiceProvider::class, ... ]; ``` To publish the config file to `app/config/mcmcMailchimp.php` run: ``` php artisan vendor:publish --provider="Mcms\Mailchimp\McmsMailchimpServiceProvider" ``` This will publish a file `mcmcMailchimp.php` in your config directory with the following contents: ``` return [ /* * The api key of a MailChimp account. You can find yours here: * https://us10.admin.mailchimp.com/account/api-key-popup/ */ 'apiKey' => env('MAILCHIMP_APIKEY'), /* * When not specifying a listname in the various methods, * this list name will be used. */ 'defaultListName' => 'subscribers', /* * Here you can define properties of the lists you want to * send campaigns. */ 'lists' => [ /* * This key is used to identify this list. It can be used * in the various methods provided by this package. * * You can set it to any string you want and you can add * as many lists as you want. */ 'subscribers' => [ /* * A mail chimp list id. Check the mailchimp docs if you don't know * how to get this value: * http://kb.mailchimp.com/lists/managing-subscribers/find-your-list-id */ 'id' => env('MAILCHIMP_LIST_ID'), ], ], ]; ``` Usage ----- [](#usage) After you've installed the package and filled in the values in the config-file working with this package will be a breeze. All the following examples use the facade. Don't forget to import it at the top of your file. ``` use Newsletter; ``` ### Subscribing and unsubscribing [](#subscribing-and-unsubscribing) Subscribing an email address can be done like this: ``` use Newsletter; Newsletter::subscribe('rincewind@discworld.com'); ``` Let's unsubscribe someone: ``` Newsletter::unsubscribe('the.luggage@discworld.com'); ``` You can pass some merge variables as the second argument: ``` Newsletter::subscribe('rincewind@discworld.com', ['firstName'=>'Rince', 'lastName'=>'Wind']); ``` Please note the at the time of this writing the default merge variables in MailChimp are named `FNAME` and `LNAME`. In our examples we use `firstName` and `lastName` for extra readability. You can subscribe someone to a specific list by using the third argument: ``` Newsletter::subscribe('rincewind@discworld.com', ['firstName'=>'Rince', 'lastName'=>'Wind'], 'subscribers'); ``` That third argument is the name of a list you configured in the config file. You can also unsubscribe someone from a specific list: ``` Newsletter::unsubscribe('rincewind@discworld.com', 'subscribers'); ``` ### Deleting subscribers [](#deleting-subscribers) NOTE: Deleting is not the same as unsubscribing. Deleting loses all history (add/opt-in/edits) as well as removing them from the list. Unlike an unsubscribe, they can still be added back again later. This is for list-maintenance only. If a subscriber is "opting out", you should `unsubscribe` instead! To delete a subscriber's record from the list permanently: ``` Newsletter::delete('rincewind@discworld.com'); ``` ### Getting subscriber info [](#getting-subscriber-info) You can get information on a subscriber by using the `getMember` function: ``` Newsletter::getMember('lord.vetinari@discworld.com'); ``` This will return an array with information on the subscriber. If there's no one subscribed with that e-mail address the function will return `false` There's also a convenience method to check if someone is already subscribed: ``` Newsletter::hasMember('nanny.ogg@discworld.com'); //returns a bool ``` ### Creating a campaign [](#creating-a-campaign) This is how you create a campaign: ``` /** * @param string $fromName * @param string $replyTo * @param string $subject * @param string $html * @param string $listName * @param array $options * @param array $contentOptions * * @return array|bool * * @throws \Mcms\Mailchimp\Exceptions\InvalidMailchimpList */ public function createCampaign($fromName, $replyTo, $subject, $html = '', $listName = '', $options = [], $contentOptions = []) ``` Note the campaign will only be created, no mails will be sent out. ### Handling errors [](#handling-errors) If something went wrong you can get the last error with: ``` Newsletter::getLastError(); ``` If you just want to make sure if the last action succeeded you can use: ``` Newsletter::lastActionSucceeded(); //returns a bool ``` ``` $api = Newsletter::getApi(); ``` Testing ------- [](#testing) Run the tests with: ``` vendor/bin/phpunit ``` License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 28 — LowBetter than 52% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity8 Limited adoption so far Community7 Small or concentrated contributor base Maturity64 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~99 days Recently: every ~142 days Total 10 Last Release 2636d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/642742?v=4)[Michael Bouclas](/maintainers/mbouclas)[@mbouclas](https://github.com/mbouclas) --- Top Contributors [![mbouclas](https://avatars.githubusercontent.com/u/642742?v=4)](https://github.com/mbouclas "mbouclas (15 commits)") ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/mbouclas-mcms-mailchimp/health.svg) ``` [![Health](https://phpackages.com/badges/mbouclas-mcms-mailchimp/health.svg)](https://phpackages.com/packages/mbouclas-mcms-mailchimp) ``` ### Alternatives [propaganistas/laravel-disposable-email Disposable email validator 6012.9M7](/packages/propaganistas-laravel-disposable-email)[illuminate/mail The Illuminate Mail package. 5910.4M475](/packages/illuminate-mail)[illuminate/notifications The Illuminate Notifications package. 483.0M1.1k](/packages/illuminate-notifications)[erag/laravel-disposable-email A Laravel package to detect and block disposable email addresses. 252143.0k](/packages/erag-laravel-disposable-email)[statamic-rad-pack/mailchimp Subscribe registrations or contact forms to Mailchimp 1821.0k](/packages/statamic-rad-pack-mailchimp) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)