Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractMailMessageTransformer<T> - Class in org.springframework.integration.mail.transformer
-
Base class for Transformers that convert from a JavaMail Message to a Spring Integration Message.
- AbstractMailMessageTransformer() - Constructor for class org.springframework.integration.mail.transformer.AbstractMailMessageTransformer
- AbstractMailReceiver - Class in org.springframework.integration.mail
-
Base class for
MailReceiver
implementations. - AbstractMailReceiver() - Constructor for class org.springframework.integration.mail.AbstractMailReceiver
- AbstractMailReceiver(URLName) - Constructor for class org.springframework.integration.mail.AbstractMailReceiver
- AbstractMailReceiver(String) - Constructor for class org.springframework.integration.mail.AbstractMailReceiver
- adviceChain(Advice...) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure a chain of
Advice
objects for message delivery, applied to the downstream flow. - assertReceiver() - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- ATTACHMENT_FILENAME - Static variable in class org.springframework.integration.mail.MailHeaders
- attachmentFilename(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a filename for the attachment.
- attachmentFilenameExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set an expression that will be evaluated to determine the filename for the attachment.
- attachmentFilenameFunction(Function<Message<P>, String>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the filename for the attachment.
- autoCloseFolder(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
When configured to
false
, the folder is not closed automatically after a fetch. - autoCloseFolder(boolean) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
When configured to
false
, the folder is not closed automatically after a fetch.
B
- bcc(String...) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the bcc: addresses.
- BCC - Static variable in class org.springframework.integration.mail.MailHeaders
- bccExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine the bcc: addresses.
- bccFunction(Function<Message<P>, String[]>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the bcc: addresses based on the message.
C
- cancelIdleInterval(long) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
How often to recycle the idle task (in case of a silently dropped connection).
- cancelPing() - Method in class org.springframework.integration.mail.ImapMailReceiver
-
The hook to be called when we need to cancel the current ping task and close the mail folder.
- cc(String...) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the cc: addresses.
- CC - Static variable in class org.springframework.integration.mail.MailHeaders
- ccExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine the cc: addresses.
- ccFunction(Function<Message<P>, String[]>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the cc: addresses based on the message.
- closeFolder() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- closeFolder(Folder, boolean) - Static method in class org.springframework.integration.mail.MailTransportUtils
-
Close the given JavaMail Folder and ignore any thrown exception.
- closeService(Service) - Static method in class org.springframework.integration.mail.MailTransportUtils
-
Close the given JavaMail Service and ignore any thrown exception.
- componentsToRegister - Variable in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- CONTENT_TYPE - Static variable in class org.springframework.integration.mail.MailHeaders
- contentType(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the content type.
- contentTypeExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set an expression that will be evaluated to determine the content type.
- contentTypeFunction(Function<Message<P>, String>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the content type.
- createInstance() - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- credentials(String, String) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the credentials.
D
- DEFAULT_SI_USER_FLAG - Static variable in class org.springframework.integration.mail.AbstractMailReceiver
-
Default user flag for marking messages as seen by this receiver: "spring-integration-mail-adapter".
- defaultEncoding(String) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the default encoding.
- defaultFileTypeMap(FileTypeMap) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the default type map.
- DefaultMailHeaderMapper - Class in org.springframework.integration.mail.support
-
Maps an inbound
MimeMessage
to aMap
. - DefaultMailHeaderMapper() - Constructor for class org.springframework.integration.mail.support.DefaultMailHeaderMapper
- deleteMessages(Message[]) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Deletes the given messages from this receiver's folder.
- deleteMessages(Message[]) - Method in class org.springframework.integration.mail.Pop3MailReceiver
-
Deletes the given messages from this receiver's folder, and closes it to expunge deleted messages.
- destroy() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- destroy() - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- destroy() - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- destroy() - Method in class org.springframework.integration.mail.ImapMailReceiver
- doGet() - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- doParse(Element, ParserContext, String) - Method in class org.springframework.integration.mail.config.ImapIdleChannelAdapterParser
- doReceive() - Method in class org.springframework.integration.mail.MailReceivingMessageSource
- doStart() - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- doStop() - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- doTransform(Message) - Method in class org.springframework.integration.mail.transformer.AbstractMailMessageTransformer
- doTransform(Message) - Method in class org.springframework.integration.mail.transformer.MailToStringTransformer
E
- embeddedPartsAsBytes(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
When a header mapper is provided determine whether an embedded
Part
(e.gMessage
orMultipart
content is rendered as a byte[] in the payload. - embeddedPartsAsBytes(boolean) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
When a header mapper is provided determine whether an embedded
Part
(e.gMessage
orMultipart
content is rendered as a byte[] in the payload. - EXPUNGED - Static variable in class org.springframework.integration.mail.MailHeaders
- externalReceiver - Variable in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- externalReceiver - Variable in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- extractStandardHeaders(Message) - Static method in class org.springframework.integration.mail.support.MailUtils
-
Map the message headers to a Map using
MailHeaders
keys; specifically maps the address headers and the subject.
F
- fetchMessages(Message[]) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Fetches the specified messages from this receiver's folder.
- FLAGS - Static variable in class org.springframework.integration.mail.MailHeaders
- from(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the From: address.
- FROM - Static variable in class org.springframework.integration.mail.MailHeaders
- fromExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine the
From:
address. - fromFunction(Function<Message<P>, String>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the
From:
address based on the message. - fromHeaders(MessageHeaders, MimeMessage) - Method in class org.springframework.integration.mail.support.DefaultMailHeaderMapper
G
- generateSearchTerm(Flags, Folder) - Method in interface org.springframework.integration.mail.SearchTermStrategy
-
Will generate an instance of the
SearchTerm
. - getComponentsToRegister() - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- getComponentsToRegister() - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- getComponentType() - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- getComponentType() - Method in class org.springframework.integration.mail.MailReceivingMessageSource
- getComponentType() - Method in class org.springframework.integration.mail.MailSendingMessageHandler
- getFolder() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- getFolderOpenMode() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- getJavaMailProperties() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- getMessageBuilderFactory() - Method in class org.springframework.integration.mail.transformer.AbstractMailMessageTransformer
- getObjectType() - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- getTransformerClassName() - Method in class org.springframework.integration.mail.config.MailToStringTransformerParser
- getUserFlag() - Method in class org.springframework.integration.mail.AbstractMailReceiver
H
- handleMessageInternal(Message<?>) - Method in class org.springframework.integration.mail.MailSendingMessageHandler
- headerMapper(HeaderMapper<MimeMessage>) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
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 theMimeMessage
content. - headerMapper(HeaderMapper<MimeMessage>) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
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 theMimeMessage
content. - headers() - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
MailHeadersBuilder
factory.
I
- imapIdleAdapter() - Static method in class org.springframework.integration.mail.dsl.Mail
-
An
ImapIdleChannelAdapterSpec
factory using a defaultImapMailReceiver
. - imapIdleAdapter(String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
ImapIdleChannelAdapterSpec
factory based on the provided url. - imapIdleAdapter(ImapMailReceiver) - Static method in class org.springframework.integration.mail.dsl.Mail
-
An
ImapIdleChannelAdapterSpec
factory based on the providedImapMailReceiver
. - ImapIdleChannelAdapter - Class in org.springframework.integration.mail
-
An event-driven Channel Adapter that receives mail messages from a mail server that supports the IMAP "idle" command (see RFC 2177).
- ImapIdleChannelAdapter(ImapMailReceiver) - Constructor for class org.springframework.integration.mail.ImapIdleChannelAdapter
- ImapIdleChannelAdapter.ImapIdleExceptionEvent - Class in org.springframework.integration.mail
- ImapIdleChannelAdapterParser - Class in org.springframework.integration.mail.config
-
Parser for the <imap-idle-channel-adapter> element in the 'mail' namespace.
- ImapIdleChannelAdapterParser() - Constructor for class org.springframework.integration.mail.config.ImapIdleChannelAdapterParser
- ImapIdleChannelAdapterSpec - Class in org.springframework.integration.mail.dsl
-
A
MessageProducerSpec
for aImapIdleChannelAdapter
. - ImapIdleChannelAdapterSpec(ImapMailReceiver) - Constructor for class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- ImapIdleChannelAdapterSpec(ImapMailReceiver, boolean) - Constructor for class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- imapInboundAdapter() - Static method in class org.springframework.integration.mail.dsl.Mail
-
An
ImapMailInboundChannelAdapterSpec
factory using a defaultImapMailReceiver
. - imapInboundAdapter(String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
ImapMailInboundChannelAdapterSpec
factory based on the provided url. - imapInboundAdapter(ImapMailReceiver) - Static method in class org.springframework.integration.mail.dsl.Mail
-
An
ImapMailInboundChannelAdapterSpec
factory based on the providedImapMailReceiver
. - ImapMailInboundChannelAdapterSpec - Class in org.springframework.integration.mail.dsl
-
A
MailInboundChannelAdapterSpec
for IMAP. - ImapMailInboundChannelAdapterSpec() - Constructor for class org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec
- ImapMailInboundChannelAdapterSpec(String) - Constructor for class org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec
- ImapMailInboundChannelAdapterSpec(ImapMailReceiver) - Constructor for class org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec
- ImapMailReceiver - Class in org.springframework.integration.mail
-
A
MailReceiver
implementation for receiving mail messages from a mail server that supports the IMAP protocol. - ImapMailReceiver() - Constructor for class org.springframework.integration.mail.ImapMailReceiver
- ImapMailReceiver(String) - Constructor for class org.springframework.integration.mail.ImapMailReceiver
- init() - Method in class org.springframework.integration.mail.config.MailNamespaceHandler
- isShouldMarkMessagesAsRead() - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- isShouldMarkMessagesAsRead() - Method in class org.springframework.integration.mail.ImapMailReceiver
-
Check if messages should be marked as read.
J
- javaMailAuthenticator(Authenticator) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- javaMailAuthenticator(Authenticator) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
The Java Mail
Authenticator
. - javaMailProperties(Consumer<PropertiesBuilder>) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure the
javaMailProperties
by invoking aConsumer
callback which is invoked with aPropertiesBuilder
. - javaMailProperties(Consumer<PropertiesBuilder>) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Configure the
javaMailProperties
by invoking aConsumer
callback which is invoked with aPropertiesBuilder
. - javaMailProperties(Consumer<PropertiesBuilder>) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set a
Consumer
that will be invoked with aPropertiesBuilder
; most often used with a lambda expression. - javaMailProperties(Properties) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- javaMailProperties(Properties) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
The Java Mail properties.
- javaMailProperties(Properties) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the javamail properties.
L
- LINE_COUNT - Static variable in class org.springframework.integration.mail.MailHeaders
M
- Mail - Class in org.springframework.integration.mail.dsl
-
The factory for Spring Integration Mail components.
- MailHeaderEnricherParser - Class in org.springframework.integration.mail.config
- MailHeaderEnricherParser() - Constructor for class org.springframework.integration.mail.config.MailHeaderEnricherParser
- MailHeaders - Class in org.springframework.integration.mail
-
Pre-defined header names to be used for setting and/or retrieving Mail Message attributes from/to integration Message Headers.
- MailHeadersBuilder - Class in org.springframework.integration.mail.dsl
-
The Mail specific
MapBuilder
implementation. - MailInboundChannelAdapterParser - Class in org.springframework.integration.mail.config
-
Parser for the <inbound-channel-adapter> element of Spring Integration's 'mail' namespace.
- MailInboundChannelAdapterParser() - Constructor for class org.springframework.integration.mail.config.MailInboundChannelAdapterParser
- MailInboundChannelAdapterSpec<S extends MailInboundChannelAdapterSpec<S,
R>, R extends AbstractMailReceiver> - Class in org.springframework.integration.mail.dsl -
A
MessageSourceSpec
for aMailReceivingMessageSource
. - MailInboundChannelAdapterSpec(R) - Constructor for class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- MailInboundChannelAdapterSpec(R, boolean) - Constructor for class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- MailIntegrationEvent - Class in org.springframework.integration.mail.event
- MailIntegrationEvent(Object) - Constructor for class org.springframework.integration.mail.event.MailIntegrationEvent
- MailIntegrationEvent(Object, Throwable) - Constructor for class org.springframework.integration.mail.event.MailIntegrationEvent
- MailNamespaceHandler - Class in org.springframework.integration.mail.config
-
Namespace handler for the 'mail' namespace.
- MailNamespaceHandler() - Constructor for class org.springframework.integration.mail.config.MailNamespaceHandler
- MailOutboundChannelAdapterParser - Class in org.springframework.integration.mail.config
-
Parser for the <outbound-channel-adapter/> element of the 'mail' namespace.
- MailOutboundChannelAdapterParser() - Constructor for class org.springframework.integration.mail.config.MailOutboundChannelAdapterParser
- MailReceiver - Interface in org.springframework.integration.mail
-
Strategy interface for receiving mail
Messages
. - MailReceiverFactoryBean - Class in org.springframework.integration.mail.config
- MailReceiverFactoryBean() - Constructor for class org.springframework.integration.mail.config.MailReceiverFactoryBean
- MailReceivingMessageSource - Class in org.springframework.integration.mail
-
MessageSource
implementation that delegates to aMailReceiver
to poll a mailbox. - MailReceivingMessageSource(MailReceiver) - Constructor for class org.springframework.integration.mail.MailReceivingMessageSource
- MailSendingMessageHandler - Class in org.springframework.integration.mail
-
A
MessageHandler
implementation for sending mail. - MailSendingMessageHandler(MailSender) - Constructor for class org.springframework.integration.mail.MailSendingMessageHandler
-
Create a MailSendingMessageHandler.
- MailSendingMessageHandlerSpec - Class in org.springframework.integration.mail.dsl
- MailSendingMessageHandlerSpec(String) - Constructor for class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
- MailToStringTransformer - Class in org.springframework.integration.mail.transformer
-
Transforms a Message payload of type
Message
to a String. - MailToStringTransformer() - Constructor for class org.springframework.integration.mail.transformer.MailToStringTransformer
- MailToStringTransformerParser - Class in org.springframework.integration.mail.config
-
Parser for the <mail-to-string-transformer> element.
- MailToStringTransformerParser() - Constructor for class org.springframework.integration.mail.config.MailToStringTransformerParser
- MailTransportUtils - Class in org.springframework.integration.mail
-
Collection of utility methods to work with Mail transports.
- MailTransportUtils() - Constructor for class org.springframework.integration.mail.MailTransportUtils
- MailUtils - Class in org.springframework.integration.mail.support
-
Utilities for handling mail messages.
- maxFetchSize(int) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- maxFetchSize(int) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
The maximum for fetch size.
- MULTIPART_MODE - Static variable in class org.springframework.integration.mail.MailHeaders
- multipartMode(int) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a multipart mode to use.
- multipartModeExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set an expression that is evaluated to determine a multipart mode to use.
- multipartModeFunction(Function<Message<P>, Integer>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that is invoked to determine a multipart mode to use.
O
- onInit() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- onInit() - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- onInit() - Method in class org.springframework.integration.mail.ImapMailReceiver
- openFolder() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- org.springframework.integration.mail - package org.springframework.integration.mail
-
Base package for Mail support.
- org.springframework.integration.mail.config - package org.springframework.integration.mail.config
-
Provides classes for configuration - parsers, namespace handlers.
- org.springframework.integration.mail.dsl - package org.springframework.integration.mail.dsl
-
Provides Mail Components for the Java DSL.
- org.springframework.integration.mail.event - package org.springframework.integration.mail.event
-
Events generated by the mail module
- org.springframework.integration.mail.support - package org.springframework.integration.mail.support
-
Provides classes to support email.
- org.springframework.integration.mail.transformer - package org.springframework.integration.mail.transformer
-
Provides classes related to transforming mail messages.
- outboundAdapter() - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
MailSendingMessageHandlerSpec
factory. - outboundAdapter(String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
MailSendingMessageHandlerSpec
factory based on providehost
. - outboundAdapter(MailSender) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A convenient factory method to produce
MailSendingMessageHandler
based on providedMailSender
.
P
- parseConsumer(Element, ParserContext) - Method in class org.springframework.integration.mail.config.MailOutboundChannelAdapterParser
- parseSource(Element, ParserContext) - Method in class org.springframework.integration.mail.config.MailInboundChannelAdapterParser
- parseTransformer(Element, ParserContext, BeanDefinitionBuilder) - Method in class org.springframework.integration.mail.config.MailToStringTransformerParser
- password(String) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the mail user password.
- pop3InboundAdapter() - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
Pop3MailInboundChannelAdapterSpec
factory using a defaultPop3MailReceiver
. - pop3InboundAdapter(String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
Pop3MailInboundChannelAdapterSpec
factory based on the provided url. - pop3InboundAdapter(String, int, String, String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
Pop3MailInboundChannelAdapterSpec
factory based on the provided host, port, user, and password. - pop3InboundAdapter(String, String, String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
Pop3MailInboundChannelAdapterSpec
factory based on the provided host, user, password and the default port. - pop3InboundAdapter(Pop3MailReceiver) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
Pop3MailInboundChannelAdapterSpec
factory based on the providedPop3MailReceiver
. - Pop3MailInboundChannelAdapterSpec - Class in org.springframework.integration.mail.dsl
-
A
MailInboundChannelAdapterSpec
for POP3. - Pop3MailInboundChannelAdapterSpec() - Constructor for class org.springframework.integration.mail.dsl.Pop3MailInboundChannelAdapterSpec
- Pop3MailInboundChannelAdapterSpec(String) - Constructor for class org.springframework.integration.mail.dsl.Pop3MailInboundChannelAdapterSpec
- Pop3MailInboundChannelAdapterSpec(String, int, String, String) - Constructor for class org.springframework.integration.mail.dsl.Pop3MailInboundChannelAdapterSpec
- Pop3MailInboundChannelAdapterSpec(String, String, String) - Constructor for class org.springframework.integration.mail.dsl.Pop3MailInboundChannelAdapterSpec
- Pop3MailInboundChannelAdapterSpec(Pop3MailReceiver) - Constructor for class org.springframework.integration.mail.dsl.Pop3MailInboundChannelAdapterSpec
- Pop3MailReceiver - Class in org.springframework.integration.mail
-
A
MailReceiver
implementation that polls a mail server using the POP3 protocol. - Pop3MailReceiver() - Constructor for class org.springframework.integration.mail.Pop3MailReceiver
- Pop3MailReceiver(String) - Constructor for class org.springframework.integration.mail.Pop3MailReceiver
- Pop3MailReceiver(String, int, String, String) - Constructor for class org.springframework.integration.mail.Pop3MailReceiver
- Pop3MailReceiver(String, String, String) - Constructor for class org.springframework.integration.mail.Pop3MailReceiver
- port(int) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the port.
- PREFIX - Static variable in class org.springframework.integration.mail.MailHeaders
- protocol(String) - Method in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
-
Set the protocol.
- PROTOCOL - Static variable in class org.springframework.integration.mail.Pop3MailReceiver
R
- RAW_HEADERS - Static variable in class org.springframework.integration.mail.MailHeaders
- receive() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- receive() - Method in interface org.springframework.integration.mail.MailReceiver
- RECEIVED_DATE - Static variable in class org.springframework.integration.mail.MailHeaders
- receiver - Variable in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- receiver - Variable in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
- reconnectDelay(long) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
The time between connection attempts in milliseconds (default 10 seconds).
- REPLY_TO - Static variable in class org.springframework.integration.mail.MailHeaders
- replyTo(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the ReplyTo: address.
- replyToExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine the ReplyTo: address.
- replyToFunction(Function<Message<P>, String>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the ReplyTo: address based on the message.
S
- searchForNewMessages() - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Subclasses must implement this method to return new mail messages.
- searchForNewMessages() - Method in class org.springframework.integration.mail.ImapMailReceiver
-
Retrieves new messages from this receiver's folder.
- searchForNewMessages() - Method in class org.springframework.integration.mail.Pop3MailReceiver
- searchTermStrategy(SearchTermStrategy) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- searchTermStrategy(SearchTermStrategy) - Method in class org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec
-
A
SearchTermStrategy
to use. - SearchTermStrategy - Interface in org.springframework.integration.mail
-
Strategy to be used to generate a
SearchTerm
. - selector(Function<MimeMessage, Boolean>) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure a
Function
to select messages. - selector(Function<MimeMessage, Boolean>) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Configure a
Function
to select messages. - selectorExpression(String) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure a SpEL expression to select messages.
- selectorExpression(String) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Configure a SpEL expression to select messages.
- selectorExpression(Expression) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure an
Expression
to select messages. - selectorExpression(Expression) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Configure a SpEL expression to select messages.
- sender - Variable in class org.springframework.integration.mail.dsl.MailSendingMessageHandlerSpec
- session(Session) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
A Java Mail
Session
to use. - session(Session) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Provide the Java Mail
Session
to use. - setAdditionalFlags(Message) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Optional method allowing you to set additional flags.
- setAdditionalFlags(Message) - Method in class org.springframework.integration.mail.ImapMailReceiver
- setAdviceChain(List<Advice>) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- setAuthenticator(Authenticator) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setAutoCloseFolder(boolean) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Configure a
boolean
flag to close the folder automatically after a fetch (default) or populate an additionalIntegrationMessageHeaderAccessor.CLOSEABLE_RESOURCE
message header instead. - setAutoCloseFolder(Boolean) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setBeanClassLoader(ClassLoader) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- setBeanFactory(BeanFactory) - Method in class org.springframework.integration.mail.transformer.AbstractMailMessageTransformer
- setCancelIdleInterval(long) - Method in class org.springframework.integration.mail.ImapMailReceiver
-
IDLE commands will be terminated after this interval; useful in cases where a connection might be silently dropped.
- setCharset(String) - Method in class org.springframework.integration.mail.transformer.MailToStringTransformer
-
Specify the name of the Charset to use when converting from bytes.
- setEmbeddedPartsAsBytes(boolean) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
When a header mapper is provided determine whether an embedded
Part
(e.gMessage
orMultipart
content is rendered as a byte[] in the payload. - setEmbeddedPartsAsBytes(Boolean) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setHeaderMapper(HeaderMapper<MimeMessage>) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
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 theMimeMessage
content. - setHeaderMapper(HeaderMapper<MimeMessage>) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setJavaMailAuthenticator(Authenticator) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Optional, sets the Authenticator to be used to obtain a session.
- setJavaMailProperties(Properties) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
A new
Session
will be created with these properties (and the JavaMailAuthenticator if provided). - setJavaMailProperties(Properties) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setMaxFetchSize(int) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Specify the maximum number of Messages to fetch per call to
AbstractMailReceiver.receive()
. - setMaxFetchSize(int) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setProtocol(String) - Method in class org.springframework.integration.mail.AbstractMailReceiver
- setProtocol(String) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setReconnectDelay(long) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
-
The time between connection attempts in milliseconds (default 10 seconds).
- setSearchTermStrategy(SearchTermStrategy) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setSearchTermStrategy(SearchTermStrategy) - Method in class org.springframework.integration.mail.ImapMailReceiver
-
Provides a way to set custom
SearchTermStrategy
to compile aSearchTerm
to be applied when retrieving mail. - setSelectorExpression(Expression) - Method in class org.springframework.integration.mail.AbstractMailReceiver
- setSelectorExpression(Expression) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setSession(Session) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Set the
Session
. - setSession(Session) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setShouldDeleteMessages(boolean) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Specify whether mail messages should be deleted after retrieval.
- setShouldDeleteMessages(Boolean) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setShouldMarkMessagesAsRead(Boolean) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setShouldMarkMessagesAsRead(Boolean) - Method in class org.springframework.integration.mail.ImapMailReceiver
-
Specify if messages should be marked as read.
- setShouldReconnectAutomatically(boolean) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
-
Specify whether the IDLE task should reconnect automatically after catching a
MessagingException
while waiting for messages. - setSimpleContent(boolean) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
MimeMessage.getContent()
returns just the email body. - setSimpleContent(Boolean) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setStoreUri(String) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- setTransactionSynchronizationFactory(TransactionSynchronizationFactory) - Method in class org.springframework.integration.mail.ImapIdleChannelAdapter
- setUserFlag(String) - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
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".
- setUserFlag(String) - Method in class org.springframework.integration.mail.config.MailReceiverFactoryBean
- shouldDeleteMessages() - Method in class org.springframework.integration.mail.AbstractMailReceiver
-
Indicates whether the mail messages should be deleted after being received.
- shouldDeleteMessages(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- shouldDeleteMessages(boolean) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
A flag to specify if messages should be deleted after receive.
- shouldMarkMessagesAsRead(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- shouldMarkMessagesAsRead(boolean) - Method in class org.springframework.integration.mail.dsl.ImapMailInboundChannelAdapterSpec
-
A flag to determine if message should be marked as read.
- shouldReconnectAutomatically(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
- simpleContent(boolean) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Determine how the content is rendered.
- simpleContent(boolean) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
Determine how the content is rendered.
- SIZE - Static variable in class org.springframework.integration.mail.MailHeaders
- subject(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the subject.
- SUBJECT - Static variable in class org.springframework.integration.mail.MailHeaders
- subjectExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine th subject.
- subjectFunction(Function<Message<P>, String>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to return the subject based on the message.
T
- to(String...) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the To: addresses.
- TO - Static variable in class org.springframework.integration.mail.MailHeaders
- toExpression(String) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set the expression that will be evaluated to determine the To: addresses.
- toFunction(Function<Message<P>, String[]>) - Method in class org.springframework.integration.mail.dsl.MailHeadersBuilder
-
Set a function that will be invoked to determine the To: addresses based on the message.
- toHeaders(MimeMessage) - Method in class org.springframework.integration.mail.support.DefaultMailHeaderMapper
- toPasswordProtectedString(URLName) - Static method in class org.springframework.integration.mail.MailTransportUtils
-
Returns a string representation of the given
URLName
, where the password has been protected. - toString() - Method in class org.springframework.integration.mail.AbstractMailReceiver
- toStringTransformer() - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
MailToStringTransformer
factory. - toStringTransformer(String) - Static method in class org.springframework.integration.mail.dsl.Mail
-
A
MailToStringTransformer
factory. - transactional() - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Specify a
TransactionInterceptor
Advice
with defaultPlatformTransactionManager
andDefaultTransactionAttribute
for the downstream flow. - transactional(TransactionInterceptor) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Specify a
TransactionInterceptor
Advice
for the downstream flow. - transactional(TransactionManager) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Specify a
TransactionInterceptor
Advice
with the providedTransactionManager
and defaultDefaultTransactionAttribute
for the downstream flow. - transactionSynchronizationFactory(TransactionSynchronizationFactory) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
Configure a
TransactionSynchronizationFactory
. - transform(Message<?>) - Method in class org.springframework.integration.mail.transformer.AbstractMailMessageTransformer
U
- userFlag(String) - Method in class org.springframework.integration.mail.dsl.ImapIdleChannelAdapterSpec
-
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".
- userFlag(String) - Method in class org.springframework.integration.mail.dsl.MailInboundChannelAdapterSpec
-
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".
W
- waitForNewMessages() - Method in class org.springframework.integration.mail.ImapMailReceiver
-
This method is unique to the IMAP receiver and only works if IMAP IDLE is supported (see RFC 2177 for more detail).
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form