Package org.jgrapes.mail

Class MailMonitor

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.io.util.ConnectionManager<MailMonitor.MonitorChannel>

org.jgrapes.mail.MailConnectionManager<MailMonitor.MonitorChannel,OpenMailMonitor>

org.jgrapes.mail.MailMonitor

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class MailMonitor
extends MailConnectionManager<MailMonitor.MonitorChannel,OpenMailMonitor>

A component that opens mail stores and monitors mail folders for mails.

After establishing a connection to a store and selected folders (see onOpenMailMonitor(OpenMailMonitor, Channel)), the existing and all subsequently arriving mails will be sent downstream using MailFoldersUpdated events.

This implementation uses the IdleManager. The IdleManager works only if its IdleManager.watch(jakarta.mail.Folder) method is invoked (for a folder) after any operation on that folder. Note that operations such as e.g. setting the deleted flag of a message is also an operation on a folder.

Folders are updated in response to an UpdateMailFolders event or when the store signals the arrival of new messages. Information about the folders is delivered by a MailFoldersUpdated event. Folders may be freely used while handling the event, because the folders will be re-registered with the IdleManager when the MailFoldersUpdated event completes. Any usage of folders independent of handling the events mentioned will result in a loss of the monitor function.

If required, the monitor function may be reestablished any time by firing a UpdateMailFolders event for the folders used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	MailMonitor.MonitorChannel	The specific implementation of the MailChannel.

Nested classes/interfaces inherited from class org.jgrapes.mail.MailConnectionManager

MailConnectionManager.AbstractMailChannel

Nested classes/interfaces inherited from class org.jgrapes.io.util.ConnectionManager

ConnectionManager.Connection

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.mail.MailConnectionManager

mailProps

Fields inherited from class org.jgrapes.io.util.ConnectionManager

connections

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
MailMonitor(Channel componentChannel)	Creates a new server using the given channel.

Method Summary

Modifier and Type	Method	Description
protected void	configureComponent(Map<String,String> values)	Configure the component.
protected boolean	connectionsGenerate()	If connections are event generators, register the component as generator upon the creation of the first connection and unregister it when closing the last one.
Duration	maxIdleTime()	Returns the max idle time.
void	onOpenMailMonitor(OpenMailMonitor event, Channel channel)	Open a store as specified by the event and monitor the folders (also specified by the event).
void	onUpdateFolders(UpdateMailFolders event, MailChannel channel)	Retrieves the folders specified in the event.
MailMonitor	setMaxIdleTime(Duration maxIdleTime)	Sets the maximum idle time.
String	toString()	If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Methods inherited from class org.jgrapes.mail.MailConnectionManager

onConfigUpdate, password, setMailProperties, setPassword

Methods inherited from class org.jgrapes.io.util.ConnectionManager

executorService, onClose, onStop, setExecutorService

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

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

activeEventPipeline, addHandler, attach, channelReplacements, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

MailMonitor

public MailMonitor(Channel componentChannel)

Creates a new server using the given channel.

Parameters:

componentChannel - the component’s channel

Method Details

connectionsGenerate

protected boolean connectionsGenerate()

Description copied from class: ConnectionManager

If connections are event generators, register the component as generator upon the creation of the first connection and unregister it when closing the last one.

Specified by:

connectionsGenerate in class ConnectionManager<MailMonitor.MonitorChannel>

Returns:

true, if connections generate

setMaxIdleTime

public MailMonitor setMaxIdleTime(Duration maxIdleTime)

Sets the maximum idle time.

A running IMAPFolder.idle() is terminated and renewed after this time. Defaults to 25 minutes.

Parameters:

maxIdleTime - the new max idle time

maxIdleTime

public Duration maxIdleTime()

Returns the max idle time.

Returns:

the duration

configureComponent

protected void configureComponent(Map<String,String> values)

Configure the component.

Currently, only max idle time is supported.

Specified by:

configureComponent in class MailConnectionManager<MailMonitor.MonitorChannel,OpenMailMonitor>

Parameters:

values - the values

onOpenMailMonitor

@Handler
public void onOpenMailMonitor(OpenMailMonitor event,
 Channel channel)

Open a store as specified by the event and monitor the folders (also specified by the event).

Information about all existing and all subsequently arriving mails will be signaled downstream using MailFoldersUpdated events.

Parameters:

event - the event

channel - the channel

onUpdateFolders

@Handler
public void onUpdateFolders(UpdateMailFolders event,
 MailChannel channel)

Retrieves the folders specified in the event.

Parameters:

event - the event

channel - the channel

toString

public String toString()

Description copied from class: ComponentVertex

If a name has been set for this component (see Manager.setName(String)), return the name, else return the object name provided by Components.objectName(Object), using ComponentVertex.component() as argument.

Overrides:

toString in class ComponentVertex