Package com.xpn.xwiki.plugin.mail

Class MailPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.mail.MailPlugin

All Implemented Interfaces:

XWikiPluginInterface

public class MailPlugin
extends XWikiDefaultPlugin
implements XWikiPluginInterface

Constructor Summary

Constructors

Constructor	Description
MailPlugin(String name, String className, XWikiContext context)

Method Summary

Modifier and Type	Method	Description
void	flushCache()	Older equivalent of the XWikiDefaultPlugin.flushCache(XWikiContext) method without a context provided.
String	getName()	The name which can be used for accessing this plugin from XWiki.getPlugin(String, XWikiContext).
Api	getPluginApi(XWikiPluginInterface plugin, XWikiContext context)	Get a public scriptable API that can be used to call methods of the (privileged) plugin.
void	init(XWikiContext context)	Global initialization, called when the platform is started and the plugin list is initialized.

Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, getClassName, getLocalization, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xpn.xwiki.plugin.XWikiPluginInterface

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, insidePREHandler, outsidePREHandler, startRenderingHandler, virtualInit

Constructor Detail

MailPlugin

public MailPlugin(String name,
                  String className,
                  XWikiContext context)

Method Detail

getName

public String getName()

Description copied from interface: XWikiPluginInterface

The name which can be used for accessing this plugin from XWiki.getPlugin(String, XWikiContext).

Specified by:

getName in interface XWikiPluginInterface

Overrides:

getName in class XWikiDefaultPlugin

Returns:

the plugin name, usually a lowercase identifier

getPluginApi

public Api getPluginApi(XWikiPluginInterface plugin,
                        XWikiContext context)

Description copied from interface: XWikiPluginInterface

Get a public scriptable API that can be used to call methods of the (privileged) plugin.

Specified by:

getPluginApi in interface XWikiPluginInterface

Overrides:

getPluginApi in class XWikiDefaultPlugin

Parameters:

plugin - the plugin instance to wrap

context - the current request context

Returns:

an instance of the corresponding API, or null if the plugin doesn't want to expose a public API

flushCache

public void flushCache()

Description copied from class: XWikiDefaultPlugin

Older equivalent of the XWikiDefaultPlugin.flushCache(XWikiContext) method without a context provided.

Overrides:

flushCache in class XWikiDefaultPlugin

init

public void init(XWikiContext context)

Description copied from interface: XWikiPluginInterface

Global initialization, called when the platform is started and the plugin list is initialized.

Specified by:

init in interface XWikiPluginInterface

Overrides:

init in class XWikiDefaultPlugin

Parameters:

context - the current context, should not be stored since it will become mostly unreliable once the initial request is terminated