Install MT-Notifier

  • These steps are for MT-Notifier version 4 only. For version 3.x, click here.
  • Download the MT-Notifier distribution archive.
  • Navigate to the Movable Type home directory.
  • Unpack the distribution archive, keeping the directory structure intact.
  • Your archive should contain these files:
    • MT_HOME/mt-static/plugins/Notifier/images/Notifier.gif
    • MT_HOME/mt-static/plugins/Notifier/images/Notifier.png
    • MT_HOME/plugins/Notifier/mt-notifier-queue.cgi
    • MT_HOME/plugins/Notifier/mtplugin.pkg
    • MT_HOME/plugins/Notifier/Notifier.html
    • MT_HOME/plugins/Notifier/Notifier.pl
    • MT_HOME/plugins/Notifier/lib/Notifier.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/App.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/Data.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/History.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/L10N.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/Plugin.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/Queue.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/Upgrade.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/Util.pm
    • MT_HOME/plugins/Notifier/lib/Notifier/L10N/en_us.pm
    • MT_HOME/plugins/Notifier/php/plugins/function.mtnotifiercatid.php
    • MT_HOME/plugins/Notifier/tmpl/request.tmpl
    • MT_HOME/plugins/Notifier/tmpl/list_subscription.tmpl
    • MT_HOME/plugins/Notifier/tmpl/dialog/close.tmpl
    • MT_HOME/plugins/Notifier/tmpl/dialog/count.tmpl
    • MT_HOME/plugins/Notifier/tmpl/dialog/start.tmpl
    • MT_HOME/plugins/Notifier/tmpl/email/confirmation.tmpl
    • MT_HOME/plugins/Notifier/tmpl/email/confirmation-subject.tmpl
    • MT_HOME/plugins/Notifier/tmpl/email/new-comment.tmpl
    • MT_HOME/plugins/Notifier/tmpl/email/new-entry.tmpl
    • MT_HOME/plugins/Notifier/tmpl/email/notification-subject.tmpl
    • MT_HOME/plugins/Notifier/tmpl/include/subscription_table.tmpl
    • MT_HOME/plugins/Notifier/tmpl/settings/blog.tmpl
    • MT_HOME/plugins/Notifier/tmpl/settings/system.tmpl
  • That's it - MT-Notifier is installed!
  • You don't need to do anything else unless you want to use the queue.
  • In that case, make sure that mt-notifier.cgi is executable on your server.

Upgrading MT-Notifier

If you are upgrading from a prior version of MT-Notifier, you should be absolutely sure to remove all prior versions. This is especially the case with V4, because changes to Movable Type mean that some pieces of MT-Notifier have changed location as well. Here is a brief list of things to look for. If you find them, remove them, just to make sure that they won't cause any problems down the road. Once they are gone, put the new distrubtion into place.

    • Remove any of these files and directories if you find them:
    • MT_HOME/mt-notifier.cgi
    • MT_HOME/extlib/everitz/
    • MT_HOME/extlib/jayseae/
    • MT_HOME/php/plugins/function.MTNotifierCatID.php
    • MT_HOME/plugins/Notifier.pl
    • MT_HOME/tmpl/cms/notification.tmpl
    • MT_HOME/tmpl/cms/notifier.tmpl

These are leftovers from places that the plugin used to be installed. To insure that you get a clean installation, you should also completely remove the entire Notifier directory, and simply re-upload it. This way you will be sure that all the files are being replaced with the new versions. With each release, many files may be changed, and this method makes sure you get all of them updated, so this is highly suggested. Otherwise you might end up with pieces that are not updated.

That's it. Really. Everything else will take care of itself - just as long as you have the correct pieces in the correct place, you're good to go. The objects will create the tables in the database and all of the columns will update their data automatically.

Time to Upgrade MT-Notifier! Once you install the plugin, you will be prompted with a screen similar to this one. It's important to note that - even if you aren't upgrading data - you may see a screen similar to this one. That's okay. There is some housekeeping to attend to, and it's just letting you know what is happening. Once you click the button, you'll need to sign in, and when it's done it will let you know (it will only take a few seconds).

Versions of MT-Notifier prior to 4.0.4 have had some issues with the history file (and versions prior to 3.5.0 didn't have the fle at all). So you may want to read about how to Keep MT-Notifier from Sending Old Entry Notifications.

MT-Notifier Settings

MT-Notifier System Settings After the installation completes, you need to set at least one parameter, and you need to check two. You can ask anyone who has used MT-Notifier before - if you don't set things correctly, you won't get much of anything (except perhaps some errors!). So save yourself some trouble and take care of the settings now. Go to the System Settings page (System Overview -> Plugins -> MT-Notifier -> Settings). From there, you need to set the default sender address and check the base url.

The sender address is just a text field where you enter an address for any instance where no other address is available (usually the author). It's simple to overlook, but make sure you set it. Please. Especially if you plan on sending subscription confirmations - because otherwise, they won't have an address and they will not work.

New in version 4.2.0 is the base url. Put simply, this serves a similar function to the sender address, but instead of the email address, it's for the script. There are times when the full url isn't available (usually when you use scheduled entries). This gets around that.

Most people will use the configuration file, and it is the default setting. For most single-blog installations, it will be fine. If your CGIPath starts with "http", then this default is fine - but if you use a relative path here, don't use the config file! Instead, consider using the blog site url or even a fixed address for the base. The system setting here is the default, and you can override this value at each blog.

While you're here, think about whether you want to send confirmations or whether you want to use the delivery queue, because you can set these options here as well. Then move onto the blog settings (choose a blog, then select Preferences -> Plugins).

MT-Notifier Blog Settings As you can see, the settings here are mostly the same - the only difference is that you have a few more options for each. First and foremost, you are able to enable and disable MT-Notifier for each blog. Then you are able to set the base url and a default address, much like on the system settings screen - only you have some additional options. Finally, you can make a confirmation or queue selection, just like at the system level.

The blog settings screen does give you some other additional options, however, and these are new with version four. While you are always welcome to create your subscription forms manually, you can now take advantage of integrated widget creation functions. Just click the approrpiate link, and instantly a widget will be created for you in the current blog. This widget can then be added to a widget set, or pulled directly into another template through an include statement, making the entire process easier than ever before.

Creating MT-Notifier Subscriptions

Now that your copy of MT-Notifier is installed and the settings are configured, you need to create some subscriptions. There are three ways to do this.

  • #1: Use the itemset action menus inside of Movable Type.

Every list of items in Movable Type (for instance, entries) is called an itemset. Along with this itemset, you'll see a list of available actions in a drop-down control, from which you can select an action to perform on selected items. In this case, you can choose to Add Subscription(s), Add Subscription Block(s) or View Subscription Count(s). Each of these is fairly self explanatory. Just select items from the list by clicking, then choose the item from the menu and click Go. Your selection will apply to every item you have chosen.

For the first two selections (Add Subscription(s) and Add Subscription Block(s)), you will be presented with another screen that allows you to add names (for adding subcriptions or adding subscription blocks). The third option provides you with a quick count of the number of subscriptions and subscription blocks for the selected items. Keep in mind, however, that if you run this last item across blogs, it may have to process a large amount of data - so it may take a while!

  • #2: Create a standalone subscription form.

To allow users to subscribe without you having to create subscriptions for them, you can simply add an HTML form to your pages. Just make sure you create it outside of any other forms that you have (including any comment forms). The form should look something like this:

<div class="widget-subscribe widget">
<h3 class="widget-header">Subscribe to Blog</h3>
<div class="widget-content">
<form method="get" action="<mt:cgipath><mt:adminscript>">
<input type="hidden" name="__mode" value="verify_subs" />
<input type="hidden" name="blog_id" value="<mt:blogid>" />
<input id="email" name="email" size="16" />
<input type="submit" class="button" value="Go" />
</form>
</div>
</div>

Please note that this form varies slightly from prior releases - both in that it's now calling the Movable Type script (rather than mt-notifier.cgi) and the HTML elements are named differently, to fit in with the default MT4 templates. The parameters have changed slightly too. I'm sorry for the change, but it was necessary due to the changes in MT4.

Once you have added this form to the page, users can subscribe to be notified of new entries that are posted on your site. To allow your users to subscribe to a category instead of the entire blog, specify a field name of category_id (with a valid category ID) instead of blog_id, and to provide an entry subscription, replace blog_id with entry_id (and use <$MTEntryID$>).

Because there is no category ID tag within an entry, MT-Notifier includes a template tag for use in your templates called <$MTNotifierCatID$> that you can use to fill in this field automatically, easily providing a "subscribe to this category" function if you so desire.

In MT-Notifier version four, you can visit the blog settings page (Preferences -> Plugins -> MT-Notifier -> Settings) and have MT-Notifier automatically create this widget for you. Then you can use the widget in a Widget Set or an <$MTInclude$>. Try it out, it's easy!

  • #3: Add a checkbox to your comment form for those leaving a comment.

This is the simplest change, but it requires that someone leave a comment. Just go into your template that contains your comment form and add this HTML:

<p><label for="subscribe">Subscribe to This Entry:</label>
<input type="checkbox" name="subscribe" value="1" /></p>

Once you have added this checkbox to your comment form, then anyone leaving a comment on your blog just needs to check the box and they will automatically be notified of any comments that are left.

Note that this is good for comment notifications only, where the first example of using the itemset action menu, and the second example of using a standalone HTML form, were good for entry notifications as well. You cannot use the comment form method for entry notifications!

If you wish to allow users to subscribe to comments on an entry without having to leave a comment, you can do so by creating a standalone form as described above and then replacing blog_id in the example with entry_id and inserting a valid entry ID (likely using the <$MTEntryID$> template tag).

Should you encounter any problems creating your subscriptions, you might want to visit the Troubleshooting Forms page.

Subscription Confirmations

  • Both the system and blog confirmations must be on to send confirmations.
  • Verify the base url using the system or blog level plugin settings.
  • Add a sender address using the system or blog level plugin settings.
  • That's it. Now you can allow your users to confirm their subscriptions!

Managing MT-Notifier Subscriptions

MT-Notifier Subscription Management Though prior releases of MT-Notifier have almost always had some sort of management function built-in, until now, it has just about always had some shortcomings.

From the very earliest editions of the software, where you were hampered by seemingly endless drop-down lists, to recent versions where the search was available but it didn't work, there was always something that just didn't feel right. No longer.

In version 4.1.0, MT-Notifier has been completely reworked so that every aspect of the management interface feels like a native application. Scroll through your subscribers by pages, edit-in-place, search using the quick search function, even filter your search by date and use the search-and-replace function! In this latest release, the IP address has also been exposed through the search function so that you can easily find - and act upon - any of the records in your blog.

MT-Notifier Search and Replace Perhaps the most exciting development is the ability to use the quick search (the box in the upper right corner of the screen) and the native search function for your subscriptions. Have thousands of subscribers, and don't feel like paging through them to find the one you need? Have to figure out which IP address is causing you headaches and can't dig through the database? MT-Notifier to the rescue!

Now you can use the quick search box to quickly pull up results from your database, and the full-blown search will allow you to search on the email address or IP address of all your subscribers. Even better, you can filter your search by a date range, and even perform search-and-replace on the data, just like you can on many other native Movable Type searches, making MT-Notifier an even more important part of your toolkit!

This makes all of your subscribers available from the familiar Manage screen (Manage -> Subscribers) or the Search screen, making subscriber management easier than ever!

Using the MT-Notifier Queue

  • Make sure that mt-notifier-queue.cgi is executable on your server.
  • Both the system and blog queue must be on to send notifications via queue.
  • Once notifications are in the queue, you must create a cron job to send them:
  • cd /mt-home/plugins/Notifier; ./mt-notifier-queue.cgi -limit=500
  • The pathname (in italic) is the full filesystem path to MT-Notifier.
  • The limit option (in bold) is the number of notifications to send.
  • Schedule the job as often as you would like, but don't run afoul of your host!
  • That's it. Now you can queue your notifications!

Using the MT-Notifier Queue (Prior to Version 4.0.5)

  • Prior to version 4.0.5 the queue instructions were slightly different.
  • cd /mt-home/plugins/Notifier; ./mt-notifier.cgi queued 500
  • The pathname (in italic) is still the full filesystem path to MT-Notifier.
  • The script name is not mt-notifier-queue.cgi, but mt-notifier.cgi.
  • There is another parameter, queued, that tells the script the action to take.
  • The final option (500) is the number of notifications to send.
  • That's it. Everything else, including the notifications themselves, are the same!