Package org.springframework.integration.mail.dsl

Class ImapIdleChannelAdapterSpec

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<T>

org.springframework.integration.dsl.IntegrationComponentSpec<S,P>

org.springframework.integration.dsl.MessageProducerSpec<ImapIdleChannelAdapterSpec,ImapIdleChannelAdapter>

org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, DisposableBean, FactoryBean<ImapIdleChannelAdapter>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

public class ImapIdleChannelAdapterSpec
extends MessageProducerSpec<ImapIdleChannelAdapterSpec,ImapIdleChannelAdapter>
implements ComponentsRegistration

A MessageProducerSpec for a ImapIdleChannelAdapter.

Since:

5.0

Author:

Gary Russell, Artem Bilan, Freya Nair

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<Object,String>	componentsToRegister
protected final boolean	externalReceiver
protected final ImapMailReceiver	receiver

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

PARSER, target

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImapIdleChannelAdapterSpec(ImapMailReceiver receiver)
protected	ImapIdleChannelAdapterSpec(ImapMailReceiver receiver, boolean externalReceiver)

Method Summary

Modifier and Type	Method	Description
ImapIdleChannelAdapterSpec	adviceChain(Advice... adviceChain)	Configure a chain of Advice objects for message delivery, applied to the downstream flow.
ImapIdleChannelAdapterSpec	autoCloseFolder(boolean autoCloseFolder)	When configured to false, the folder is not closed automatically after a fetch.
ImapIdleChannelAdapterSpec	cancelIdleInterval(long interval)	How often to recycle the idle task (in case of a silently dropped connection).
ImapIdleChannelAdapterSpec	embeddedPartsAsBytes(boolean embeddedPartsAsBytes)	When a header mapper is provided determine whether an embedded Part (e.g Message or Multipart content is rendered as a byte[] in the payload.
Map<Object,String>	getComponentsToRegister()
ImapIdleChannelAdapterSpec	headerMapper(HeaderMapper<MimeMessage> headerMapper)	Set the header mapper; if a header mapper is not provided, the message payload is a MimeMessage, when provided, the headers are mapped and the payload is the MimeMessage content.
ImapIdleChannelAdapterSpec	javaMailAuthenticator(Authenticator javaMailAuthenticator)
ImapIdleChannelAdapterSpec	javaMailProperties(Consumer<PropertiesBuilder> configurer)	Configure the javaMailProperties by invoking a Consumer callback which is invoked with a PropertiesBuilder.
ImapIdleChannelAdapterSpec	javaMailProperties(Properties javaMailProperties)
ImapIdleChannelAdapterSpec	maxFetchSize(int maxFetchSize)
ImapIdleChannelAdapterSpec	reconnectDelay(long reconnectDelay)	The time between connection attempts in milliseconds (default 10 seconds).
ImapIdleChannelAdapterSpec	searchTermStrategy(SearchTermStrategy searchTermStrategy)
ImapIdleChannelAdapterSpec	selector(Function<MimeMessage,Boolean> selectorFunction)	Configure a Function to select messages.
ImapIdleChannelAdapterSpec	selectorExpression(String selectorExpression)	Configure a SpEL expression to select messages.
ImapIdleChannelAdapterSpec	selectorExpression(Expression selectorExpression)	Configure an Expression to select messages.
ImapIdleChannelAdapterSpec	sendingTaskExecutor(Executor sendingTaskExecutor)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1 in favor of async hands-off downstream in the flow, e.g.
ImapIdleChannelAdapterSpec	session(Session session)	A Java Mail Session to use.
ImapIdleChannelAdapterSpec	shouldDeleteMessages(boolean shouldDeleteMessages)
ImapIdleChannelAdapterSpec	shouldMarkMessagesAsRead(boolean shouldMarkMessagesAsRead)
ImapIdleChannelAdapterSpec	shouldReconnectAutomatically(boolean shouldReconnectAutomatically)
ImapIdleChannelAdapterSpec	simpleContent(boolean simpleContent)	Determine how the content is rendered.
ImapIdleChannelAdapterSpec	transactional()	Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the downstream flow.
ImapIdleChannelAdapterSpec	transactional(TransactionInterceptor transactionInterceptor)	Specify a TransactionInterceptor Advice for the downstream flow.
ImapIdleChannelAdapterSpec	transactional(TransactionManager transactionManager)	Specify a TransactionInterceptor Advice with the provided TransactionManager and default DefaultTransactionAttribute for the downstream flow.
ImapIdleChannelAdapterSpec	transactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)	Configure a TransactionSynchronizationFactory.
ImapIdleChannelAdapterSpec	userFlag(String userFlag)	Set the name of the flag to use to flag messages when the server does not support \Recent but supports user flags; default "spring-integration-mail-adapter".

