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:
Please note the at the time of this writing the default merge variables in MailChimp are named
FNAMEandLNAME. In our examples we usefirstNameandlastNamefor extra readability. Make sure you rename those merge variables at MailChimp in order to make these examples work.
// at the top of your class
use Newsletter;
// ...
Newsletter::subscribe('[email protected]');
Newsletter::unsubscribe('[email protected]');
//Merge variables can be passed as the second argument
Newsletter::subscribe('[email protected]', ['firstName'=>'Sam', 'lastName'=>'Vines']);
//Subscribe someone to a specific list by using the third argument:
Newsletter::subscribe('[email protected]', ['firstName'=>'Nanny', 'lastName'=>'Ogg'], 'Name of your list');
//Subscribe someone to a specific list and require them to confirm via email:
Newsletter::subscribePending('[email protected]', ['firstName'=>'Nanny', 'lastName'=>'Ogg'], 'Name of your list');
//Subscribe or update someone
Newsletter::subscribeOrUpdate('[email protected]', ['firstName'=>'Foo', 'lastName'=>'Bar']);
// Change the email address of an existing subscriber
Newsletter::updateEmailAddress('[email protected]', '[email protected]');
//Get some member info, returns an array described in the official docs
Newsletter::getMember('[email protected]');
//Get the member activity, returns an array with recent activity for a given user
Newsletter::getMemberActivity('[email protected]');
//Get the members for a given list, optionally filtered by passing a second array of parameters
Newsletter::getMembers();
//Check if a member is subscribed to a list
Newsletter::isSubscribed('[email protected]');
//Returns a boolean
Newsletter::hasMember('[email protected]');
//If you want to do something else, you can get an instance of the underlying API:
Newsletter::getApi();Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
You can install this package via composer using:
composer require spatie/laravel-newsletterThe package will automatically register itself.
To publish the config file to config/newsletter.php run:
php artisan vendor:publish --provider="Spatie\Newsletter\NewsletterServiceProvider"This will publish a file newsletter.php in your config directory with the following contents:
return [
/*
* The API key of a MailChimp account. You can find yours at
* https://us10.admin.mailchimp.com/account/api-key-popup/.
*/
'apiKey' => env('MAILCHIMP_APIKEY'),
/*
* The listName to use when no listName has been specified in a method.
*/
'defaultListName' => 'subscribers',
/*
* Here you can define properties of the lists.
*/
'lists' => [
/*
* This key is used to identify this list. It can be used
* as the listName parameter provided in the various methods.
*
* You can set it to any string you want and you can add
* as many lists as you want.
*/
'subscribers' => [
/*
* A MailChimp 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'),
],
],
/*
* If you're having trouble with https connections, set this to false.
*/
'ssl' => true,
];There is a new name for our config file. We've changed the name from laravel-newsletter.php to newsletter.php.
If you are upgrading to 4.x, package is looking for the new config file name. In that case, you have to rename the file in your app\config folder.
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 an email address can be done like this:
use Newsletter;
Newsletter::subscribe('[email protected]');Let's unsubscribe someone:
Newsletter::unsubscribe('[email protected]');You can pass some merge variables as the second argument:
Newsletter::subscribe('[email protected]', ['firstName'=>'Rince', 'lastName'=>'Wind']);Please note the at the time of this writing the default merge variables in MailChimp are named
FNAMEandLNAME. In our examples we usefirstNameandlastNamefor extra readability.
You can subscribe someone to a specific list by using the third argument:
Newsletter::subscribe('[email protected]', ['firstName'=>'Rince', 'lastName'=>'Wind'], 'subscribers');That third argument is the name of a list you configured in the config file.
You can also subscribe and/or update someone. The person will be subscribed or updated if he/she is already subscribed:
Newsletter::subscribeOrUpdate('[email protected]', ['firstName'=>'Foo', 'lastname'=>'Bar']);You can subscribe someone to one or more specific group(s)/interest(s) by using the fourth argument:
Newsletter::subscribeOrUpdate('[email protected]', ['firstName'=>'Rince','lastName'=>'Wind'], 'subscribers', ['interests'=>['interestId'=>true, 'interestId'=>true]])Simply add false if you want to remove someone from a group/interest.
You can also unsubscribe someone from a specific list:
Newsletter::unsubscribe('[email protected]', 'subscribers');Deleting is not the same as unsubscribing. Unlike unsubscribing, deleting a member will result in the loss of all history (add/opt-in/edits) as well as removing them from the list. In most cases you want to use unsubscribe instead of delete.
Here's how to perform a delete:
Newsletter::delete('[email protected]');You can get information on a subscriber by using the getMember function:
Newsletter::getMember('[email protected]');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('[email protected]'); //returns a booleanIn addition to this you can also check if a user is subscribed to your list:
Newsletter::isSubscribed('[email protected]'); //returns a booleanThis the signature of createCampaign:
public function createCampaign(
string $fromName,
string $replyTo,
string $subject,
string $html = '',
string $listName = '',
array $options = [],
array $contentOptions = [])Note the campaign will only be created, no mails will be sent out.
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 booleanIf you need more functionality you get an instance of the underlying MailChimp Api with:
$api = Newsletter::getApi();Run the tests with:
vendor/bin/phpunitPlease see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
The MIT License (MIT). Please see License File for more information.