Immediate Notify Plugin

Please read TWiki:Codev.ConsolidateNotification and TWiki:Plugins.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 TWiki is running.

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

  File:	Description:
  lib/TWiki/Plugins/ImmediateNotifyPlugin.pm
  lib/TWiki/Plugins/ImmediateNotifyPlugin/Jabber.pm
  lib/TWiki/Plugins/ImmediateNotifyPlugin/SMTP.pm
  data/TWiki/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 TWiki 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

Related Topics: TWikiPreferences, TWikiPlugins, DefaultPlugin

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