adams.flow.sink
Class Email

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.sink.AbstractSink
                  adams.flow.sink.Email

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, Serializable, Comparable

public class Email
extends AbstractSink

Actor for sending emails. The (optional) attachments are taken from the input.
Variables in 'subject', 'body' and 'signature' are automatically replaced whenever the actor is executed.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: Email
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-recipient <adams.core.net.EmailAddress> [-recipient ...] (property: recipients)
    The recipients to send the email to.
    default:
 

-subject <java.lang.String> (property: subject)
    The subject of the email.
    default:
 

-body <adams.core.base.BaseText> (property: body)
    The body of the email.
    default:
 

-signature <adams.core.base.BaseText> (property: signature)
    The signature of the email, gets separated by an extra line consisting of
    '--'.
    default:
 

Version:

$Revision: 5771 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected BaseText	m_Body the body.
protected EmailAddress[]	m_Recipients the recipients.
protected BaseText	m_Signature the signature.
protected String	m_Subject the subject.

Fields inherited from class adams.flow.sink.AbstractSink

BACKUP_INPUT, m_InputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

Email()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	bodyTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
BaseText	getBody() Returns the body of the email.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
EmailAddress[]	getRecipients() Returns the recipients.
BaseText	getSignature() Returns the body of the email.
String	getSubject() Returns the subject.
String	globalInfo() Returns a string describing the object.
String	recipientsTipText() Returns the tip text for this property.
void	setBody(BaseText value) Sets the body of the email.
void	setRecipients(EmailAddress[] value) Sets the recipients.
void	setSignature(BaseText value) Sets the body of the email.
void	setSubject(String value) Sets the subject.
String	setUp() Initializes the item for flow execution.
String	signatureTipText() Returns the tip text for this property.
String	subjectTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.sink.AbstractSink

backupState, input, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_Recipients

protected EmailAddress[] m_Recipients

the recipients.

m_Subject

protected String m_Subject

the subject.

m_Body

protected BaseText m_Body

the body.

m_Signature

protected BaseText m_Signature

the signature.

Constructor Detail

Email

public Email()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractActor

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setRecipients

public void setRecipients(EmailAddress[] value)

Sets the recipients.

Parameters:

value - the recipients

getRecipients

public EmailAddress[] getRecipients()

Returns the recipients.

Returns:

the recipients

recipientsTipText

public String recipientsTipText()

Returns the tip text for this property.

Returns:

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

setSubject

public void setSubject(String value)

Sets the subject.

Parameters:

value - the subject

getSubject

public String getSubject()

Returns the subject.

Returns:

the subject

subjectTipText

public String subjectTipText()

Returns the tip text for this property.

Returns:

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

setBody

public void setBody(BaseText value)

Sets the body of the email.

Parameters:

value - the body

getBody

public BaseText getBody()

Returns the body of the email.

Returns:

the body

bodyTipText

public String bodyTipText()

Returns the tip text for this property.

Returns:

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

setSignature

public void setSignature(BaseText value)

Sets the body of the email.

Parameters:

value - the body

getSignature

public BaseText getSignature()

Returns the body of the email.

Returns:

the body

signatureTipText

public String signatureTipText()

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 class that the consumer accepts.

Returns:

java.lang.String.class, java.lang.String[].class, java.io.File.class, java.io.File[].class

setUp

public String setUp()

Initializes the item for flow execution.

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message