org.springframework.integration.mail
Class ImapIdleChannelAdapter
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
org.springframework.integration.endpoint.AbstractEndpoint
org.springframework.integration.endpoint.MessageProducerSupport
org.springframework.integration.mail.ImapIdleChannelAdapter
- All Implemented Interfaces:
- BeanFactoryAware, BeanNameAware, InitializingBean, Lifecycle, Phased, SmartLifecycle, NamedComponent, MessageProducer, TrackableComponent
public class ImapIdleChannelAdapter
- extends MessageProducerSupport
An event-driven Channel Adapter that receives mail messages from a mail
server that supports the IMAP "idle" command (see RFC 2177). Received mail
messages will be converted and sent as Spring Integration Messages to the
output channel. The Message payload will be the Message
instance that was received.
Method Summary |
protected void |
doStart()
Takes no action by default. |
protected void |
doStop()
Takes no action by default. |
java.lang.String |
getComponentType()
Subclasses may implement this method to provide component type information. |
protected void |
handleMailMessagingException(javax.mail.MessagingException e)
|
void |
setShouldReconnectAutomatically(boolean shouldReconnectAutomatically)
Specify whether the IDLE task should reconnect automatically after
catching a FolderClosedException while waiting for messages. |
void |
setTaskExecutor(java.util.concurrent.Executor taskExecutor)
Deprecated. As of release 2.0.5 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
ImapIdleChannelAdapter
public ImapIdleChannelAdapter(ImapMailReceiver mailReceiver)
setShouldReconnectAutomatically
public void setShouldReconnectAutomatically(boolean shouldReconnectAutomatically)
- Specify whether the IDLE task should reconnect automatically after
catching a
FolderClosedException
while waiting for messages. The
default value is true
.
setTaskExecutor
@Deprecated
public void setTaskExecutor(java.util.concurrent.Executor taskExecutor)
- Deprecated. As of release 2.0.5
- Parameters:
taskExecutor
-
getComponentType
public java.lang.String getComponentType()
- Description copied from class:
IntegrationObjectSupport
- Subclasses may implement this method to provide component type information.
- Specified by:
getComponentType
in interface NamedComponent
- Overrides:
getComponentType
in class IntegrationObjectSupport
handleMailMessagingException
protected void handleMailMessagingException(javax.mail.MessagingException e)
doStart
protected void doStart()
- Description copied from class:
MessageProducerSupport
- Takes no action by default. Subclasses may override this if they
need lifecycle-managed behavior.
- Overrides:
doStart
in class MessageProducerSupport
doStop
protected void doStop()
- Description copied from class:
MessageProducerSupport
- Takes no action by default. Subclasses may override this if they
need lifecycle-managed behavior.
- Overrides:
doStop
in class MessageProducerSupport