Package adams.flow.sink

Class SendEmail

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, MultiAttemptSupporter, MultiAttemptWithWaitSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, Serializable, Comparable
    public class SendEmail
extends AbstractSink
implements MultiAttemptWithWaitSupporter
    Actor 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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SendEmail
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert
 
    -send-email <adams.core.net.SendEmail> (property: sendEmail)
    The engine for sending the emails.
    default: adams.core.net.JavaMailSendEmail
 
    -num-attempts <int> (property: numAttempts)
    The maximum number of initialization attempts to undertake.
    default: 3
    minimum: 1
 
    -attempt-interval <int> (property: attemptInterval)
    The time in msec to wait before the next attempt.
    default: 1000
    minimum: 0
 
    -queue <boolean> (property: queue)
    Whether to queue the emails rather than waiting for them to be sent.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_SendEmail

        protected SendEmail m_SendEmail
        for sending the emails.

      • m_NumAttempts

        protected int m_NumAttempts
        the maximum number of initialization attempts.

      • m_AttemptInterval

        protected int m_AttemptInterval
        the interval between attempts.

      • m_Queue

        protected boolean m_Queue
        whether to queue the emails rather than waiting for sending to finish.

      • m_Sending

        protected List<SwingWorker> m_Sending
        the emails still to send.

    • Constructor Detail

      • SendEmail

        public SendEmail()

    • Method Detail

      • setSendEmail

        public void setSendEmail​(SendEmail value)
        Sets the object for sending emails.
        Parameters:
        value - the object

      • getSendEmail

        public SendEmail 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.

      • setNumAttempts

        public void setNumAttempts​(int value)
        Sets the maximum number of initialization attempts.
        Specified by:
        setNumAttempts in interface MultiAttemptSupporter
        Parameters:
        value - the maximum

      • getNumAttempts

        public int getNumAttempts()
        Returns the maximum number of initialization attempts.
        Specified by:
        getNumAttempts in interface MultiAttemptSupporter
        Returns:
        the maximum

      • numAttemptsTipText

        public String numAttemptsTipText()
        Returns the tip text for this property.
        Specified by:
        numAttemptsTipText in interface MultiAttemptSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • attemptIntervalTipText

        public String attemptIntervalTipText()
        Returns the tip text for this property.
        Specified by:
        attemptIntervalTipText in interface MultiAttemptWithWaitSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setQueue

        public void setQueue​(boolean value)
        Sets whether to queue the emails rather than waiting for each to be sent.
        Parameters:
        value - true if to queue

      • getQueue

        public boolean getQueue()
        Returns whether the emails are queue rather than being waited on.
        Returns:
        true if to queue

      • queueTipText

        public String queueTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        adams.core.net.Email.class

      • initSession

        protected void initSession()
                    throws Exception
        Initializes the SMTP session if required.
        Throws:
        Exception - if initialization fails

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractSink