org.ceryle.wiki.plugin.emailnotifier
Class NotifierTask

java.lang.Object
  org.ceryle.wiki.plugin.emailnotifier.NotifierTask

public class NotifierTask
extends Object

This is the task that does all the work for the EmailNotifier.

Parameters:

• emailnotifier.minuteOffset - If desired the plugin can specify an offset number of minutes from the top of the hour. This is very useful if you have multiple wikis so you can stagger the load on the server. Defaults to a RANDOM 0-59 so if it's not set
• emailnotifier.mail.* - Are placed into a separate Properties object and feed to javax.mail.Session as 'mail.*' You can speciy any properties that you wish, see javax.mail javadoc for the various properties you might want to set, server, port, etc.
• emailnotifier.fromAddress - Email address that the notification message will appear to be from, defaults to 'JSPWiki'
• emailnotifier.subjectLine - Subject line to be used on the notification message, defaults to 'Notification from JSPWiki'
• emailnotifer.subscriptionPage - Name of the wiki page containing subscriptions, defaults to 'NotificationList'

Author:

John Volkar (john.volkar at gmail.com), StevenPozarycki

Field Summary

static String	PROP_EMAIL_PASSWORD
static String	PROP_EMAIL_USERID

Constructor Summary

NotifierTask(WikiEngine engine)
Basic constructor, accepts the app name that we serve as notifier for, schedules this task to run.

Method Summary

void	sendEmail(String message, String address) Given an email text and an email address, sends that email to the provided email address.
protected String	subscriptionPageText() Return the (raw, untranslated) wiki text of the designated subscription page.
void	updateFormatter(Map paramMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_EMAIL_USERID

public static final String PROP_EMAIL_USERID

See Also:

Constant Field Values

PROP_EMAIL_PASSWORD

public static final String PROP_EMAIL_PASSWORD

See Also:

Constant Field Values

Constructor Detail

NotifierTask

public NotifierTask(WikiEngine engine)
             throws javax.mail.internet.AddressException

Basic constructor, accepts the app name that we serve as notifier for, schedules this task to run.

Parameters:

engine - the WikiEngine used.

Throws:

javax.mail.internet.AddressException

Method Detail

sendEmail

public void sendEmail(String message,
                      String address)

Given an email text and an email address, sends that email to the provided email address.

subscriptionPageText

protected String subscriptionPageText()

Return the (raw, untranslated) wiki text of the designated subscription page.

updateFormatter

public void updateFormatter(Map paramMap)