org.mule.transport.email
Class RetrieveMessageReceiver

java.lang.Object
  org.mule.transport.AbstractTransportMessageHandler
      org.mule.transport.AbstractMessageReceiver
          org.mule.transport.AbstractPollingMessageReceiver
              org.mule.transport.email.RetrieveMessageReceiver

All Implemented Interfaces:

EventListener, MessageCountListener, Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, MessageSource, Connectable, MessageReceiver

public class RetrieveMessageReceiver
extends AbstractPollingMessageReceiver
implements MessageCountListener

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.transport.AbstractPollingMessageReceiver

DEFAULT_POLL_FREQUENCY, DEFAULT_POLL_TIMEUNIT, DEFAULT_STARTUP_DELAY, schedules

Fields inherited from class org.mule.transport.AbstractMessageReceiver

defaultInboundTransformers, defaultResponseTransformers, flowConstruct, listener, receiverKey, replyToHandler

Fields inherited from class org.mule.transport.AbstractTransportMessageHandler

connected, connector, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

RetrieveMessageReceiver(Connector connector, FlowConstruct flowConstruct, InboundEndpoint 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 MuleMessage	handleUnacceptedFilter(MuleMessage message)
void	messagesAdded(MessageCountEvent event)
void	messagesRemoved(MessageCountEvent event)
void	poll()
protected boolean	pollOnPrimaryInstanceOnly() If this returns true for a transport, polling for that transport takes place only on the primary instance.
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.transport.AbstractPollingMessageReceiver

createWork, disableNativeScheduling, getBatchSize, getFrequency, getTimeUnit, performPoll, schedule, setFrequency, setTimeUnit, unschedule

Methods inherited from class org.mule.transport.AbstractMessageReceiver

applyInboundTransformers, applyResponseTransformers, connectHandler, createExecutionTemplate, createLifecycleManager, createMuleEvent, doStartHandler, getConnectEventId, getConnectionDescription, getEndpoint, getEndpointURI, getFlowConstruct, getReceiverKey, getReplyToHandler, getWorkManager, initialise, processMessage, propagateRootMessageIdProperty, routeEvent, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setEndpoint, setListener, setReceiverKey, shouldConsumeInEveryNode, toString, warnIfMuleClientSendUsed

Methods inherited from class org.mule.transport.AbstractTransportMessageHandler

activate, connect, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, getConnectEventId, getConnector, getLifecycleState, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopped, isStopping, passivate, setEndpoint, start, stop, validate, validateConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transport.MessageReceiver

createMuleMessage, createMuleMessage

Methods inherited from interface org.mule.api.transport.Connectable

connect, disconnect, isConnected, validateConnection

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

start

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

stop

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Constructor Detail

RetrieveMessageReceiver

public RetrieveMessageReceiver(Connector connector,
                               FlowConstruct flowConstruct,
                               InboundEndpoint endpoint,
                               long checkFrequency,
                               boolean backupEnabled,
                               String backupFolder)
                        throws CreateException

Throws:

CreateException

Method Detail

doConnect

protected void doConnect()
                  throws Exception

Overrides:

doConnect in class AbstractTransportMessageHandler

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Overrides:

doDisconnect in class AbstractTransportMessageHandler

Throws:

Exception

doStop

protected void doStop()
               throws MuleException

Overrides:

doStop in class AbstractPollingMessageReceiver

Throws:

MuleException

doStart

protected void doStart()
                throws MuleException

Overrides:

doStart in class AbstractPollingMessageReceiver

Throws:

MuleException

messagesAdded

public void messagesAdded(MessageCountEvent event)

Specified by:

messagesAdded in interface MessageCountListener

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

pollOnPrimaryInstanceOnly

protected boolean pollOnPrimaryInstanceOnly()

Description copied from class: AbstractPollingMessageReceiver

If this returns true for a transport, polling for that transport takes place only on the primary instance.

Overrides:

pollOnPrimaryInstanceOnly in class AbstractPollingMessageReceiver

doDispose

protected void doDispose()

Overrides:

doDispose in class AbstractMessageReceiver

handleUnacceptedFilter

protected MuleMessage handleUnacceptedFilter(MuleMessage message)

Overrides:

handleUnacceptedFilter in class AbstractMessageReceiver