Class Pop3MailReceiver

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.mail.inbound.AbstractMailReceiver

org.springframework.integration.mail.inbound.Pop3MailReceiver

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ComponentSourceAware, ExpressionCapable, MailReceiver, NamedComponent

Direct Known Subclasses:

Pop3MailReceiver

public class Pop3MailReceiver
extends AbstractMailReceiver

A MailReceiver implementation that polls a mail server using the POP3 protocol.

Since:

7.0

Author:

Arjen Poutsma, Mark Fisher, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTOCOL

Fields inherited from class org.springframework.integration.mail.inbound.AbstractMailReceiver

DEFAULT_SI_USER_FLAG

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
Pop3MailReceiver()
Pop3MailReceiver(@Nullable String url)
Pop3MailReceiver(String host, int port, String username, String password)
Pop3MailReceiver(String host, String username, String password)

Method Summary

Modifier and Type	Method	Description
protected void	deleteMessages(Message[] messages)	Delete the given messages from this receiver's folder, and closes it to expunge deleted messages.
protected Message[]	searchForNewMessages()	Subclasses must implement this method to return new mail messages.

Methods inherited from class org.springframework.integration.mail.inbound.AbstractMailReceiver

closeFolder, destroy, fetchMessages, getComponentType, getFolder, getFolderOpenMode, getJavaMailProperties, getUserFlag, onInit, openFolder, receive, setAdditionalFlags, setAutoCloseFolder, setEmbeddedPartsAsBytes, setFlaggedAsFallback, setHeaderMapper, setJavaMailAuthenticator, setJavaMailProperties, setMaxFetchSize, setProtocol, setSelectorExpression, setSession, setShouldDeleteMessages, setSimpleContent, setUserFlag, shouldDeleteMessages, toString

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

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

Methods inherited from class java.lang.Object

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

Field Details

PROTOCOL

public static final String PROTOCOL

See Also:

• Constant Field Values

Constructor Details

Pop3MailReceiver

public Pop3MailReceiver()

Pop3MailReceiver

public Pop3MailReceiver(@Nullable String url)

Pop3MailReceiver

public Pop3MailReceiver(String host,
 String username,
 String password)

Pop3MailReceiver

public Pop3MailReceiver(String host,
 int port,
 String username,
 String password)

Method Details

searchForNewMessages

protected Message[] searchForNewMessages()
                                  throws MessagingException

Description copied from class: AbstractMailReceiver

Subclasses must implement this method to return new mail messages.

Specified by:

searchForNewMessages in class AbstractMailReceiver

Returns:

An array of messages.

Throws:

MessagingException - Any MessagingException.

deleteMessages

protected void deleteMessages(Message[] messages)
                       throws MessagingException

Delete the given messages from this receiver's folder, and closes it to expunge deleted messages.

Overrides:

deleteMessages in class AbstractMailReceiver

Parameters:

messages - the messages to delete

Throws:

MessagingException - in case of JavaMail errors