org.xmlBlaster.util.admin
Interface I_AdminPop3Driver

All Superinterfaces:

I_AdminPlugin, I_AdminService, I_AdminUsage

All Known Subinterfaces:

Pop3DriverMBean

All Known Implementing Classes:

Pop3Driver

public interface I_AdminPop3Driver
extends I_AdminService

Declares available methods to control the POP3 email poller.

Since:

1.0.8

Author:

xmlBlaster@marcelruff.info

See Also:

Pop3Driver

Method Summary

long	getHoldbackExpireTimeout()
java.lang.String	getListeners() Access a list of registered java listeners.
int	getNumberOfHoldbackEmails() Get the number of received emails for which no java bean is interested.
long	getPollingInterval() Access the polling interval
java.lang.String	getPop3Url() Access the POP3 MTA access configuration
void	setHoldbackExpireTimeout(long holdbackExpireTimeout) Configure how long a not yet dispatched message shall live in the Pop3Driver map.
void	setPollingInterval(long pollingInterval) Set the polling interval
void	setPop3Url(java.lang.String pop3Url)

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminService

activate, deActivate, isActive

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminPlugin

getType, getVersion, isShutdown, shutdown

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

getPollingInterval

long getPollingInterval()

Access the polling interval

Returns:

The pollingInterval in milli seconds

setPollingInterval

void setPollingInterval(long pollingInterval)

Set the polling interval

Parameters:

pollingInterval - [milli seconds]

getPop3Url

java.lang.String getPop3Url()

Access the POP3 MTA access configuration

Returns:

For example "pop3://user:password@host:port/INBOX"

setPop3Url

void setPop3Url(java.lang.String pop3Url)

Parameters:

pop3Url - Syntax is "pop3://user:password@host:port/INBOX"

getListeners

java.lang.String getListeners()

Access a list of registered java listeners.

Returns:

Keys of interested party for incoming POP3 mails

getHoldbackExpireTimeout

long getHoldbackExpireTimeout()

Returns:

Returns the holdbackExpireTimeout.

setHoldbackExpireTimeout

void setHoldbackExpireTimeout(long holdbackExpireTimeout)

Configure how long a not yet dispatched message shall live in the Pop3Driver map. Note that the map is transient, after restart such mails are lost (but resend by the server).

Parameters:

holdbackExpireTimeout - In milli seconds, set to zero to switch holback off

getNumberOfHoldbackEmails

int getNumberOfHoldbackEmails()

Get the number of received emails for which no java bean is interested.

Returns:

Number of emails