hurracane / mailchimp-bundle
MailChimp API V3 Symfony Bundle
2.0.0
2020-08-03 20:30 UTC
Requires
- php: >=7.2
- drewm/mailchimp-api: 2.5.*
- symfony/config: ^4.4|^5.0
- symfony/console: ^4.4|^5.0
- symfony/dependency-injection: ^4.4|^5.0
- symfony/event-dispatcher: ^4.4|^5.0
- symfony/event-dispatcher-contracts: ^1.1|^2.1
- symfony/framework-bundle: ^4.4|^5.0
- symfony/http-foundation: ^4.4|^5.0
- symfony/http-kernel: ^4.4|^5.0
- symfony/routing: ^4.4|^5.0
Requires (Dev)
- phpspec/phpspec: ^6.2
- phpunit/phpunit: ~5
README
Fork from https://github.com/welpdev/mailchimp-bundle
This bundle will help you synchronise your project's newsletter subscribers into MailChimp throught MailChimp API V3.
Features
- [x] Use your own userProvider (basic
FosSubscriberProvider
included to interface with FosUserBundle) - [x] Use your own listProvider (
DoctrineListProvider
included to retrieve your list from a database) - [x] Synchronize Merge Fields with your config
- [x] Synchronize your subscriber with a List
- [x] Use lifecycle event to subscribe/unsubscribe/delete subscriber from a List
- [x] Retrieve MailChimp Object to make custom MailChimp API V3 requests
- [x] Register Webhooks
Setup
Add bundle to your project:
composer require welp/mailchimp-bundle
Add Welp\MailchimpBundle\WelpMailchimpBundle
to your AppKernel.php
:
$bundles = [
// ...
new Welp\MailchimpBundle\WelpMailchimpBundle(),
];
Minimal Configuration
In your config.yml
:
welp_mailchimp:
api_key: YOURMAILCHIMPAPIKEY
More configuration on the documentation.
Full Documentation
Look at the full documentation at https://welpdev.github.io/mailchimp-bundle/
- Setup
- Configuration
- Subscriber Provider
- List Provider
- Usage
- Synchronize merge fields
- Full synchronization with command
- Unit synchronization with events
- Subscribe new User
- Unsubscribe a User
- Update a User
- Change User's email address (WORKAROUND)
- Delete a User
- Retrieve MailChimp Object to make custom MailChimp API V3 requests
- Webhook
- Update User when subscribe/unsubscribe
Contributing
If you want to contribute to this project, look at over here