org.mule.providers.email
Class RetrieveMessageReceiver

java.lang.Object
  extended by org.mule.providers.AbstractMessageReceiver
      extended by org.mule.providers.AbstractPollingMessageReceiver
          extended by org.mule.providers.email.RetrieveMessageReceiver
All Implemented Interfaces:
EventListener, MessageCountListener, Disposable, Lifecycle, Startable, Stoppable, UMOConnectable, UMOMessageReceiver

public class RetrieveMessageReceiver
extends AbstractPollingMessageReceiver
implements MessageCountListener, Startable, Stoppable

Poll a mailbox for messages, remove the messages and route them as events into Mule. This contains a reference to a mail folder (and also the endpoint and connector, via superclasses)


Field Summary
 
Fields inherited from class org.mule.providers.AbstractPollingMessageReceiver
DEFAULT_POLL_FREQUENCY, DEFAULT_POLL_TIMEUNIT, DEFAULT_STARTUP_DELAY, schedules
 
Fields inherited from class org.mule.providers.AbstractMessageReceiver
component, connected, connecting, connectionStrategy, connector, disposing, endpoint, logger, receiverKey, stopped
 
Constructor Summary
RetrieveMessageReceiver(UMOConnector connector, UMOComponent component, UMOEndpoint endpoint, long checkFrequency, boolean backupEnabled, String backupFolder)
           
 
Method Summary
protected  void doConnect()
           
protected  void doDisconnect()
           
protected  void doDispose()
           
protected  void doStart()
           
protected  void doStop()
           
 Folder getFolder()
           
protected  UMOMessage handleUnacceptedFilter(UMOMessage message)
           
 void messagesAdded(MessageCountEvent event)
           
 void messagesRemoved(MessageCountEvent event)
           
 void poll()
           
 void setFolder(Folder folder)
           
protected  void storeMessage(Message msg)
          Helper method for testing which stores a copy of the message locally as the POP3

message will be deleted from the server

 
Methods inherited from class org.mule.providers.AbstractPollingMessageReceiver
createWork, getFrequency, getTimeUnit, schedule, setFrequency, setTimeUnit, unschedule
 
Methods inherited from class org.mule.providers.AbstractMessageReceiver
applyResponseTransformer, connect, disconnect, dispose, getComponent, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getReceiverKey, getWorkManager, handleException, isConnected, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setComponent, setConnector, setEndpoint, setExceptionDetails, setListener, setReceiverKey, setWorkManager, start, stop, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.mule.umo.lifecycle.Startable
start
 
Methods inherited from interface org.mule.umo.lifecycle.Stoppable
stop
 

Constructor Detail

RetrieveMessageReceiver

public RetrieveMessageReceiver(UMOConnector connector,
                               UMOComponent component,
                               UMOEndpoint endpoint,
                               long checkFrequency,
                               boolean backupEnabled,
                               String backupFolder)
                        throws InitialisationException
Throws:
InitialisationException
Method Detail

doConnect

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

doDisconnect

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

doStop

protected void doStop()
Overrides:
doStop in class AbstractPollingMessageReceiver

doStart

protected void doStart()
                throws UMOException
Overrides:
doStart in class AbstractPollingMessageReceiver
Throws:
UMOException

messagesAdded

public void messagesAdded(MessageCountEvent event)
Specified by:
messagesAdded in interface MessageCountListener

handleUnacceptedFilter

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

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 -

storeMessage

protected void storeMessage(Message msg)
                     throws IOException,
                            MessagingException
Helper method for testing which stores a copy of the message locally as the POP3

message will be deleted from the server

Parameters:
msg - the message to store
Throws:
IOException - If a failure happens writing the message
MessagingException - If a failure happens reading the message

poll

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

doDispose

protected void doDispose()
Specified by:
doDispose in class AbstractMessageReceiver


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.