org.mule.providers.email
Class Pop3MessageReceiver

java.lang.Object
  org.mule.providers.AbstractMessageReceiver
      org.mule.providers.PollingMessageReceiver
          org.mule.providers.email.Pop3MessageReceiver

All Implemented Interfaces:

org.mule.umo.lifecycle.Disposable, EventListener, org.mule.umo.lifecycle.Lifecycle, MessageCountListener, Runnable, org.mule.umo.lifecycle.Startable, org.mule.umo.lifecycle.Stoppable, org.mule.umo.provider.UMOConnectable, org.mule.umo.provider.UMOMessageReceiver, Work

public class Pop3MessageReceiver

extends org.mule.providers.PollingMessageReceiver

implements MessageCountListener, org.mule.umo.lifecycle.Startable, org.mule.umo.lifecycle.Stoppable

Pop3MessageReceiver polls a POP3 mailbox for messages, removes the messages and routes them as events into Mule.

Field Summary

protected Session

session

Fields inherited from class org.mule.providers.PollingMessageReceiver

DEFAULT_POLL_FREQUENCY, frequency, STARTUP_DELAY

Fields inherited from class org.mule.providers.AbstractMessageReceiver

component, connected, connectionStrategy, disposing, endpoint, logger, stopped

Constructor Summary

Pop3MessageReceiver(org.mule.umo.provider.UMOConnector connector, org.mule.umo.UMOComponent component, org.mule.umo.endpoint.UMOEndpoint endpoint, Long checkFrequency, String backupFolder)

Method Summary

void	doConnect()
void	doDisconnect()
protected void	doDispose()
void	doStart()
void	doStop()
Folder	getFolder()
protected org.mule.umo.UMOMessage	handleUnacceptedFilter(org.mule.umo.UMOMessage message)
void	messagesAdded(MessageCountEvent event)
void	messagesRemoved(MessageCountEvent event)
void	poll()
void	setFolder(Folder folder)

Methods inherited from class org.mule.providers.PollingMessageReceiver

getFrequency, release, run, setFrequency

Methods inherited from class org.mule.providers.AbstractMessageReceiver

applyResponseTransformer, connect, disconnect, dispose, getComponent, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getWorkManager, handleException, isConnected, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setComponent, setConnector, setEndpoint, setExceptionDetails, setListener, setWorkManager, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.umo.lifecycle.Startable

start

Methods inherited from interface org.mule.umo.lifecycle.Stoppable

stop

Field Detail

session

protected Session session

Constructor Detail

Pop3MessageReceiver

public Pop3MessageReceiver(org.mule.umo.provider.UMOConnector connector,
                           org.mule.umo.UMOComponent component,
                           org.mule.umo.endpoint.UMOEndpoint endpoint,
                           Long checkFrequency,
                           String backupFolder)
                    throws org.mule.umo.lifecycle.InitialisationException

Method Detail

doConnect

public void doConnect()
               throws Exception

Throws:

Exception

doDisconnect

public void doDisconnect()
                  throws Exception

Throws:

Exception

doStop

public void doStop()

doStart

public void doStart()
             throws org.mule.umo.UMOException

Throws:

org.mule.umo.UMOException

messagesAdded

public void messagesAdded(MessageCountEvent event)

Specified by:

messagesAdded in interface MessageCountListener

handleUnacceptedFilter

protected org.mule.umo.UMOMessage handleUnacceptedFilter(org.mule.umo.UMOMessage message)

messagesRemoved

public void messagesRemoved(MessageCountEvent event)

Specified by:

messagesRemoved in interface MessageCountListener

getFolder

public Folder getFolder()

Returns:

the current Mail folder

setFolder

public void setFolder(Folder folder)

Parameters:

folder -

poll

public void poll()

doDispose

protected void doDispose()