INT-4299: Add AbstractMailReceiver.autoCloseFolder #2887
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JIRA: https://jira.spring.io/browse/INT-4299 * Optimize `AbstractMessageSource` do not evaluate headers when polling result is `null` * Optimize `MailReceivingMessageSource` do not wrap polling result to the message: the `AbstractMessageSource` will do that later
|
If this is OK, I'll add some docs on the matter. Thanks |
garyrussell
suggested changes
Apr 9, 2019
| /** | ||
| * Configure a {@code boolean} flag to close the folder automatically after fetch (default) or | ||
| * populate additional {@link IntegrationMessageHeaderAccessor#CLOSEABLE_RESOURCE} message header instead. | ||
| * It is downstream flow responsibility to obtain this header and call its {@code close()} whenever |
There was a problem hiding this comment.
after a fetch
populate an additional
is the downstream flow's responsibility
| * server when parsing maltipart content of the email with attachments. | ||
| * <p> The {@link #setSimpleContent(boolean)} and {@link #setHeaderMapper(HeaderMapper)} options are not | ||
| * affected by this flag. | ||
| * @param autoCloseFolder {@code false} do not close the folder automatically after fetch. |
There was a problem hiding this comment.
Keeping the folder open is useful in cases where communication with the server is needed when parsing multipart (typo)
| @@ -269,6 +269,21 @@ public ImapIdleChannelAdapterSpec embeddedPartsAsBytes(boolean embeddedPartsAsBy | |||
| return _this(); | |||
| } | |||
|
|
|||
| /** | |||
| * When configured to {@code false}, the folder is not closed automatically after fetch. | |||
| * It is target application responsibility to close it used | |||
There was a problem hiding this comment.
the target application's
| @@ -253,6 +253,22 @@ public S simpleContent(boolean simpleContent) { | |||
| return _this(); | |||
| } | |||
|
|
|||
| /** | |||
| * When configured to {@code false}, the folder is not closed automatically after fetch. | |||
| * It is target application responsibility to close it used | |||
* Document `autoCloseFolder` option
garyrussell
reviewed
Apr 9, 2019
| @@ -357,7 +378,9 @@ private Folder obtainFolderInstance() throws MessagingException { | |||
| return convertMessagesIfNecessary(searchAndFilterMessages()); | |||
| } | |||
| finally { | |||
| MailTransportUtils.closeFolder(this.folder, this.shouldDeleteMessages); | |||
| if (this.autoCloseFolder) { | |||
| closeFolder(); | |||
There was a problem hiding this comment.
Need to close here if no messages were retrieved (needs a test),
There was a problem hiding this comment.
Why? Why do we need to close the folder at all?
I don't see any comment in the Internet requiring to close the folder after each fetch.
😕
garyrussell
approved these changes
Apr 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JIRA: https://jira.spring.io/browse/INT-4299
AbstractMessageSourcedo not evaluate headers when pollingresult is
nullMailReceivingMessageSourcedo not wrap polling result tothe message: the
AbstractMessageSourcewill do that later