PerlDoc

Enter a module name that to extract the perl documentation, e.g. Foswiki::Func or, Foswiki::Meta.

Check Developing plugins and Developer's Bible for more information.

package Foswiki::Contrib::MailerContrib::WebNotify

Object that represents the contents of a WebNotify topic in a Foswiki web.

Note that $Foswiki::Plugins::SESSION is used to find the Foswiki session, and must be set up before this class is used.

new($web, $topic)

  • $web - web name
  • $topic - topic name
  • $noexpandgroups - True will prevent expansion of group subscriptions (False is best for checking subscriptions, but True is best for writing results back to $topic)
Create a new object by parsing the content of the given topic in the given web. This is the normal way to load a WebNotify topic. If the topic does not exist, it will create an empty object.

writeWebNotify()

Write the object to the WebNotify topic it was read from. If there is a problem writing the topic (e.g. it is locked), the method will throw an exception.

getSubscriber($name, $noAdd)

  • $name - Name of subscriber (wikiname with no web or email address)
  • $noAdd - If false or undef, a new subscriber will be created for this name
Get a subscriber from the list of subscribers, and return a reference to the Subscriber object. If $noAdd is true, and the subscriber is not found, undef will be returned. Otherwise a new Subscriber object will be added if necessary.

getSubscribers()

Get a list of all subscriber names (unsorted)

subscribe($name, $topics, $depth, $options)

  • $name - Name of subscriber (wikiname with no web or email address)
  • $topics - wildcard expression giving topics to subscribe to
  • $depth - Child depth to scan (default 0)
  • $options - Bitmap of Mailer::Const options
Add a subscription, adding the subscriber if necessary.

unsubscribe($name, $topics, $depth)

  • $name - Name of subscriber (wikiname with no web or email address)
  • $topics - wildcard expression giving topics to subscribe to
  • $depth - Child depth to scan (default 0)
Add an unsubscription, adding the subscriber if necessary. An unsubscription is a specific request to ignore notifications for a topic for this particular subscriber.

stringify() -> string

Return a string representation of this object, in WebNotify format.

Optional $subscribersOnly parameter to only print the parsed subscription list. Used when running a mailnotify, where printing out the entire WebNotify topic is confusing, as its different from the actual topic contents, but doesn't inform the user why.

processChange($change, $db, $changeSet, $seenSet, $allSet)

  • $change - ref of a Foswiki::Contrib::Mailer::Change
  • $db - Foswiki::Contrib::MailerContrib::UpData database of parent references
  • $changeSet - ref of a hash mapping emails to sets of changes
  • $seenSet - ref of a hash recording indices of topics already seen
  • $allSet - ref of a hash that maps topics to email addresses for news subscriptions
Find all subscribers that are interested in the given change. Only the most recent change to each topic listed in the .changes file is retained. This method does not change this object.

processCompulsory($topic, $db, \%allSet)

  • $topic - topic name
  • $db - Foswiki::Contrib::MailerContrib::UpData database of parent references
  • \%allSet - ref of a hash that maps topics to email addresses for news subscriptions

isEmpty() -> boolean

Return true if there are no subscribers
Topic revision: r1 - 12 Jan 2011 - 10:59:46 - ProjectContributor
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Eugene Maker Space Wiki? Send feedback