Skip to content
Snippets Groups Projects

Issue #3332151: Update README.md file according to README.md template on 2.x-dev

Open Issue #3332151: Update README.md file according to README.md template on 2.x-dev
issue/mailchimp-3332151:3332151-update-readme.md-file into 2.x
Open Shubham Rathore requested to merge issue/mailchimp-3332151:3332151-update-readme.md-file into 2.x
Compare
and
1 file
+ 89
− 91
Compare changes
  • Side-by-side
  • Inline
README.md
+ 89
− 91
CONTENTS OF THIS FILE
---------------------
* Introduction
* Features
* Sub-modules
* Requirements
* Installation
* Configuration
* Related modules
INTRODUCTION
------------
# Mailchimp
This module provides integration with the Mailchimp email delivery service.
While tools for sending email from your own server, like SimpleNews, are great,
@@ -23,123 +10,134 @@ site functionality are provided by a set of submodules that depend upon the core
"mailchimp" module. These are in the "modules" subdirectory: See their
respective READMEs for more details.
* To submit bug reports and feature suggestions, or track changes:
https://www.drupal.org/project/issues/mailchimp
For a full description of the module, visit the
[project page](https://www.drupal.org/project/mailchimp).
Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/mailchimp).
## Table of contents
- Features
- Sub modules
- Requirements
- Installation
- Manual install using the Ludwig module
- Configuration
- Related modules
FEATURES
--------
* API integration
* Support for an unlimited number of mailing lists
* Have anonymous sign up forms to subscribe site visitors to any combination
of Mailchimp lists
* Mailchimp list subscription via entity fields, allowing subscription rules
to be governed by entity controls, permissions, and UI
* Allow users to subscribe during registration by adding a field to Users
* Map Entity field values to your Mailchimp merge fields
* Standalone subscribe and unsubscribe forms
* Subscriptions can be maintained via cron or in real time
* Subscription forms can be created as pages or as blocks, with one or more
list subscriptions on a single form
* Include merge fields & interest groups on anonymous subscription forms
* Create & send Mailchimp Campaigns from within Drupal, using Drupal
entities as content.
* Display a history of Mailchimp email and subscription activity on a tab
for any Entity with an email address.
## Features
SUB-MODULES
-----------
- API integration
- Support for an unlimited number of mailing lists
- Have anonymous sign up forms to subscribe site visitors to any combination
of Mailchimp lists
- Mailchimp list subscription via entity fields, allowing subscription rules
to be governed by entity controls, permissions, and UI
- Allow users to subscribe during registration by adding a field to Users
- Map Entity field values to your Mailchimp merge fields
- Standalone subscribe and unsubscribe forms
- Subscriptions can be maintained via cron or in real time
- Subscription forms can be created as pages or as blocks, with one or more
list subscriptions on a single form
- Include merge fields & interest groups on anonymous subscription forms
- Create & send Mailchimp Campaigns from within Drupal, using Drupal
entities as content.
- Display a history of Mailchimp email and subscription activity on a tab
for any Entity with an email address.
* mailchimp_signup: Create anonymous signup forms for your Mailchimp Lists,
and display them as blocks or as standalone pages. Provide multiple-list
subscription from a single form, include merge variables as desired, and
optionally include Interest Group selection.
* mailchimp_lists: Subscribe any entity with an email address to Mailchimp
lists by creating a mailchimp_list field, and allow anyone who can edit
such an entity to subscribe, unsubscribe, and update member information.
Also allows other entity fields to be synced to Mailchimp list Merge
Fields. Add a Mailchimp Subscription field to your User bundle to allow
Users to control their own subscriptions & subscribe during registration.
## Sub modules
* mailchimp_campaign: Create and send campaigns directly from Drupal, or
just create them and use the Mailchimp UI to send them. Embed content from
your Drupal site by dropping in any Entity with a title and a View Mode
configured into any area of your email template.
- mailchimp_signup: Create anonymous signup forms for your Mailchimp Lists,
and display them as blocks or as standalone pages. Provide multiple-list
subscription from a single form, include merge variables as desired, and
optionally include Interest Group selection.
- mailchimp_lists: Subscribe any entity with an email address to Mailchimp
lists by creating a mailchimp_list field, and allow anyone who can edit
such an entity to subscribe, unsubscribe, and update member information.
Also allows other entity fields to be synced to Mailchimp list Merge
Fields. Add a Mailchimp Subscription field to your User bundle to allow
Users to control their own subscriptions & subscribe during registration.
REQUIREMENTS
------------
- mailchimp_campaign: Create and send campaigns directly from Drupal, or
just create them and use the Mailchimp UI to send them. Embed content from
your Drupal site by dropping in any Entity with a title and a View Mode
configured into any area of your email template.
* You need to have a Mailchimp API Key.
* You need to have at least one list created in Mailchimp to use the
mailchimp_lists module.
## Requirements
INSTALLATION
------------
This module requires the following modules:
* Use composer to download mailchimp, which will download all the dependencies
required by mailchimp: `composer require drupal/mailchimp`
- [Mailchimp User Lists](https://www.drupal.org/project/mailchimp_user_lists)
- You need to have a Mailchimp API Key.
* In case you have manually downloaded this module, then you will need to
install the thinkshout/mailchimp-api-php library manually as well:
* Use composer: `composer require thinkshout/mailchimp-api-php`
## Installation
* Or if you cannot use composer, another option is to install it using the
Ludwig module.
- Use composer to download mailchimp, which will download all the dependencies
required by mailchimp: `composer require drupal/mailchimp`
- In case you have manually downloaded this module, then you will need to
install the thinkshout/mailchimp-api-php library manually as well:
- Use composer: `composer require thinkshout/mailchimp-api-php`
- Or if you cannot use composer, another option is to install it using the
Ludwig module.
## Manual install using the Ludwig module
### Manual install using the Ludwig module
Composer is the recommended way to install and maintain a site. Site
administrators using Ludwig need to be careful when combining modules that
depend on external libraries, since there are no safeguards against incompatible
library versions or overlapping requirements.
Steps:
- Steps:
1. Download and install the Ludwig module.
- Download and install the Ludwig module.
https://www.drupal.org/project/ludwig
2. Download and install the Mailchimp module.
- Download and install the Mailchimp module.
3. Visit packages status at Reports > Packages (admin/reports/packages) and
- Visit packages status at Reports > Packages (admin/reports/packages) and
use "Download and unpack all missing libraries" button.
4. Rebuild the cache. Done!
- Rebuild the cache. Done!
For more about using Ludwig:
https://www.drupal.org/docs/contributed-modules/ludwig/installation-and-usage
CONFIGURATION
-------------
1. Direct your browser to admin/config/services/mailchimp to configure the
module.
## Configuration
1. Direct your browser to admin/config/services/mailchimp to configure the
module.
2. You will need to put in your Mailchimp API key for your Mailchimp
account.
2. You will need to put in your Mailchimp API key for your Mailchimp
account.
If you do not have a Mailchimp account, go to
[http://www.mailchimp.com]([http://www.mailchimp.com) and sign up for a
- If you do not have a Mailchimp account, go to
`[http://www.mailchimp.com]([http://www.mailchimp.com)` and sign up for a
new account. Once you have set up your account and are logged in, visit:
'Account Settings -> Extras -> API Keys' to generate a key.
3. Copy your newly created API key and go to the
[Mailchimp config](http://example.com/admin/config/services/mailchimp)
page in your Drupal site and paste it into the Mailchimp API Key field.
4. Batch limit - Maximum number of changes to process in a single cron run.
Mailchimp suggests keeping this below 10000.
3. Copy your newly created API key and go to the
[Mailchimp config](http://example.com/admin/config/services/mailchimp)
page in your Drupal site and paste it into the Mailchimp API Key field.
4. Batch limit - Maximum number of changes to process in a single cron run.
Mailchimp suggests keeping this below 10000.
RELATED MODULES
---------------
* Mandrill (http://drupal.org/project/mandrill):
Mandrill is Mailchimp's transactional email service. The module provides the
ability to send all site emails through Mandrill with reporting available
from within Drupal. Please refer to the project page for more details.
## Related modules
- Mandrill (http://drupal.org/project/mandrill):
Mandrill is Mailchimp's transactional email service. The module provides the
ability to send all site emails through Mandrill with reporting available
from within Drupal. Please refer to the project page for more details.