Package com.xpn.xwiki.plugin.mail

Class MailPluginApi

java.lang.Object

com.xpn.xwiki.api.Api

com.xpn.xwiki.plugin.mail.MailPluginApi

public class MailPluginApi
extends Api

Field Summary

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

Constructors

Constructor	Description
MailPluginApi(MailPlugin plugin, XWikiContext context)

Method Summary

Modifier and Type	Method	Description
int	checkMail(String provider, String server, String user, String password)
javax.mail.Message[]	getMail(String provider, String server, String user, String password)
javax.mail.Message[]	getMailHeaders(String provider, String server, String user, String password)
MailPlugin	getPlugin()
javax.mail.Store	getStore(String provider)
void	setPlugin(MailPlugin plugin)

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, convert, convertAttachments, getAuthorizationManager, getContextualAuthorizationManager, getXWikiContext, hasAccess, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights

Methods inherited from class java.lang.Object

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

Constructor Detail

MailPluginApi

public MailPluginApi(MailPlugin plugin,
                     XWikiContext context)

Method Detail

getPlugin

public MailPlugin getPlugin()

setPlugin

public void setPlugin(MailPlugin plugin)

checkMail

public int checkMail(String provider,
                     String server,
                     String user,
                     String password)
              throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getMailHeaders

public javax.mail.Message[] getMailHeaders(String provider,
                                           String server,
                                           String user,
                                           String password)
                                    throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getMail

public javax.mail.Message[] getMail(String provider,
                                    String server,
                                    String user,
                                    String password)
                             throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

getStore

public javax.mail.Store getStore(String provider)
                          throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException