Package adams.flow.standalone.rats.input

Class IMAP

  • 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<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, RatInput, Serializable
    public class IMAP
extends AbstractRatInput
    Executes the specified IMAP operation and forwards the generated output. 

    -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
 
    -operation <adams.flow.source.imapsource.AbstractIMAPOperation> (property: operation)
    The IMAP operation to perform.
    default: adams.flow.source.imapsource.ListFolders
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Operation

        protected adams.flow.source.imapsource.AbstractIMAPOperation m_Operation
        the operation to execute.

      • m_Connection

        protected transient adams.flow.standalone.IMAPConnection m_Connection
        the IMAP connection.

      • m_Data

        protected transient jodd.mail.ReceivedEmail[] m_Data
        the messages that were received.

    • Constructor Detail

      • IMAP

        public IMAP()

    • 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

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.core.option.AbstractOptionHandler

      • setOperation

        public void setOperation​(adams.flow.source.imapsource.AbstractIMAPOperation value)
        Sets the IMAP operation to perform.
        Parameters:
        value - the operation

      • getOperation

        public adams.flow.source.imapsource.AbstractIMAPOperation getOperation()
        Returns the IMAP operation to perform.
        Returns:
        the operation

      • operationTipText

        public String operationTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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 AbstractRatInput
        Returns:
        null if no info available, otherwise short string

      • doReceive

        protected String doReceive()
        Performs the actual reception of data.
        Specified by:
        doReceive in class AbstractRatInput
        Returns:
        null if successful, otherwise error message