org.mule.providers.email
Class Pop3MessageReceiver

java.lang.Object
  extended byorg.mule.providers.AbstractMessageReceiver
      extended byorg.mule.providers.PollingMessageReceiver
          extended byorg.mule.providers.email.Pop3MessageReceiver
All Implemented Interfaces:
Disposable, Lifecycle, Startable, Stoppable, UMOConnectable, UMOMessageReceiver

public class Pop3MessageReceiver
extends PollingMessageReceiver
implements Startable, 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(UMOConnector connector, UMOComponent component, UMOEndpoint endpoint, Long checkFrequency, String backupFolder)
           
 
Method Summary
 void doConnect()
           
 void doDisconnect()
           
protected  void doDispose()
          Template method to dispose any resources associated with this receiver.
 void doStart()
           
 void doStop()
           
 Folder getFolder()
           
protected  UMOMessage handleUnacceptedFilter(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(UMOConnector connector,
                           UMOComponent component,
                           UMOEndpoint endpoint,
                           Long checkFrequency,
                           String backupFolder)
                    throws InitialisationException
Method Detail

doConnect

public void doConnect()
               throws Exception
Specified by:
doConnect in class AbstractMessageReceiver
Throws:
Exception

doDisconnect

public void doDisconnect()
                  throws Exception
Specified by:
doDisconnect in class AbstractMessageReceiver
Throws:
Exception

doStop

public void doStop()
Overrides:
doStop in class AbstractMessageReceiver

doStart

public void doStart()
             throws UMOException
Overrides:
doStart in class PollingMessageReceiver
Throws:
UMOException

messagesAdded

public void messagesAdded(MessageCountEvent event)

handleUnacceptedFilter

protected UMOMessage handleUnacceptedFilter(UMOMessage message)
Overrides:
handleUnacceptedFilter in class AbstractMessageReceiver

messagesRemoved

public void messagesRemoved(MessageCountEvent event)

getFolder

public Folder getFolder()
Returns:
the current Mail folder

setFolder

public void setFolder(Folder folder)
Parameters:
folder -

poll

public void poll()
Specified by:
poll in class PollingMessageReceiver

doDispose

protected void doDispose()
Description copied from class: AbstractMessageReceiver
Template method to dispose any resources associated with this receiver. There is not need to dispose the connector as this is already done by the framework

Overrides:
doDispose in class AbstractMessageReceiver


Copyright © 2003-2006 MuleSource Inc.. All Rights Reserved.