Package 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:

Aware, BeanClassLoaderAware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent

public class ImapIdleChannelAdapter
extends MessageProducerSupport
implements BeanClassLoaderAware, ApplicationEventPublisherAware

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.

Author:

Arjen Poutsma, Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ImapIdleChannelAdapter.ImapIdleExceptionEvent

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ImapIdleChannelAdapter(ImapMailReceiver mailReceiver)

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doStart()	Take no action by default.
protected void	doStop()	Take no action by default.
String	getComponentType()	Subclasses may implement this method to provide component type information.
void	setAdviceChain(List<Advice> adviceChain)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setBeanClassLoader(ClassLoader classLoader)
void	setReconnectDelay(long reconnectDelay)	The time between connection attempts in milliseconds (default 10 seconds).
void	setSendingTaskExecutor(Executor sendingTaskExecutor)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.0.5 in favor of async hands-off downstream in the flow, e.g.
void	setShouldReconnectAutomatically(boolean shouldReconnectAutomatically)	Specify whether the IDLE task should reconnect automatically after catching a FolderClosedException while waiting for messages.
void	setTransactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getErrorMessageStrategy, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, isObserved, onInit, registerObservationRegistry, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setObservationConvention, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

doStop, getPhase, getRole, isActive, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getManagedName, getManagedType, getOverrides, getThisAs, isLoggingEnabled, registerMetricsCaptor, setLoggingEnabled, setManagedName, setManagedType

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Details

ImapIdleChannelAdapter

public ImapIdleChannelAdapter(ImapMailReceiver mailReceiver)

Method Details

setTransactionSynchronizationFactory

public void setTransactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)

setAdviceChain

public void setAdviceChain(List<Advice> adviceChain)

setSendingTaskExecutor

@Deprecated(since="6.0.5",
            forRemoval=true)
public void setSendingTaskExecutor(Executor sendingTaskExecutor)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.0.5 in favor of async hands-off downstream in the flow, e.g. ExecutorChannel.

Specify an Executor used to send messages received by the adapter.

Parameters:

sendingTaskExecutor - the sendingTaskExecutor to set

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.

Parameters:

shouldReconnectAutomatically - true to reconnect.

setReconnectDelay

public void setReconnectDelay(long reconnectDelay)

The time between connection attempts in milliseconds (default 10 seconds).

Parameters:

reconnectDelay - the reconnectDelay to set

Since:

3.0.5

getComponentType

public 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

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement

Overrides:

destroy in class AbstractEndpoint