org.springframework.integration.mail

Class AbstractMailReceiver

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.mail.AbstractMailReceiver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, MailReceiver, NamedComponent

Direct Known Subclasses:

ImapMailReceiver, Pop3MailReceiver

public abstract class AbstractMailReceiver
extends IntegrationObjectSupport
implements MailReceiver, org.springframework.beans.factory.DisposableBean

Base class for MailReceiver implementations.

Author:

Arjen Poutsma, Jonas Partner, Mark Fisher, Iwein Fuld, Oleg Zhurakousky, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.mail.MailReceiver

MailReceiver.MailReceiverContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SI_USER_FLAG
protected int	folderOpenMode
protected boolean	initialized
protected org.apache.commons.logging.Log	logger
static java.lang.String	SI_USER_FLAG Deprecated. - this constant will be removed in 4.3; see setUserFlag(String) and DEFAULT_SI_USER_FLAG

Constructor Summary

Constructors

Constructor and Description
AbstractMailReceiver()
AbstractMailReceiver(java.lang.String url)
AbstractMailReceiver(javax.mail.URLName urlName)

Method Summary

Modifier and Type	Method and Description
protected void	deleteMessages(javax.mail.Message[] messages) Deletes the given messages from this receiver's folder.
void	destroy()
protected void	fetchMessages(javax.mail.Message[] messages) Fetches the specified messages from this receiver's folder.
protected javax.mail.Folder	getFolder()
protected java.util.Properties	getJavaMailProperties()
protected java.lang.String	getUserFlag()
protected void	onInit() Subclasses may implement this for initialization logic.
protected void	openFolder()
javax.mail.Message[]	receive()
protected abstract javax.mail.Message[]	searchForNewMessages() Subclasses must implement this method to return new mail messages.
protected void	setAdditionalFlags(javax.mail.Message message) Optional method allowing you to set additional flags.
void	setJavaMailAuthenticator(javax.mail.Authenticator javaMailAuthenticator) Optional, sets the Authenticator to be used to obtain a session.
void	setJavaMailProperties(java.util.Properties javaMailProperties) A new Session will be created with these properties (and the JavaMailAuthenticator if provided).
void	setMaxFetchSize(int maxFetchSize) Specify the maximum number of Messages to fetch per call to receive().
void	setProtocol(java.lang.String protocol)
void	setSelectorExpression(org.springframework.expression.Expression selectorExpression)
void	setSession(javax.mail.Session session) Set the Session.
void	setShouldDeleteMessages(boolean shouldDeleteMessages) Specify whether mail messages should be deleted after retrieval.
void	setUserFlag(java.lang.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".
protected boolean	shouldDeleteMessages() Indicates whether the mail messages should be deleted after being received.
java.lang.String	toString()

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getComponentType, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SI_USER_FLAG

public static final java.lang.String DEFAULT_SI_USER_FLAG

See Also:

Constant Field Values

SI_USER_FLAG

@Deprecated
public static final java.lang.String SI_USER_FLAG

Deprecated. - this constant will be removed in 4.3; see setUserFlag(String) and DEFAULT_SI_USER_FLAG

Default user flag for marking messages as seen by this receiver: "spring-integration-mail-adapter".

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

folderOpenMode

protected volatile int folderOpenMode

initialized

protected volatile boolean initialized

Constructor Detail

AbstractMailReceiver

public AbstractMailReceiver()

AbstractMailReceiver

public AbstractMailReceiver(javax.mail.URLName urlName)

AbstractMailReceiver

public AbstractMailReceiver(java.lang.String url)

Method Detail

setSelectorExpression

public void setSelectorExpression(org.springframework.expression.Expression selectorExpression)

setProtocol

public void setProtocol(java.lang.String protocol)

setSession

public void setSession(javax.mail.Session session)

Set the Session. Otherwise, the Session will be created by invocation of Session.getInstance(Properties) or Session.getInstance(Properties, Authenticator).

Parameters:

session - The session.

See Also:

setJavaMailProperties(Properties), setJavaMailAuthenticator(Authenticator)

setJavaMailProperties

public void setJavaMailProperties(java.util.Properties javaMailProperties)

A new Session will be created with these properties (and the JavaMailAuthenticator if provided). Use either this method or setSession(javax.mail.Session), but not both.

Parameters:

javaMailProperties - The javamail properties.

See Also:

setJavaMailAuthenticator(Authenticator), setSession(Session)

getJavaMailProperties

protected java.util.Properties getJavaMailProperties()

setJavaMailAuthenticator

public void setJavaMailAuthenticator(javax.mail.Authenticator javaMailAuthenticator)

Optional, sets the Authenticator to be used to obtain a session. This will not be used if setSession(javax.mail.Session) has been used to configure the Session directly.

Parameters:

javaMailAuthenticator - The javamail authenticator.

See Also:

setSession(Session)

setMaxFetchSize

public void setMaxFetchSize(int maxFetchSize)

Specify the maximum number of Messages to fetch per call to receive().

Parameters:

maxFetchSize - The max fetch size.

setShouldDeleteMessages

public void setShouldDeleteMessages(boolean shouldDeleteMessages)

Specify whether mail messages should be deleted after retrieval.

Parameters:

shouldDeleteMessages - true to delete messages.

shouldDeleteMessages

protected boolean shouldDeleteMessages()

Indicates whether the mail messages should be deleted after being received.

Returns:

true when messages will be deleted.

getUserFlag

protected java.lang.String getUserFlag()

setUserFlag

public void setUserFlag(java.lang.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.

Since:

4.2.2

getFolder

protected javax.mail.Folder getFolder()

searchForNewMessages

protected abstract javax.mail.Message[] searchForNewMessages()
                                                      throws javax.mail.MessagingException

Subclasses must implement this method to return new mail messages.

Returns:

An array of messages.

Throws:

javax.mail.MessagingException - Any MessagingException.

openFolder

protected void openFolder()
                   throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

receive

public javax.mail.Message[] receive()
                             throws javax.mail.MessagingException

Specified by:

receive in interface MailReceiver

Throws:

javax.mail.MessagingException

fetchMessages

protected void fetchMessages(javax.mail.Message[] messages)
                      throws javax.mail.MessagingException

Fetches the specified messages from this receiver's folder. Default implementation fetches every FetchProfile.Item.

Parameters:

messages - the messages to fetch

Throws:

javax.mail.MessagingException - in case of JavaMail errors

deleteMessages

protected void deleteMessages(javax.mail.Message[] messages)
                       throws javax.mail.MessagingException

Deletes the given messages from this receiver's folder.

Parameters:

messages - the messages to delete

Throws:

javax.mail.MessagingException - in case of JavaMail errors

setAdditionalFlags

protected void setAdditionalFlags(javax.mail.Message message)
                           throws javax.mail.MessagingException

Optional method allowing you to set additional flags. Currently only implemented in IMapMailReceiver.

Parameters:

message - The message.

Throws:

javax.mail.MessagingException - A MessagingException.

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

java.lang.Exception

onInit

protected void onInit()
               throws java.lang.Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

Throws:

java.lang.Exception - Any exception.

toString

public java.lang.String toString()

Overrides:

toString in class IntegrationObjectSupport