Package adams.flow.standalone.rats.output

Class SendEmail

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.AbstractRatOutput

adams.flow.standalone.rats.output.SendEmail

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, RatOutput, Serializable

public class SendEmail
extends AbstractRatOutput

Transmitter for sending emails.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-send-email <adams.core.net.AbstractSendEmail> (property: sendEmail)
    The engine for sending the emails.
    default: adams.core.net.JavaMailSendEmail
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.net.AbstractSendEmail	m_SendEmail	for sending the emails.

Fields inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_Input, m_LoggingPrefix, m_Owner, m_Stopped, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SendEmail()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that gets accepted.
protected String	check()	Hook method for performing checks.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual transmission.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
adams.core.net.AbstractSendEmail	getSendEmail()	Returns the object for sending emails.
String	globalInfo()	Returns a string describing the object.
protected void	initSession()	Initializes the SMTP session if required.
String	sendEmailTipText()	Returns the tip text for this property.
void	setSendEmail(adams.core.net.AbstractSendEmail value)	Sets the object for sending emails.

Methods inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

backupState, canInput, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getVariables, handleException, initialize, initTransmission, input, isBackedUp, isStopped, pruneBackup, pruneBackup, restoreState, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, transmit, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_SendEmail

protected adams.core.net.AbstractSendEmail m_SendEmail

for sending the emails.

Constructor Detail

SendEmail

public SendEmail()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatOutput

Returns:

null if no info available, otherwise short string

setSendEmail

public void setSendEmail(adams.core.net.AbstractSendEmail value)

Sets the object for sending emails.

Parameters:

value - the object

getSendEmail

public adams.core.net.AbstractSendEmail getSendEmail()

Returns the object for sending emails.

Returns:

the object

sendEmailTipText

public String sendEmailTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

accepts

public Class[] accepts()

Returns the type of data that gets accepted.

Specified by:

accepts in interface RatOutput

Specified by:

accepts in class AbstractRatOutput

Returns:

the type of data

check

protected String check()

Hook method for performing checks.

Overrides:

check in class AbstractRatOutput

Returns:

null if successful, otherwise error message

initSession

protected void initSession()
                    throws Exception

Initializes the SMTP session if required.

Throws:

Exception - if initialization fails

doTransmit

protected String doTransmit()

Performs the actual transmission.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message