Class ImapMailInboundChannelAdapterSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<ImapMailInboundChannelAdapterSpec, MailReceivingMessageSource>

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

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

org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec

All Implemented Interfaces:

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 MailInboundChannelAdapterSpec

externalReceiver, receiver

Fields inherited from class IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ImapMailInboundChannelAdapterSpec()
protected	ImapMailInboundChannelAdapterSpec(String url)
protected	ImapMailInboundChannelAdapterSpec(ImapMailReceiver imapMailReceiver)

Method Summary

Modifier and Type	Method	Description
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 MailInboundChannelAdapterSpec

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

Methods inherited from class MessageSourceSpec

messageHeaders

Methods inherited from class IntegrationComponentSpec

_this, afterPropertiesSet, destroy, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class Object

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

Methods inherited from interface FactoryBean

isSingleton

Methods inherited from interface SmartLifecycle

isPauseable

Constructor Details

ImapMailInboundChannelAdapterSpec

protected ImapMailInboundChannelAdapterSpec()

ImapMailInboundChannelAdapterSpec

protected ImapMailInboundChannelAdapterSpec(ImapMailReceiver imapMailReceiver)

ImapMailInboundChannelAdapterSpec

protected ImapMailInboundChannelAdapterSpec(String url)

Method Details

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)