Skip to content

Nascom/mailchimp-bundle

 
 

Repository files navigation

mailchimp-bundle

Build Status Packagist Packagist GitHub license Documentation

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

About

MailChimp integration with Symfony and MailChimp API V3

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%