org.springframework.integration.mail.dsl

Class ImapMailInboundChannelAdapterSpec

java.lang.Object

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

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

org.springframework.integration.dsl.MessageSourceSpec<S,MailReceivingMessageSource>

org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec<ImapMailInboundChannelAdapterSpec,ImapMailReceiver>

org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec

All Implemented Interfaces:

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

public class ImapMailInboundChannelAdapterSpec
extends MailInboundChannelAdapterSpec<ImapMailInboundChannelAdapterSpec,ImapMailReceiver>

A MailInboundChannelAdapterSpec for IMAP.

Since:

5.0

Author:

Gary Russell, Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec

externalReceiver, 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.context.SmartLifecycle

DEFAULT_PHASE

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

OBJECT_TYPE_ATTRIBUTE

Method Summary

Modifier and Type	Method and Description
ImapMailInboundChannelAdapterSpec	cancelIdleInterval(long interval) Deprecated. since 5.2: there is no idle task started for polling channel adapter.
ImapMailInboundChannelAdapterSpec	searchTermStrategy(SearchTermStrategy searchTermStrategy) A SearchTermStrategy to use.
ImapMailInboundChannelAdapterSpec	shouldMarkMessagesAsRead(boolean shouldMarkMessagesAsRead) A flag to determine if message should be marked as read.

Methods inherited from class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec

assertReceiver, autoCloseFolder, doGet, embeddedPartsAsBytes, getComponentsToRegister, headerMapper, javaMailAuthenticator, javaMailProperties, javaMailProperties, maxFetchSize, selector, selectorExpression, selectorExpression, session, shouldDeleteMessages, simpleContent, userFlag

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

messageHeaders

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

_this, createInstance, destroyInstance, get, getId, getObjectType, getPhase, id, 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

Method Detail

searchTermStrategy

public ImapMailInboundChannelAdapterSpec searchTermStrategy(SearchTermStrategy searchTermStrategy)

A SearchTermStrategy to use.

Parameters:

searchTermStrategy - the searchTermStrategy.

Returns:

the spec.

See Also:

ImapMailReceiver.setSearchTermStrategy(SearchTermStrategy)

shouldMarkMessagesAsRead

public ImapMailInboundChannelAdapterSpec shouldMarkMessagesAsRead(boolean shouldMarkMessagesAsRead)

A flag to determine if message should be marked as read.

Parameters:

shouldMarkMessagesAsRead - the shouldMarkMessagesAsRead.

Returns:

the spec.

See Also:

ImapMailReceiver.setShouldMarkMessagesAsRead(Boolean)

cancelIdleInterval

@Deprecated
public ImapMailInboundChannelAdapterSpec cancelIdleInterval(long interval)

Deprecated. since 5.2: there is no idle task started for polling channel adapter.

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.0.10

See Also:

ImapMailReceiver.setCancelIdleInterval(long)