svikramjeet / campaignmonitor
campaignmonitor - wrapper of official campaignmonitor php package
3.0
2020-03-04 07:28 UTC
Requires
- php: >7.1
- campaignmonitor/createsend-php: 5.0.*
- illuminate/support: ^7.0
Requires (Dev)
- php: >7.1
README
wrapper of campaign monitor php package
Laravel wrapper for CampaignMonitor APIs support Laravel 5 and 6
Installation
Pull in the package through Composer;
composer require svikramjeet/campaignmonitor
If you have auto-discover for Laravel packages, please skip this.
Add the service provider to config/app.php
Svikramjeet\CampaignMonitor\Providers\CampaignMonitorServiceProvider::class,
This package has a Laravel facade. You can register it in the aliases
array in the config/app.php
file
'CampaignMonitor' => Svikramjeet\CampaignMonitor\Facades\CampaignMonitor::class,
Publish the config file if you want to modify it.
$ php artisan vendor:publish --provider="Svikramjeet\CampaignMonitor\Providers\CampaignMonitorServiceProvider"
And set your own API key and Client ID via .env or similar to match these.
CAMPAIGNMONITOR_API_KEY=YourKey
CAMPAIGNMONITOR_CLIENT_ID=123456789
Usage
You can find all the methods in their package campaignmonitor/createsend-php package.
Some examples;
// Add a subscriber to a list $result = CampaignMonitor::subscribers('LIST_ID')->add([ 'EmailAddress' => 'email@example.com', 'Name' => 'Ben', 'ConsentToTrack' => 'No', // Yes, No, or Unchanged - now required by API v3.2 ]);
// Create a list for your client $result = CampaignMonitor::lists()->create(config('campaignmonitor.client_id'), [ 'Title' => 'List name', ]);
To send classic transactional emails
$data = [ 'From' => 'from@example.org', 'To' => 'to@example.org', 'ReplyTo' => 'replyto@example.org', 'CC' => 'cc@example.org', 'BCC' => 'bcc@example.org', 'HTML' => '<p>Hello there!</p>', 'Text' => 'Hello there!', 'ConsentToTrack' => 'No', // Yes, No, or Unchanged - now required by API v3.2 ]; CampaignMonitor::classicSend('CLIENT_ID')->send($data);