SL Freshview Subscribe

Automatically add new members to CampaignMonitor mailing lists.

Overview

SL Freshview Subscribe makes it easy to subscribe new members of your ExpressionEngine-powered website to one or more CampaignMonitor mailing lists.

Here are a few of the highlights:

• Automatically add a member to one or more mandatory mailing lists.
• Specify “opt-in triggers” to allow a member to control which lists he is added to.
• Associate custom ExpressionEngine member profile fields with custom CampaignMonitor fields on a list-by-list basis.
• Full support for both “Self-activation via email” and “No activation required” memberships. The extension automatically detects site’s membership preferences, and takes the appropriate action.

Simply enter your CampaignMonitor API key, configure your mailing lists, and the extension does the rest.

Requirements

SL Freshview Subscribe requires that the “jQuery for the Control Panel” extension be installed and enabled in order to function correctly.

“jQuery for the Control Panel” is installed (but disabled) by default on ExpressionEngine version 1.6.5 and up. You can also download it directly from the ExpressionEngine website.

SL Freshview Subscribe also makes use of Leevi Graham’s LG Addon Updater extension to keep you informed about updates and bug fixes, but will function perfectly well without it.

Installation

The SL Freshview Subscribe ZIP file contains an extensions folder and a language folder. Here’s how to install the extension:

1. Extract the ZIP file.
2. Copy the extensions/ext.sl_freshview_subscribe.php file to your /system/extensions/ directory.
3. Copy the extensions/sl_freshview_subscribe folder to your /system/extensions/ directory.
4. Copy the language/english/lang.sl_freshview_subscribe.php file to your /system/languages/english/ directory.
5. If you’re installing SL Freshview Subscribe for the first time, open the Extensions Manager, and enable the extension.

Upgrading

If you’re upgrading to version 1.3.0+, the old themes/cp_themes/default/sl_freshview_subscribe folder is now obsolete, and can safely be deleted. Just follow the “Installation” instructions, above.

Configuration

Retrieving and configuring your CampaignMonitor mailing lists is a 3 step process:

1. Enter your CampaignMonitor API key, and click the “Get clients” link.
2. Select a client from the drop-down list, and click the “Get mailing lists” link.
3. Select the mailing lists to which you wish to subscribe newly activated members, by ticking the checkbox next to the list name. If required, you can also select an “opt-in trigger” (see below), and map custom mailing list fields to custom ExpressionEngine member profile fields.

Trigger fields

A “trigger” field is a custom ExpressionEngine member profile field that must contain a specified value in order for the mailing list subscription to be processed.

For example, you may have a “Special Offers” mailing list, which new members must opt-in to. Here’s how to implement this:

1. Create a new custom EE member profile field, and give it an appropriate field name (for example, “subscribe-offers”) and label (for example, “Receive our special offers newsletter?”). Specify Drop-down list as the field type, and add the options Yes and No.
2. Open the SL Freshview Subscribe extension settings page. Tick the checkbox for the “Special Offers” mailing list, select the member profile field you just created from the “Trigger field” drop-down, and set the “Trigger value” to Yes.

Usage

Once the extension is installed and configured, it will automatically subscribe newly registered and confirmed users to the specified CampaignMonitor mailing lists. The extension works best with “single opt-in” CampaignMonitor lists.

Support

Support is provided via this thread on the ExpressionEngine forums.

License

SL Freshview Subscribe is made available under a Creative Commons Attribution-Share Alike 3.0 Unported License.

1.4.0

• Implemented support for User module on sites that don’t require member activation.
• Added bash script to create symlinks.
• Fixed a minor JavaScript bug, when displaying the available values for a custom member field of type “Drop-down”
• Fixed a silly error introduced in the previous version, that was affecting simultaneous subscriptions to multiple mailing lists.

1.3.1

• Implemented handy drop-down list of available values for all custom profile fields of type “Drop-down List”.

1.3.0

• Implemented workaround for LG Addon Updater bug.
• Moved assets to sl_freshview_subscribe folder within extensions

1.2.2

• Minor tweak to make everything play nicely with PHP4.

1.2.1

• Fixed bug related to CampaignMonitor accounts containing a single Client, or a single List.
• Improved error messages.

1.2.0

• Added support for sites that don’t require member self-activation via email (as set on the Membership Preferences screen). The extension automatically detects the membership preferences, and takes the appropriate action.
• Implemented a “Disable Extension” button in the top-right of the extension settings screen.

1.1.0

• Implemented full support for custom mailing list fields on a list-by-list basis!
• Custom Profile Fields now appear as a drop-down list, instead of an uninviting text field.
• Underlying code completely rewritten. All the API querying is now handled by PHP — meaning we can kiss goodbye to the JavaScript-PHP proxy file nonsense — and CampaignMonitor’s PHP “helper” class is used for all the donkey-work.
• Moved minimal remaining CSS and JavaScript out of separate files.
• Far too many little improvements and tweaks to list.
• Implemented change log.

Need a custom ExpressionEngine addon?
Find out about our ExpressionEngine development services.

EE addons

• Deniro
• SL Combinator
• SL Comment Redirect
• SL Developer Info
• SL Field Formatting
• SL Freshview Subscribe
• SL Google Map
• SL MailChimp Subscribe
• Speakeasy

Other goodies

• YUI Compressor TextMate Bundle