Package org.jgrapes.mail

Class SimpleMailSender

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.mail.MailComponent

org.jgrapes.mail.SimpleMailSender

All Implemented Interfaces:

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

public class SimpleMailSender
extends MailComponent

A component that sends mail.

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
SimpleMailSender()	Creates a new component with its channel set to itself.
SimpleMailSender(Channel componentChannel)	Creates a new component base with its channel set to the given channel.
SimpleMailSender(Channel componentChannel, HandlerDefinition.ChannelReplacements channelReplacements)	Creates a new component base like SimpleMailSender(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	onMessage(SendMailMessage event)	Sends the message as specified by the event.
void	onStart(Start event)	Start the component.
void	onStop(Stop event)	Stop the monitor.
SimpleMailSender	setMailProperties(Map<String,String> props)	Sets the mail properties.
SimpleMailSender	setMaxIdleTime(Duration maxIdleTime)	Sets the maximum idle time.
SimpleMailSender	setPassword(String password)	Sets the password.

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

SimpleMailSender

public SimpleMailSender()

Creates a new component with its channel set to itself.

SimpleMailSender

public SimpleMailSender(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

SimpleMailSender

public SimpleMailSender(Channel componentChannel,
 HandlerDefinition.ChannelReplacements channelReplacements)

Creates a new component base like SimpleMailSender(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 SimpleMailSender setPassword(String password)

Sets the password.

Parameters:

password - the new password

setMailProperties

public SimpleMailSender 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 SimpleMailSender setMaxIdleTime(Duration maxIdleTime)

Sets the maximum idle time.

An open connection to the mail server is closed after this time.

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)

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 MessagingException

Start the component.

Parameters:

event - the event

Throws:

MessagingException

onMessage

@Handler
public void onMessage(SendMailMessage event)
               throws MessagingException

Sends the message as specified by the event.

Parameters:

event - the event

Throws:

MessagingException - the messaging exception

onStop

@Handler
public void onStop(Stop event)

Stop the monitor.

Parameters:

event - the event

Throws:

MessagingException