Download the PHP package lukeyouell/craft-mailchimplists without Composer
On this page you can find all versions of the php package lukeyouell/craft-mailchimplists. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lukeyouell/craft-mailchimplists
More information about lukeyouell/craft-mailchimplists
Files in lukeyouell/craft-mailchimplists
Package craft-mailchimplists
Short Description Create, manage and monitor your MailChimp Lists from within Craft.
License MIT
Informations about the package craft-mailchimplists
MailChimp Lists plugin for Craft CMS 3.x
Create, manage and monitor your MailChimp Lists from within Craft.
Requirements
This plugin requires Craft CMS 3.0.0-RC11 or later.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require lukeyouell/craft-mailchimplists
- In the Control Panel, go to Settings → Plugins and click the “Install” button for MailChimp Lists.
Configuring MailChimp Lists
You will be required to supply a MailChimp API key which is used to source the relevant data center and authenticate requests.
Your API key is available here.
A MailChimp account is required, if you don't already have one click here to create one.
Free & paid plans are available.
Using MailChimp Lists
Once you have provided the plugin with your MailChimp API key you will be able to create, manage and monitor your lists directly from within Craft.
Example Form
Your list subscription form template should look something like this:
Form Parameters
Name | Required | Hashed | Expected value |
---|---|---|---|
listId |
Yes | Yes | The unique id for the list |
status |
Yes | Yes | subscribed , unsubscribed , cleaned or pending |
email_address |
Yes | No | Email address for a subscriber |
email_type |
No | No | html or text |
merge_fields[] |
No | No | An individual merge var and value for a member |
interests[] |
No | No | The name of this field is the ID of the interest in question. |
language |
No | No | If set/detected, the subscriber’s language ISO 3166 Country Code |
vip |
No | No | VIP status for subscriber |
location[latitude] |
No | No | Subscriber location latitude |
location[longitude] |
No | No | Subscriber location longitude |
The above field names are case-sensitive.
Redirecting After Submit
If you have a redirect
hidden input, the user will be redirected to it upon successful submission. This must also be a hashed value.
If you don't have a redirect
hidden input, the plugin will respond with json (handy for debugging)
Ajax Submissions
You can optionally post submissions over Ajax if you’d like. Just send a POST request to your site with all of the same data that would normally be sent (except for the redirect
field)
Example Responses
Successful
MailChimp Error
Request Failed
Overriding Plugin Settings
If you create a config file in your config folder called mailchimp-lists.php
, you can override the plugin’s settings in the Control Panel. Since that config file is fully multi-environment aware, this is a handy way to have different settings across multiple environments.
Here’s what that config file might look like along with a list of all of the possible values you can override.
MailChimp Lists Roadmap
Some things to do, and ideas for potential features:
- List growth
- Edit members
- Member activity
- Sort members by date
- Dashboard widget
- Custom progress bar parameters
Brought to you by Luke Youell