Package org.jgrapes.mail.events

Class MailFoldersUpdated

java.lang.Object

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

org.jgrapes.core.Event<Void>

org.jgrapes.mail.events.MailFoldersUpdated

All Implemented Interfaces:

Future<Void>, Associator, Eligible

public class MailFoldersUpdated
extends Event<Void>

Signals the retrieval of mails (update) by a MailMonitor.

Must be fired on a MailChannel.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

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

completed, completionEvents, invokedFor

Constructor Summary

Constructors

Constructor	Description
MailFoldersUpdated(List<Folder> folders, List<Message> newMessages)	Instantiates a new event.

Method Summary

Modifier and Type	Method	Description
List<Folder>	folders()	Returns the folders.
static List<Message>	messages(Folder folder)	Return all messages (which are not deleted) from the folder.
static List<Message>	messages(Folder folder, int max)	Return all (or max) messages (which are not deleted) from the folder, starting with the newest message.
List<Message>	newMessages()	Return the new messages.
static <R> R	withFolder(Folder folder, Function<Folder,R> action)	Execute the action with the given folder.

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Constructor Details

MailFoldersUpdated

public MailFoldersUpdated(List<Folder> folders,
 List<Message> newMessages)

Instantiates a new event.

Parameters:

folders - the folders

newMessages - the new messages

Method Details

folders

public List<Folder> folders()

Returns the folders.

Returns:

the list

newMessages

public List<Message> newMessages()

Return the new messages.

New messages have not been reported before by an event.

Returns:

the list

withFolder

public static <R> R withFolder(Folder folder,
 Function<Folder,R> action)
                        throws MessagingException

Execute the action with the given folder.

The method ensures that the folder is open.

Parameters:

folder - the folder

action - the action

Throws:

MessagingException - the messaging exception

messages

public static List<Message> messages(Folder folder)
                              throws MessagingException

Return all messages (which are not deleted) from the folder.

Parameters:

folder - the folder

Returns:

the message[]

Throws:

MessagingException - the messaging exception

messages

public static List<Message> messages(Folder folder,
 int max)
                              throws MessagingException

Return all (or max) messages (which are not deleted) from the folder, starting with the newest message.

Parameters:

folder - the folder

max - the limit

Returns:

the message[]

Throws:

MessagingException - the messaging exception