eblix/eblix-mailchimp

Mailchimp API Integration

1.1 2018-02-23 10:57 UTC

This package is not auto-updated.

Last update: 2024-03-24 05:56:34 UTC


README

Laravel 5.5 package to create, update and delete MailChimp lists and members.

Requirements

PHP version >= 7.0.0

CURL version ^7.1.7

Laravel Framework >= 5.5

Instalation

First run composer command

composer require eblix/eblix-mailchimp

Then run migrations using

php artisan migrate

Then run database seeds using

php artisan db:seed --class="Eblix\Mailchimp\Database\Seeds\CountryTableSeeder"

Next step is to publish package

php artisan vendor:publish --provider="Eblix\Mailchimp\EblixMailchimpServiceProvider"

Usage

Config file

Package config can be found in mailchimp.php file under config directory (after you published it). Config file contains MailChimp API Key which is required to connect with MailChimp and default values for the contact information for the list. You can edit default values here and passing parameter values to create and update lists.

[
    'MAILCHIMP_API_KEY' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-usXX', //Your Mailchimp API Key which is required

    //Your Contact & Other Details
    
    'CONTACT_COMPANY' => 'Company Name',
    'CONTACT_ADDRESS1' => 'Address',
    'CONTACT_ADDRESS2' => 'Address',
    'CONTACT_CITY' => 'City',
    'CONTACT_STATE' => 'State',
    'CONTACT_ZIP' => 'Zip or postal',
    'CONTACT_COUNTRY' => 'US',
    'PERMISSION_REMINDER' => 'You are receiving this email because you opted in via our website.',
    'EMAIL_TYPE_OPTION' => true,
    'CAMPAIGN_FROM_NAME' => "Form Name",
    'CAMPAIGN_FROM_EMAIL' => "emailaddress@email.com",
    'CAMPAIGN_SUBJECT' => "",
    'CAMPAIGN_LANGUAGE' => "en",
]

Customize

If you want to customize the apperance of the views of the package, you can find views and assets files in resources/views/eblix/mailchimp and public/eblix/mailchimp folders, respectively.

Routes

Adding /mailchimp at the end of your base url, will navigate you to the MailChimp package.