Package org.jgrapes.mail.events

Class UpdateFolders

java.lang.Object

org.jgrapes.core.internal.EventBase<T>

org.jgrapes.core.Event<List<Folder>>

org.jgrapes.mail.events.UpdateFolders

All Implemented Interfaces:

Future<List<Folder>>, Associator, Eligible

public class UpdateFolders
extends Event<List<Folder>>

Triggers the retrieval of mails (update) by a MailStoreMonitor.

Must be fired on a MailChannel.

Field Summary

Fields inherited from class org.jgrapes.core.internal.EventBase

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
UpdateFolders(String... folderNames)	Causes new messages to be retrieved from the given folders.

Method Summary

Modifier and Type	Method	Description
String[]	folderNames()	Returns the folder names.

Methods inherited from class org.jgrapes.core.Event

addCompletionEvent, associated, cancel, channels, channels, completionEvents, currentResults, defaultCriterion, forChannels, get, get, handled, handlingError, isCancelled, isDone, isEligibleFor, isStopped, processedBy, results, results, resumeHandling, setAssociated, setChannels, setRequiresResult, setResult, stop, suspendHandling, suspendHandling, tieTo, toString

Methods inherited from class org.jgrapes.core.internal.EventBase

disableTracking, enqueued, firstResultAssigned, isTracked, onCompletion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgrapes.core.Associator

associated, associated, associated, associatedGet

Constructor Details

UpdateFolders

public UpdateFolders(String... folderNames)

Causes new messages to be retrieved from the given folders.

The folders specified may be a subset of the folder names used in the initial OpenMailConnection event. If left empty, all folders specified in the open event are retrieved again.

Parameters:

folderNames - the folder names

Method Details

folderNames

public String[] folderNames()

Returns the folder names.

Returns:

the string[]