Methods inherited from class org.springframework.integration.dsl.MessageProducerSpec

autoStartup, errorChannel, errorChannel, errorMessageStrategy, id, outputChannel, outputChannel, phase, sendTimeout, shouldTrack

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, createInstance, destroyInstance, doGet, get, getId, getObjectType, getPhase, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

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

Field Details

receiver

protected final ImapMailReceiver receiver

componentsToRegister

protected final Map<Object,String> componentsToRegister

externalReceiver

protected final boolean externalReceiver

Constructor Details

ImapIdleChannelAdapterSpec

protected ImapIdleChannelAdapterSpec(ImapMailReceiver receiver)

ImapIdleChannelAdapterSpec

protected ImapIdleChannelAdapterSpec(ImapMailReceiver receiver,
 boolean externalReceiver)

Method Details

selectorExpression

public ImapIdleChannelAdapterSpec selectorExpression(String selectorExpression)

Configure a SpEL expression to select messages. The root object for the expression evaluation is a MimeMessage which should return a boolean result (true means select the message).

Parameters:

selectorExpression - the selectorExpression.

Returns:

the spec.

selectorExpression

public ImapIdleChannelAdapterSpec selectorExpression(Expression selectorExpression)

Configure an Expression to select messages. The root object for the expression evaluation is a MimeMessage which should return a boolean result (true means select the message).

Parameters:

selectorExpression - the selectorExpression.

Returns:

the spec.

selector

public ImapIdleChannelAdapterSpec selector(Function<MimeMessage,Boolean> selectorFunction)

Configure a Function to select messages. The argument for the function is a MimeMessage; apply returns a boolean result (true means select the message).

Parameters:

selectorFunction - the selectorFunction.

Returns:

the spec.

See Also:

• FunctionExpression

session

public ImapIdleChannelAdapterSpec session(Session session)

A Java Mail Session to use.

Parameters:

session - the session.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setSession(Session)

javaMailProperties

public ImapIdleChannelAdapterSpec javaMailProperties(Properties javaMailProperties)

Parameters:

javaMailProperties - the javaMailProperties.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setJavaMailProperties(Properties)

javaMailProperties

public ImapIdleChannelAdapterSpec javaMailProperties(Consumer<PropertiesBuilder> configurer)

Configure the javaMailProperties by invoking a Consumer callback which is invoked with a PropertiesBuilder.

Parameters:

configurer - the configurer.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setJavaMailProperties(Properties)

javaMailAuthenticator

public ImapIdleChannelAdapterSpec javaMailAuthenticator(Authenticator javaMailAuthenticator)

Parameters:

javaMailAuthenticator - the javaMailAuthenticator.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setJavaMailAuthenticator(Authenticator)

maxFetchSize

public ImapIdleChannelAdapterSpec maxFetchSize(int maxFetchSize)

Parameters:

maxFetchSize - the maxFetchSize.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setMaxFetchSize(int)

shouldDeleteMessages

public ImapIdleChannelAdapterSpec shouldDeleteMessages(boolean shouldDeleteMessages)

Parameters:

shouldDeleteMessages - the shouldDeleteMessages.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setShouldDeleteMessages(boolean)

searchTermStrategy

public ImapIdleChannelAdapterSpec searchTermStrategy(SearchTermStrategy searchTermStrategy)

Parameters:

searchTermStrategy - the searchTermStrategy.

Returns:

the spec.

See Also:

• ImapMailReceiver.setSearchTermStrategy(SearchTermStrategy)

shouldMarkMessagesAsRead

public ImapIdleChannelAdapterSpec shouldMarkMessagesAsRead(boolean shouldMarkMessagesAsRead)

Parameters:

shouldMarkMessagesAsRead - the shouldMarkMessagesAsRead.

Returns:

the spec.

See Also:

• ImapMailReceiver.setShouldMarkMessagesAsRead(Boolean)

userFlag

public ImapIdleChannelAdapterSpec userFlag(String userFlag)

Set the name of the flag to use to flag messages when the server does not support \Recent but supports user flags; default "spring-integration-mail-adapter".

Parameters:

userFlag - the flag.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setUserFlag(String)

headerMapper

