digitalbutter/cmx

Campaign Monitor for MODx

Campaign Monitor for MODx

Campaign Monitor for MODx (CMx) is a component for MODx that allows you to send and check your email campaigns directly from the MODx backend interface.

Configuration

Grab the provided zip from the downloads section or build a new one using the included build.transport.zip. After installation make sure to set these system settings:

1. Enter your API Key into the 'cmx.api_key' system setting. This can be found in the Campaign Monitor manager interface.
2. Enter your Client ID into the 'cmx.client_id' system setting. Also can be found in the Campaign Monitor manager interface.

Information

CMx uses a caching system that will store campaign information in JSON files. This avoids keeping a database table synced with Campaign Monitor (incase the user creates a campaign through the web interface) and should also speed up loading lists, which I've found can take about 5 seconds to load through the API.

By default, the cache will refresh every 3 hrs or so, however when a new campaign is created the cache is automatically refreshed when you return to the list view.

Also, Campaign Monitor requires a plain HTML and TXT file to load the campaign information from, therefore there is a secondary cache folder in the assets directory which will briefly create these files while the CM API is creating the campaign. This needs to be accessable from to the web for CM to download the campaign. They're deleted automatically after the campaign draft is created.

Things to add

While it's currently possible to create and view campaign info, this package is still in need of quite a bit of work. Current things I'd like to add:

• Ability to edit drafts: This will require a full delete of the draft campaign and then the creation of a new campaign with the old data pulled in. It's currently caching the campaign data (there's no way to pull in all the campaign fields through the API), so this should be quite possible.

• Campaigns using resource content: The idea is to be able to pull information from MODx resources directly into the campaign content field. Ultimately I'd like to get it working with Custom Resource Classes, for things like articles, press releases, etc that would normally go into email campaigns.

• List Management: Allow for the management of subscriber lists and segments.

• General Cleanup: Quite a bit of left over code from modExtra that isn't being used.