Boomerang

Requirements

↑ Top

• ExpressionEngine 1.6+ (non-core version)
• Mailing List Module (included in non-core versions of EE)
• jQuery 1.3.2 and jQuery UI 1.7.2 (built-in since 1.6.4+)
• PHP v5.1+
• Access and ability to setup a cron script (hosted service coming soon for those who cannot)

Note: some features may or may not be compatible with PHP Safe Mode on.

Installation

↑ Top

1. Purchase and download the latest version of Boomerang.
2. Extract the .zip file to your desktop
3. Copy the system/modules/boomerang directory to your /system/modules/ directory
4. Copy language/english/lang.boomerang.php to your /system/language/english/ directory
5. Copy images/boomtracker.gif to your /images/ directory. This is the default images directory from your webroot
6. Go to the Modules tab in your control panel
7. Click "Install" in the row for "Boomerang"
8. Make sure your /images/ directory's permissions are "777"
9. Set up the cron job (as described below) - this is a must

Configuration

↑ Top

When you open Boomerang for the first time you will be asked to enter your sender information. It’s important to note that in order to assure maximum delivery rates, your From Address and Reply-To Addresses should be the same, as well as real. Also, the Reply-To address will receive any and all bounced emails. It’s worth creating a separate email address just for sending emails.

Unsubscribe Language: This is the language that your {unsubscribe} tag will be replaced with in your templates and/or one-off emails.

New!Localized Time Difference: This feature lets you localize Boomerang's timestamps and scheduling system as an offset of your server time.

New!ExpressionEngine Template Group: In order to utilize ExpressionEngine's native templating language, you must set a "dummy" template to be used as a pass-through. This template MUST be saved as a file and have permissions set to "777". We recommend using a Hidden Template for this use.

Once set, the Configuration page will display some valuable information:

• The status of PHP Safe Mode. If on, there may be issues with scheduling delayed emails.
• Cron job executable. This file needs to have a cron script set in order for Boomerang's mailing processes to function.
• Cron job script. This script will be applicable for all common servers. It executes the cron job executable and sets the scheduling process.
• Alternative cron URL. When using this option the process only runs when requested from the cron job.

New Tips Alternative URL to cron: This is a new feature in 1.1.1 When this URL is croned, it will only check to see if there is mail to be sent when the cron job is run. We don't recommend having the cron set to less-then 15min intervals when using this option. For lists greater the 5,000 contacts it may be necessary to increase the time between intervals.

On Cron Jobs: There has been a little confusion as to the reason for the cron job, as well as just HOW you set one up. EETemplates has done a great job walking you through setting up a Boomerang cron, so check it out!

We recommend setting your cron timing to between 5 and 15 minutes max. The length between the crons is the maximum time your email can be sent from the scheduled time.

Check that the cron is running as php and not as an apache_mod (by command line: ps -ax | grep "cron_me.php") - This is particularly important. We're planning on offering a hosted cron solution for those who do not have access or control of their cron services, or would prefer not to work with them. More info on that soon!

From here, you're ready to start blasting some emails. Read the usage section for full details of all areas in the module.

Usage

↑ Top

The following will walk through the various areas of the module:

Manage Templates

Create and edit HTML templates that can be reused at any time to send email blasts. Templates is currently static HTML, but we have plans to incorporate integrating ExpressionEngine tags, such as in the near future.

Create New Email

Create HTML, text, and multi-part emails, quick test them, choose your mailing list, and fire away. The HTML versions are tracked using a 1×1 pixel image (/images/boomerang.gif) that’s auto-embedded in the code of an HTML email. Links are tracked using dynamic link replacement and redirection. Each link is tracked separately.

CAN-SPAM requires the usage of an unsubscribe feature. This is placed by using the {unsubscribe} tag anywhere you desire in your email template. Make sure to add it to both the html and text versions of your email. The unsubscribe language is set in the Settings area.

In addition to {unsubscribe}, {address} is also required. This tag will use the information set in Settings.

View Past Emails

This area lets you see every email you’ve sent to date and optionally edit and resend them. Until Draft Emails are implemented this can be used a temporary solution for keeping coded emails.

New View!View Reports

Here there be dragons! This is where the cool stuff happens. See opens and clicks, open and click rates, unsubscribes and opens over time. All in smooth functioning flash charts.

Edit Mailing Lists

A simple, convenient link to the Mailing List module.

Configuration

This is where all your sender information resides. Set it and forget it, change it often, it doesn’t matter. This is also where your cron job information is stored for reference.

Change Log

↑ Top

• 1.1.1 — 10/23/2009
  • FEATURE: Email sends without cron if delay send is not chosen
  • FEATURE: Alternative cron URL added
  • ENHANCEMENT: TinyMCE now supports more HTML tags
  • BUG FIX: Removed slashes in edit template view, after save
  • BUG FIX: Fixed issue people were having with TinyMCE not loading
• 1.1 — 10/17/2009
  • FEATURE: Email Templates can now utilize ALL ExpressionEngine template code (weblog entries, custom fields, conditionals, addons, etc.). Now you can utilize ALL your site's content to fuel your email marketing.
  • FEATURE: Server time offset setting for localization
  • ENHANCEMENT: New and improved Reports View
  • ENHANCEMENT: Printer-friendly Report Views (flash charts write to images)
  • TECH NOTE: Improved cron functionality
• 1.0 — 8/17/2009 : Released

Boomerang is being actively developed, though no longer publically available. If you currently own a license of Boomerang, we will still support you! Send us an email to talk about what we can do for you.

Support

↑ Top

Technical support is available through email and the ExpressionEngine forums. If your question can be answered in 140 characters or less, feel free to hit us on Twitter too. No representations or guarantees are made regarding the response time in which support questions are answered, but we'll try to get right back to you.

License

↑ Top

Each Site License may be used on one domain at a time. This includes both public-facing websites and intranet/internal websites. Each MSM-based website counts as one website unless sharing the main domain. You may also install Boomerang on an unlimited number of private, in-development websites.

Boomerang is a commercial product and therefore is subject to the commercial license agreement.