public ImapIdleChannelAdapterSpec headerMapper(HeaderMapper<MimeMessage> headerMapper)

Set the header mapper; if a header mapper is not provided, the message payload is a MimeMessage, when provided, the headers are mapped and the payload is the MimeMessage content.

Parameters:

headerMapper - the header mapper.

Returns:

the spec.

See Also:

• AbstractMailReceiver.setUserFlag(String)
• embeddedPartsAsBytes(boolean)

embeddedPartsAsBytes

public ImapIdleChannelAdapterSpec embeddedPartsAsBytes(boolean embeddedPartsAsBytes)

When a header mapper is provided determine whether an embedded Part (e.g Message or Multipart content is rendered as a byte[] in the payload. Otherwise, leave as a Part. These objects are not suitable for downstream serialization. Default: true.

This has no effect if there is no header mapper, in that case the payload is the MimeMessage.

Parameters:

embeddedPartsAsBytes - the embeddedPartsAsBytes to set.

Returns:

the spec.

See Also:

• headerMapper(HeaderMapper)

autoCloseFolder

public ImapIdleChannelAdapterSpec autoCloseFolder(boolean autoCloseFolder)

When configured to false, the folder is not closed automatically after a fetch. It is the target application's responsibility to close it using the IntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE header from the message produced by this channel adapter.

Parameters:

autoCloseFolder - set to false to keep folder opened.

Returns:

the spec.

Since:

5.2

See Also:

• AbstractMailReceiver.setAutoCloseFolder(boolean)

transactionSynchronizationFactory

public ImapIdleChannelAdapterSpec transactionSynchronizationFactory(TransactionSynchronizationFactory transactionSynchronizationFactory)

Configure a TransactionSynchronizationFactory. Usually used to synchronize message deletion with some external transaction manager.

Parameters:

transactionSynchronizationFactory - the transactionSynchronizationFactory.

Returns:

the spec.

adviceChain

public ImapIdleChannelAdapterSpec adviceChain(Advice... adviceChain)

Configure a chain of Advice objects for message delivery, applied to the downstream flow.

Parameters:

adviceChain - the advice chain.

Returns:

the spec.

transactional

public ImapIdleChannelAdapterSpec transactional(TransactionManager transactionManager)

Specify a TransactionInterceptor Advice with the provided TransactionManager and default DefaultTransactionAttribute for the downstream flow.

Parameters:

transactionManager - the TransactionManager to use.

Returns:

the spec.

Since:

5.2.5

transactional

public ImapIdleChannelAdapterSpec transactional(TransactionInterceptor transactionInterceptor)

Specify a TransactionInterceptor Advice for the downstream flow.

Parameters:

transactionInterceptor - the TransactionInterceptor to use.

Returns:

the spec.

See Also:

• TransactionInterceptorBuilder

transactional

public ImapIdleChannelAdapterSpec transactional()

Specify a TransactionInterceptor Advice with default PlatformTransactionManager and DefaultTransactionAttribute for the downstream flow.

Returns:

the spec.

sendingTaskExecutor

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

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

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

Specify a task executor to be used to send messages to the downstream flow.

Parameters:

sendingTaskExecutor - the sendingTaskExecutor.

Returns:

the spec.

shouldReconnectAutomatically

public ImapIdleChannelAdapterSpec shouldReconnectAutomatically(boolean shouldReconnectAutomatically)

Parameters:

shouldReconnectAutomatically - the shouldReconnectAutomatically.

Returns:

the spec.

See Also:

• ImapIdleChannelAdapter.setShouldReconnectAutomatically(boolean)

cancelIdleInterval

public ImapIdleChannelAdapterSpec cancelIdleInterval(long interval)

How often to recycle the idle task (in case of a silently dropped connection). Seconds; default 120 (2 minutes).

Parameters:

interval - the interval.

Returns:

the spec.

Since:

5.2

See Also:

• ImapMailReceiver.setCancelIdleInterval(long)

reconnectDelay

public ImapIdleChannelAdapterSpec reconnectDelay(long reconnectDelay)

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

Parameters:

reconnectDelay - the reconnectDelay to set.

Returns:

the spec.

Since:

6.0

simpleContent

public ImapIdleChannelAdapterSpec simpleContent(boolean simpleContent)

Determine how the content is rendered.

Parameters:

simpleContent - true for simple content.

Returns:

the spec.

Since:

5.5

See Also:

• AbstractMailReceiver.setSimpleContent(boolean)

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration