Immediate Notify Plugin

Please read Foswiki:Extensions.MailerContrib.

This is a plugin that allows users to be immediately notified when topics or webs are modified.

Syntax Rules

Once the plugin is installed, users can register for notification in the WebImmediateNotify topics by including their username as an entry in a list. In order to recieve notifications, they must also configure their desired notification method. Since SMTP and Jabber are currently the only available methods, this consists of:

• Adding a line "      * Set IMMEDIATENOTIFYMETHOD = Jabber" (or "SMTP", respectively) to their topic.
• Adding a line "Jabber: jabber_user@jabber_server.org" to their topic for notification per Jabber (no configuration is needed for SMTP).

ImmediateNotifyPlugin Global Settings

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Allows immediate notification of topic changes through SMTP or Jabber

• Notification method configuration:
  • Set METHODS = SMTP
• Jabber method configuration:
  • Set JABBER_USERNAME =
  • Set JABBER_PASSWORD =
  • Set JABBER_SERVER =

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where Foswiki is running.

• Download the ZIP/TGZ file from the Plugin web (see below)
• Unzip ImmediateNotifyPlugin.zip in your Foswiki installation directory. Content:

  File:	Description:
  lib/Foswiki/Plugins/ImmediateNotifyPlugin.pm
  lib/Foswiki/Plugins/ImmediateNotifyPlugin/Jabber.pm
  lib/Foswiki/Plugins/ImmediateNotifyPlugin/SMTP.pm
  data/System/ImmediateNotifyPlugin.txt
  templates/smtp.immediatenotify.tmpl

• Set up notification methods (default is SMTP)
  • Currently the only available methods are via SMTP and Jabber.
    • SMTP
      • The site's configuration is used - no additional configuration is needed.
    • Jabber
      • Set up a Jabber account for the wiki with a standard client.
      • Set JABBER_USERNAME, JABBER_PASSWORD, and JABBER_SERVER in the plugin topic.
• Visit configure in your Foswiki installation, and enable the plugin in the {Plugins} section.
• Create a WebImmediateNotify topic in each web for users to list their names in for notification.

Plugin Info

Plugin Author:	TWiki:Main/WalterMundt & TWiki:Main/JuergenPabel
Plugin Version:	8780 (2010-08-26)
Plugin Release:	v0.4 (testing)
Change History:
26 Aug 2010	Test release - Foswikitask:Item9551
05 Jan 2010	Ported to Foswiki (Foswiki:Main.WillNoris)
21 May 2007	Bugs:Item3969 - 8bit email fix (Foswiki:Main.WillNorris)
26 Jul 2006:	(v0.3) - Foswiki:Main.SteffenPoulsen: Ported to TWiki-4 / Dakar
16 Mar 2003:	Added support for groups and SMTP
03 Feb 2003:	Initial version
CPAN Dependencies:	CPAN:XML::Stream, CPAN:Net::Jabber (2.0) (Only for Jabber notifications, SMTP notifications will work without these CPAN modules)
Other Dependencies:	none
Perl Version:	> 5.6.1
Plugin Home:	http://foswiki.org/Extensions/ImmediateNotifyPlugin
Support:	http://foswiki.org/Support/ImmediateNotifyPlugin

Related Topics: DefaultPreferences, SitePreferences, Plugins, DefaultPlugin?

-- TWiki:Main/WalterMundt - 04 Feb 2003, TWiki:Main/JuergenPabel - 16 Mar 2003

Ask a new question

Can't find your problem here, or would you like to post a request? Ask a question on ImmediateNotifyPlugin.

Active Items

Id	Summary	Priority	Current State	Creation Date	Last Edit
Item11587	Calls to deprecated readTopicText and saveTopicText are in several public extensions	Normal	New	29 Feb 2012 - 08:34	29 Feb 2012 - 08:34
Item9551	Modernize and enhance ImmediateNotifyPlugin	Normal	Waiting for Feedback	25 Aug 2010 - 04:38	07 May 2012 - 03:14

ImmediateNotifyPlugin Development

This is the topic to discuss development of ImmediateNotifyPlugin

If you need support, go to Support.ImmediateNotifyPlugin where you can ask questions and find answers to previously asked questions. If you want to report a bug, or a feature request, go to Tasks.ImmediateNotifyPlugin where you can see already submitted issues and where you can submit a new bug report or feature request.

Active Items

Id	Summary	Priority	Current State	Creation Date	Last Edit
Item11587	Calls to deprecated readTopicText and saveTopicText are in several public extensions	Normal	New	29 Feb 2012 - 08:34	29 Feb 2012 - 08:34
Item9551	Modernize and enhance ImmediateNotifyPlugin	Normal	Waiting for Feedback	25 Aug 2010 - 04:38	07 May 2012 - 03:14

Discussion

Should we merge features of several plugins that appear to provide similar / overlapping functions:

• NotificationPlugin,
  • Configured per user using [WikiName]NotifyList topic in Main web
    • This has performance implications - every save requires that all *NotifyList topics be read to determine if any listed topics / regexes match the saved topic. For a larger Wiki, the notification lists should probably be cached or saved in some sort of searchable backend that is queried in the *NotifyList topic.
  • Provides replacement for MailerContrib? mailnotify script for unified subscription of Immediate & Deferred notifications
  • Supports regex matching of topic names
  • Provides %NTF% macro to adjust notifications
    • As implemented this is a commonTagHandler that calls Foswiki::Store directly - probably not portable to Foswiki 1.1
  • Not yet completely ported
  • Notification happens in beforeSaveHandler - May result in false notifications if save fails for some reason.
• ImmediateNotifyPlugin
  • Pluggable notify handlers. Currently SMTP and Jabber (XMPP)
  • Configured per topic using Set stmt, or per web with WebImmediateNotify topic (similar to WebNotify)
    • WebImmediateNotify topic syntax not unified with WebNotify
  • Issues found in original version - being corrected.
• IrcPlugin
  • Not ported.
  • Could be implemented as a plugin for ImmediateNotifyPlugin
• NotifyOnChildModificationPlugin
  • Not ported. Notifies subscriber when a child topic is changed.
  • Appears to support "immediate children" only - doesn't chase topic hierarchy
• TweetOnSavePlugin
  • Released - need to discuss with author.

Also, should immediate notifications be considered for merging into the conventional notification process.

-- GeorgeClark - 11 Sep 2010

A lot of the issues I found in ImmediateNotifyPlugin have been fixed in svn. I released a working version to ImmediateNotifyPlugin a long time ago now. I've also started to merge in the IRC and Tweet plugins.

-- GeorgeClark - 22 Jan 2012

I've never seen this plugin because there is no PackageForm? on ImmediateNotifyPlugin, therefore no ExtensionClassification. Perhaps it should fall under "Workflow automation"?

-- KipLubliner - 24 Jan 2012

Yeah. It probably should not even be in the Exensions web. The version released to Extensions does not work. The version in Extensions/Testing is somewhat functional. The SVN version has come a long way. I really ought to release it.

-- GeorgeClark - 24 Jan 2012

To discuss development of this extensions please go to Development.ImmediateNotifyPlugin.