Package org.jgrapes.mail

Class SimpleMailMonitor

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.mail.MailComponent

org.jgrapes.mail.SimpleMailMonitor

All Implemented Interfaces:

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

public class SimpleMailMonitor
extends MailComponent

A component that monitors the INBOX of a mail account.

The component uses Jakarta Mail to connect to a mail server.

Nested Class Summary

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

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.mail.MailComponent

mailProps

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
SimpleMailMonitor()	Creates a new component with its channel set to itself.
SimpleMailMonitor(Channel componentChannel)	Creates a new component base with its channel set to the given channel.
SimpleMailMonitor(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements)	Creates a new component base like SimpleMailMonitor(Channel) but with channel mappings for Handler annotations.

Method Summary

Modifier and Type	Method	Description
protected void	configureComponent(Map<String,String> values)	Configure the component specific values.
Duration	maxIdleTime()	Returns the max idle time.
void	onStart(Start event)	Run the monitor.
void	onStop(Stop event)	Stop the monitor.
Duration	pollInterval()	Returns the poll interval.
SimpleMailMonitor	setMailProperties(Map<String,String> props)	Sets the mail properties.
SimpleMailMonitor	setMaxIdleTime(Duration maxIdleTime)	Sets the maximum idle time.
SimpleMailMonitor	setPassword(String password)	Sets the password.
void	setPollInterval(Duration pollInterval)	Sets the poll interval.

Methods inherited from class org.jgrapes.mail.MailComponent

onConfigUpdate

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, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, 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

SimpleMailMonitor

public SimpleMailMonitor()

Creates a new component with its channel set to itself.

SimpleMailMonitor

public SimpleMailMonitor(Channel componentChannel)

Creates a new component base with its channel set to the given channel.

As a special case Channel.SELF can be passed to the constructor to make the component use itself as channel. The special value is necessary as you obviously cannot pass an object to be constructed to its constructor.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

SimpleMailMonitor

public SimpleMailMonitor(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Creates a new component base like SimpleMailMonitor(Channel) but with channel mappings for Handler annotations.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

channelReplacements - the channel replacements to apply to the channels elements of the Handler annotations

Method Details

setPassword

public SimpleMailMonitor setPassword(String password)

Sets the password.

Parameters:

password - the new password

setMailProperties

public SimpleMailMonitor setMailProperties(Map<String,String> props)

Sets the mail properties.

See the Jakarta Mail documentation for available settings.

Overrides:

setMailProperties in class MailComponent

Parameters:

props - the props

Returns:

the mail monitor

setMaxIdleTime

public SimpleMailMonitor setMaxIdleTime(Duration maxIdleTime)

Sets the maximum idle time.

A running IMAPFolder.idle() is terminated and renewed after this time.

Parameters:

maxIdleTime - the new max idle time

maxIdleTime

public Duration maxIdleTime()

Returns the max idle time.

Returns:

the duration

setPollInterval

public void setPollInterval(Duration pollInterval)

Sets the poll interval.

Polling is used when the idle command is not available.

Parameters:

pollInterval - the pollInterval to set

pollInterval

public Duration pollInterval()

Returns the poll interval.

Returns:

the pollInterval

configureComponent

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

Description copied from class: MailComponent

Configure the component specific values.

Specified by:

configureComponent in class MailComponent

Parameters:

values - the values

onStart

@Handler
public void onStart(Start event)
             throws NoSuchProviderException

Run the monitor.

Parameters:

event - the event

Throws:

NoSuchProviderException - the no such provider exception

onStop

@Handler
public void onStop(Stop event)

Stop the monitor.

Parameters:

event - the event