PHPackages                             aelvan/mailchimp-subscribe - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Mail & Notifications](/categories/mail)
4. /
5. aelvan/mailchimp-subscribe

AbandonedCraft-plugin[Mail & Notifications](/categories/mail)

aelvan/mailchimp-subscribe
==========================

Simple Craft plugin for subscribing to a MailChimp audience.

5.0.0(9mo ago)115131.6k↓33.3%45[3 issues](https://github.com/aelvan/mailchimp-subscribe-craft/issues)[1 PRs](https://github.com/aelvan/mailchimp-subscribe-craft/pulls)MITPHPPHP ^8.2

Since Dec 7Pushed 9mo ago7 watchersCompare

[ Source](https://github.com/aelvan/mailchimp-subscribe-craft)[ Packagist](https://packagist.org/packages/aelvan/mailchimp-subscribe)[ RSS](/packages/aelvan-mailchimp-subscribe/feed)WikiDiscussions craft5 Synced 1mo ago

READMEChangelog (1)Dependencies (2)Versions (21)Used By (0)

*This plugin has retired!*
==========================

[](#this-plugin-has-retired)

*Nine years after its inception (in plugin-years, that's like 108 human years), it's time to retire this plugin. I've created a Craft 4 version to ease the transition, but no new development will be done, and no support given. It's time for you to start looking for/creating alternatives.*

Mailchimp Subscribe plugin for Craft CMS 5.x
============================================

[](#mailchimp-subscribe-plugin-for-craft-cms-5x)

Mailchimp Subscribe for [Craft](http://craftcms.com/) is a plugin for working with Mailchimp audiences.

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 5.0.0 or later.

Update notes
------------

[](#update-notes)

### Updating from version 4.x to 5.x

[](#updating-from-version-4x-to-5x)

This is a minimum effort upgrade to Craft 4, no changes.

### Updating from version 3.x to 4.x

[](#updating-from-version-3x-to-4x)

This is a minimum effort upgrade to Craft 4, no changes.

### Updating from version 2.x to 3.x

[](#updating-from-version-2x-to-3x)

Too much, [see the changelog for information](https://raw.githubusercontent.com/aelvan/mailchimp-subscribe-craft/craft3/CHANGELOG.md).

### Updating from version 1.x (Craft 2) to 2.x (Craft 3)

[](#updating-from-version-1x-craft-2-to-2x-craft-3)

- The plugin no longer is configurable from the control panel, you need to use a config file.
- The plugin handle used in the action input has changed from `mailchimpSubscribe` to `mailchimp-subscribe`.
- The redirect url now has to be hashed in the redirect input.

Installation
------------

[](#installation)

To install the plugin, either install it from the plugin store, or follow these instructions:

1. Install with composer via `composer require aelvan/mailchimp-subscribe` from your project directory.
2. Install the plugin in the Craft Control Panel under Settings → Plugins, or from the command line via `./craft install/plugin mailchimp-subscribe`.
3. Eat a banana and continue reading!

---

Configuration
-------------

[](#configuration)

Mailchimp Subscribe must be configured by creating a file named `mailchimp-subscribe.php` in your Craft config folder (usually `/config`), and configure settings as needed.

### apiKey \[string\]

[](#apikey-string)

*Default: `''`*
The API key for your Mailchimp account. *This setting is required.*

### audienceId \[string\]

[](#audienceid-string)

*Default: `''`*
The default audience ID you want users to subscribe to. You can also configure the audienceID by posting this through your forms (see below).

### doubleOptIn \[bool\]

[](#doubleoptin-bool)

*Default: `true`*
Indicates if double opt-in should be used when subscribing. If enabled, users will receive an email to confirm their subscription before being added to the audience.

### Example config file

[](#example-config-file)

```