Question

Hi - I'm trying to setup the ImmediateNotifyPlugin, but am unable to figure out the final configuration. I'd like users to be able to flag specific topics, about which they'd like to be notified of changes via email.

ImmediateNotifyPlugin shows up as an active plugin. I've set up a page in my Main web called WebImmediateNotify, per the instructions.

What's missing for me is:

(1) What belongs in WebImmediateNotify?

Do I just list a bunch of names -- e.g. "SamAbrams, JohnAbrams, etc"? Or should it be "* Set SOMETHING = SamAbrams, JohnAbrams"

(2) What belongs in the topic page I want to be notified about?

Do I just write "* Set IMMEDIATENOTIFYMETHOD = SMTP"

[I am trying to get the plugin to simply use sendmail, so I'd like to configure it for SMTP, then leave SMTP settings empty in TWikiPreferences, so sendmail will be the default.]

[Also, it seems worthwile to note, the instructions keep referring to a file named SMTP.pm. Since I couldn't find this file anywhere in the codebase, I ignored all such references.]

(3) What, if any, settings are set in the TWiki.ImmediateNotifyPlugin page?

Thanks !

UPDATE: I have found the following error in warning.txt. This might be related to my problems above:

28 Dec 2003 - 20:35 - : No methods available, initialization failed

-- SamAbrams - 29 Dec 2003

Environment

TWiki version:	TWikiBetaRelease
TWiki plugins:	DefaultPlugin, CalendarPlugin, EditTablePlugin, EmptyPlugin, HiddenTextPlugin, InterwikiPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, SpreadSheetPlugin, TWikiDrawPlugin, TablePlugin
Server OS:	Standard Dreamhost hosting account
Web server:
Perl version:
Client OS:
Web Browser:

Another Question

Ok, I have to agree with the folks in the ImmediateNotifyPluginDev group, the docs are terrible. If you don't want to include some example configs in the distro, please include them in the Dev area. I am unable to get the plugin to recognize the users to notify. My config is as follows:

TWiki/ImmediateNotifyPlugin contains:

• Notification method configuration:
  • • Set METHODS = Jabber
• Jabber method configuration:
  • • Set JABBER_USERNAME = WebImmediateNotify?
    • Set JABBER_PASSWORD = XXXXXXX?
    • Set JABBER_SERVER = jabber.XXXXXX.com

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

Main/WebImmediateNotify contains:

• Set IMMEDIATENOTIFY = EricAiken,

NOTE: I've tried just EricAiken and EricAiken, and also the above.

The topic I'm editing contains:

• Set IMMEDIATENOTIFY = EricAiken
• Jabber: EricAiken@jabberPLEASENOSPAM.risingmist.com

I put some debug statements in the ImmediateNotifyPlugin.pm as follows:

    $text =~ /\t+\* Set IMMEDIATENOTIFY = (.*)/;
    my $topicUserList = $2;
    my @names;
debug("- $pluginName: text=$text");
debug("- $pluginName: 1=$1");
debug("- $pluginName: 2=$2");
debug("- $pluginName: names=@names");
debug("- $pluginName: topicUserList=$topicUserList");
    if ($topicUserList) {
        my @names = split / *[, ] */, $topicUserList;
debug("- $pluginName: names_in_if=@names");
debug("- $pluginName: topicUserList_in_if=$topicUserList");
    }

    my $notifyTopic = TWiki::Func::readTopicText($web, "WebImmediateNotify");
debug("- $pluginName: notifyTopic=$notifyTopic");
    my $mainWeb = TWiki::Func::getPreferencesValue("MAINWEB") || "Main";
    while ($notifyTopic =~ /\t+\* $mainWeb\.([^\r\n]+)/go) {
debug("- $pluginName: Im in the while loop");
        push @names, $1 if $1;
    }

    unless (@names) {
        debug("- $pluginName: No names registered for notification.");
        return;

Here's the debug.txt output:

31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: Loading method Jabber...
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin::Jabber OK
31 Dec 2003 - 09:57 - TWiki::Plugins::ImmediateNotifyPlugin::initPlugin( Main.EricAiken ) is OK
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin::afterSaveHandler( Main.EricAiken )
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: text=      * Name: EricAiken
        * Email: Eric_Aiken@risingmist.com
        * Comment:

        * Set IMMEDIATENOTIFY = Main.EricAiken
        * Jabber: EricAiken@jabber.risingmist.com


__Related topics__
        * %TWIKIWEB%.%WIKIPREFSTOPIC% has site-level preferences of %WIKITOOLNAME%.
        * %WEBPREFSTOPIC% has preferences of the %WIKITOOLNAME%.%WEB% web.
        * %MAINWEB%.%WIKIUSERSTOPIC% has a list of other TWiki users.


31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: 1=Main.EricAiken
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: 2=
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: names=
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: topicUserList=
31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: notifyTopic=%META:TOPICINFO{author="EricAiken" date="1072892974" format="1.0" version="1.3"}%
        * Set IMMEDIATENOTIFY = Main.EricAiken,

31 Dec 2003 - 09:57 - ImmediateNotifyPlugin: No names registered for notification.

Note that $2 is always empty and therefore my $topicUserList = $2; is always empty. I'm not a perl programmer so I'm not sure where i'm going wrong.

I've patched persuant to the ImmediateNotifyPluginDev group suggestions including the SMTP template.

-- EricAiken - 30 Dec 2003

Pretty Much the Same Question

I'm trying to configure the final steps of the ImmediateNotifyPlugin, and I'm not getting any emails out.

What I've Done:

• Installed the ImmediateNotifyPlugin
• Selected it in configure
• ImmediateNotifyPlugin topic includes:

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 = 1 

• Created a WebImmediateNotify in Main web with:

  • Set IMMEDIATENOTIFY = JonSinclair 

• In a topic which I want to be notified if it changes, I added:

  • Set IMMEDIATENOTIFY = JonSinclair 

• Changed topic

But I do not recieve notification of the change. The debug.txt file doesn't contain any errors. Any ideas on what I'm missing?

-- JonSinclair - 18 Sep 2007

Answer

It is not clear from the documentation but the topic should be in the same format as a standard WebNotify topic.

So Main/WebImmediateNotify shouldn't contain:

• Set IMMEDIATENOTIFY = EricAiken

just

• EricAiken

-- SteffenPoulsen - 18 Sep 2007

I changed Main/WebImmediateNotify to contain just my email address in a bullet list, and I still don't receive an email or any errors. I'm going to try the debug scripting above.

-- JonSinclair - 19 Sep 2007

I don't get any output to the debug even though

   * Set DEBUG = 1

is set in my ImmediateNotifyPlugin topic. Any thoughts as to why? Do I need to set this someplace else instead?

-- JonSinclair - 01 Oct 2007

Sorry, closing this after more than 30 days of inactivity. Please open a new question.

-- PeterThoeny - 02 Dec 2007

Did anyone manage to get this plugin to work? The documentation doesnt seem to have much information.

-- RahulJain - 2010-08-25

This plugin is only listed to be tested with TWiki-4.0. It needs some TLC (tender loving care) by a contributor. I invite you to help out or look for a coder who can.

-- PeterThoeny - 2010-08-25