Package org.jgrapes.mail.events

Class OpenMailConnection

java.lang.Object

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

org.jgrapes.core.Event<Void>

org.jgrapes.mail.events.OpenMailConnection

All Implemented Interfaces:

Future<Void>, Associator, Eligible

Direct Known Subclasses:

OpenMailMonitor, OpenMailSender

public abstract class OpenMailConnection
extends Event<Void>

Common base class for events that open a mail connection for sending or receiving mail.

Note that all configuration information (such as mail server, protocol, user name) is provided as mail properties (see {@link #setMailProperties(Map)).

Also note that a component receiving the event may have default or system wide values configured for the properties.

Field Summary

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

completed, completionEvents

Constructor Summary

Constructors

Constructor	Description
OpenMailConnection()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	mailProperties()	Returns the mail properties.
Optional<Password>	password()	Returns the password.
OpenMailConnection	setMailProperties(Map<String,String> props)	Specifies mail properties that override defaults set for the handling MailConnectionManager.
OpenMailConnection	setMailProperty(String name, String value)	Sets a single mail property, see setMailProperties(Map).
OpenMailConnection	setPassword(Password password)	Sets the password used for opening the connection.

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

OpenMailConnection

public OpenMailConnection()

Method Details

setMailProperties

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

Specifies mail properties that override defaults set for the handling MailConnectionManager.

Merges the given properties with properties already set for the event.

Parameters:

props - the props

Returns:

the event

setMailProperty

public OpenMailConnection setMailProperty(String name,
 String value)

Sets a single mail property, see setMailProperties(Map).

Parameters:

name - the name

value - the value

Returns:

the open mail connection

mailProperties

public Map<String,String> mailProperties()

Returns the mail properties.

Returns:

the map

setPassword

public OpenMailConnection setPassword(Password password)

Sets the password used for opening the connection.

Parameters:

password - the password

Returns:

the open mail connection

password

public Optional<Password> password()

Returns the password.

Returns:

the password