org.mule.providers.email
Class RetrieveMessageReceiver

java.lang.Object
  org.mule.providers.AbstractMessageReceiver
      org.mule.providers.AbstractPollingMessageReceiver
          org.mule.providers.email.RetrieveMessageReceiver

All Implemented Interfaces:

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

public class RetrieveMessageReceiver

extends org.mule.providers.AbstractPollingMessageReceiver

implements MessageCountListener, org.mule.umo.lifecycle.Startable, org.mule.umo.lifecycle.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

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

PHASE_NAME

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

PHASE_NAME

Fields inherited from interface org.mule.umo.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.umo.lifecycle.Disposable

PHASE_NAME

Constructor Summary

RetrieveMessageReceiver(org.mule.umo.provider.UMOConnector connector, org.mule.umo.UMOComponent component, org.mule.umo.endpoint.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 org.mule.umo.UMOMessage	handleUnacceptedFilter(org.mule.umo.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

connect, disconnect, dispose, doInitialise, getComponent, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getReceiverKey, getWorkManager, handleException, initialise, 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(org.mule.umo.provider.UMOConnector connector,
                               org.mule.umo.UMOComponent component,
                               org.mule.umo.endpoint.UMOEndpoint endpoint,
                               long checkFrequency,
                               boolean backupEnabled,
                               String backupFolder)
                        throws org.mule.umo.lifecycle.CreateException

Method Detail

doConnect

protected void doConnect()
                  throws Exception

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Throws:

Exception

doStop

protected void doStop()

doStart

protected 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 -

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()

doDispose

protected void doDispose()