internal package Foswiki::Contrib::MailerContrib

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

• Foswiki::Contrib::MailerContrib::Change - Object that represents a change to a topic.
• Foswiki::Contrib::MailerContrib::CompatibilityHacks
• Foswiki::Contrib::MailerContrib::Constants - $ALWAYS - always send, even if there are no changes $FULL_TOPIC - send the full topic rather than just changes
• Foswiki::Contrib::MailerContrib::Subscriber - Object that represents a subscriber to notification. A subscriber is a name (which may be a wikiName or an email address) and a list of subscriptions which describe the topis subscribed to, and unsubscriptions representing topics they are specifically not interested in. The subscriber name may also be a group, so it may expand to many email addresses.
• Foswiki::Contrib::MailerContrib::Subscription - Object that represents a subscription to notification on a set of pages. A subscription is expressed as a set of page specs (each of which may contain wildcards) and a depth of children of matching pages that the user is subscribed to.
• Foswiki::Contrib::MailerContrib::TopicContext
• Foswiki::Contrib::MailerContrib::UpData - Object that lazy-scans topics to extract parent relationships.
• Foswiki::Contrib::MailerContrib::WebNotify - Object that represents the contents of a WebNotify topic in a Foswiki web.

internal package Foswiki::Contrib::MailerContrib

Package of support for extended WebNotify notification, supporting per-topic notification and notification of changes to children.

Also supported is a simple API that can be used to change the WebNotify topic from other code.

StaticMethod mailNotify($webs, $verbose, $exwebs, $nonewsmode, $nochangesmode)

• $webs - filter list of names webs to process. Wildcards (*) may be used.
• $verbose - true to get verbose (debug) output.
• $exwebs - filter list of webs to exclude.
• $nonewsmode - the notify script was called with the -nonews option so we skip news mode
• $nochangesmode - the notify script was called with the -nochanges option

Main entry point.

Process the WebNotify topics in each web and generate and issue notification mails. Designed to be invoked from the command line; should only be called by mailnotify scripts.

StaticMethod changeSubscription($web, $who, $topicList, $unsubscribe)

Modify a user's subscription in WebNotify for a web.

• $web - web to edit the WebNotify for
• $who - the user's wikiname
• $topicList - list of topics to (un)subscribe to(from)
• $unsubscribe - false to subscribe, true to unsubscribe

isSubscribedTo ($web, $who, $topicList) -> boolean

Returns true if all topics mentioned in the $topicList are subscribed to by $who.

Can ignore all valid special characters that can be used on the WebNotify topic such as NewsTopic?! , TopicAndChildren? (2)

parsePageList ( $object, $who, $spec, $unsubscribe ) -> unprocessable remainder of $spec line

Calls $object->{topicSub} once per identified topic entry.

• $object (a hashref) may be a hashref that has the field topicSub, which may be a sub ref as follows: &topicSub($object, $who, $unsubscribe, $webTopic, $options, $childDepth)
• $unsubscribe can be set to '-' to force an unsubscription (used by SubscribePlugin?)