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)
Methods inherited from class org.mule.transport.AbstractMessageReceiver |
applyInboundTransformers, applyResponseTransformers, createExecutionTemplate, createLifecycleManager, createMuleEvent, getConnectEventId, getConnectionDescription, getEndpoint, getEndpointURI, getFlowConstruct, getReceiverKey, getReplyToHandler, getWorkManager, initialise, propagateRootMessageIdProperty, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setEndpoint, setListener, setReceiverKey, 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, isStopping, passivate, setEndpoint, start, stop, validate, validateConnection |
Methods inherited from interface org.mule.api.lifecycle.Startable |
start |
Methods inherited from interface org.mule.api.lifecycle.Stoppable |
stop |
RetrieveMessageReceiver
public RetrieveMessageReceiver(Connector connector,
FlowConstruct flowConstruct,
InboundEndpoint endpoint,
long checkFrequency,
boolean backupEnabled,
String backupFolder)
throws CreateException
- Throws:
CreateException
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()
- Overrides:
doStop
in class AbstractPollingMessageReceiver
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
Copyright © 2003-2012 MuleSoft, Inc.. All Rights Reserved.