welp / mailchimp-bundle
MailChimp API V3 Symfony Bundle
Installs: 310 301
Dependents: 1
Suggesters: 0
Security: 0
Stars: 44
Watchers: 10
Forks: 36
Open Issues: 5
Type:symfony-bundle
Requires
- php: >=5.6
- drewm/mailchimp-api: 2.5.*
Requires (Dev)
- phpspec/phpspec: ~2@dev
- phpunit/phpunit: ~5
- symfony/symfony: >=2.7
README
This bundle will help you synchronise your project's newsletter subscribers into MailChimp throught MailChimp API V3.
Features
- Use your own userProvider (basic
FosSubscriberProvider
included to interface with FosUserBundle) - Use your own listProvider (
DoctrineListProvider
included to retrieve your list from a database) - Synchronize Merge Fields with your config
- Synchronize your subscriber with a List
- Use lifecycle event to subscribe/unsubscribe/delete subscriber from a List
- Retrieve MailChimp Object to make custom MailChimp API V3 requests
- 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