https://github.com/welpdev/mailchimp-bundle
MailChimp integration with Symfony and MailChimp API V3
https://github.com/welpdev/mailchimp-bundle
bundle mailchimp mailchimp-api mailchimp-bundle packagist php symfony symfony-bundle symfony2 symfony3
Last synced: 12 months ago
JSON representation
MailChimp integration with Symfony and MailChimp API V3
- Host: GitHub
- URL: https://github.com/welpdev/mailchimp-bundle
- Owner: welpdev
- License: mit
- Created: 2016-08-30T07:51:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T14:45:53.000Z (about 2 years ago)
- Last Synced: 2025-03-30T18:11:08.241Z (12 months ago)
- Topics: bundle, mailchimp, mailchimp-api, mailchimp-bundle, packagist, php, symfony, symfony-bundle, symfony2, symfony3
- Language: PHP
- Homepage: https://welpdev.github.io/mailchimp-bundle/
- Size: 644 KB
- Stars: 44
- Watchers: 8
- Forks: 38
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mailchimp-bundle
[](https://travis-ci.org/welpdev/mailchimp-bundle)
[](https://packagist.org/packages/welp/mailchimp-bundle)
[](https://packagist.org/packages/welp/mailchimp-bundle)
[](https://raw.githubusercontent.com/welpdev/mailchimp-bundle/master/LICENSE.md)
[](https://welpdev.github.io/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](https://github.com/drewm/mailchimp-api) to make custom MailChimp API V3 requests
* [x] Register Webhooks
## Setup
Add bundle to your project:
```bash
composer require welp/mailchimp-bundle
```
Add `Welp\MailchimpBundle\WelpMailchimpBundle` to your `AppKernel.php`:
```php
$bundles = [
// ...
new Welp\MailchimpBundle\WelpMailchimpBundle(),
];
```
## Minimal Configuration
In your `config.yml`:
```yaml
welp_mailchimp:
api_key: YOURMAILCHIMPAPIKEY
```
More configuration on the [documentation](https://welpdev.github.io/mailchimp-bundle/configuration/).
## Full Documentation
Look at the full documentation at
* 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](https://github.com/drewm/mailchimp-api) 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](CONTRIBUTING.md)