Package adams.flow.standalone

Class IMAPConnection

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, PasswordPrompter, PasswordSupporter, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InteractiveActor, OptionalPasswordPrompt, StopModeSupporter, Serializable, Comparable
    public class IMAPConnection
extends AbstractStandalone
implements OptionalPasswordPrompt, PasswordPrompter
    IMAP server setup. 

    -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: IMAPConnection
 
    -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
 
    -scheme <IMAP|IMAPS> (property: scheme)
    The IMAP scheme to use.
    default: IMAPS
 
    -server <java.lang.String> (property: server)
    The IMAP server (name/IP address) to use.
    default:
 
    -port <int> (property: port)
    The IMAP port to use, uses default if <1.
    default: -1
    minimum: -1
    maximum: 65536
 
    -timeout <int> (property: timeout)
    The timeout in msecs.
    default: 0
    minimum: 0
 
    -requires-auth <boolean> (property: requiresAuthentication)
    Enable this if IMAP server requires authentication using user/pw.
    default: false
 
    -user <java.lang.String> (property: user)
    The IMAP user to use.
 
    -password <adams.core.base.BasePassword> (property: password)
    The password of the IMAP user.
 
    -prompt-for-password <boolean> (property: promptForPassword)
    If enabled and authentication is required, the user gets prompted for enter
    a password if none has been provided in the setup.
    default: false
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Server

        protected String m_Server
        the IMAP server.

      • m_Port

        protected int m_Port
        the IMAP port.

      • m_Timeout

        protected int m_Timeout
        the timeout in msecs.

      • m_RequiresAuthentication

        protected boolean m_RequiresAuthentication
        whether the IMAP server requires authentication.

      • m_User

        protected String m_User
        the IMAP user to use.

      • m_Password

        protected BasePassword m_Password
        the IMAP password to use.

      • m_ActualPassword

        protected BasePassword m_ActualPassword
        the actual IMAP password to use.

      • m_PromptForPassword

        protected boolean m_PromptForPassword
        whether to prompt the user for a password if none provided.

      • m_StopFlowIfCanceled

        protected boolean m_StopFlowIfCanceled
        whether to stop the flow if canceled.

      • m_CustomStopMessage

        protected String m_CustomStopMessage
        the custom stop message to use if flow gets stopped due to cancelation.

      • m_StopMode

        protected StopMode m_StopMode
        how to perform the stop.

      • m_ImapServer

        protected transient jodd.mail.ImapServer m_ImapServer
        the server.

      • m_ImapSession

        protected transient jodd.mail.ReceiveMailSession m_ImapSession
        the session.

    • Constructor Detail

      • IMAPConnection

        public IMAPConnection()

    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • setScheme

        public void setScheme​(IMAPConnection.IMAPScheme value)
        Sets the IMAP scheme to use.
        Parameters:
        value - the scheme

      • schemeTipText

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

      • setServer

        public void setServer​(String value)
        Sets the IMAP server to use.
        Parameters:
        value - the host name/ip

      • getServer

        public String getServer()
        Returns the IMAP server in use.
        Returns:
        the host name/ip

      • serverTipText

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

      • setPort

        public void setPort​(int value)
        Sets the IMAP port to use.
        Parameters:
        value - the port

      • getPort

        public int getPort()
        Returns the IMAP port in use.
        Returns:
        the port

      • portTipText

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

      • setTimeout

        public void setTimeout​(int value)
        Sets the timeout in msecs.
        Parameters:
        value - the timeout

      • getTimeout

        public int getTimeout()
        Returns the timeout in msecs.
        Returns:
        the timeout

      • timeoutTipText

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

      • setRequiresAuthentication

        public void setRequiresAuthentication​(boolean value)
        Sets whether IMAP server requires authentication.
        Parameters:
        value - if true user/pw is used

      • getRequiresAuthentication

        public boolean getRequiresAuthentication()
        Returns whether IMAP server requires authentication.
        Returns:
        true if user/pw is used

      • requiresAuthenticationTipText

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

      • setUser

        public void setUser​(String value)
        Sets the IMAP user to use.
        Parameters:
        value - the user name

      • getUser

        public String getUser()
        Returns the IMAP user name to use.
        Returns:
        the user name

      • userTipText

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

      • passwordTipText

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

      • setStopFlowIfCanceled

        public void setStopFlowIfCanceled​(boolean value)
        Sets whether to stop the flow if dialog canceled.
        Specified by:
        setStopFlowIfCanceled in interface InteractiveActor
        Parameters:
        value - if true flow gets stopped if dialog canceled

      • getStopFlowIfCanceled

        public boolean getStopFlowIfCanceled()
        Returns whether to stop the flow if dialog canceled.
        Specified by:
        getStopFlowIfCanceled in interface InteractiveActor
        Returns:
        true if the flow gets stopped if dialog canceled

      • stopFlowIfCanceledTipText

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

      • setCustomStopMessage

        public void setCustomStopMessage​(String value)
        Sets the custom message to use when stopping the flow.
        Specified by:
        setCustomStopMessage in interface InteractiveActor
        Parameters:
        value - the stop message

      • getCustomStopMessage

        public String getCustomStopMessage()
        Returns the custom message to use when stopping the flow.
        Specified by:
        getCustomStopMessage in interface InteractiveActor
        Returns:
        the stop message

      • customStopMessageTipText

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

      • stopModeTipText

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

      • doInteract

        public String doInteract()
        Performs the interaction with the user.
        Specified by:
        doInteract in interface InteractiveActor
        Returns:
        null if successfully interacted, otherwise error message

      • supportsHeadlessInteraction

        public boolean supportsHeadlessInteraction()
        Returns whether headless interaction is supported.
        Specified by:
        supportsHeadlessInteraction in interface InteractiveActor
        Returns:
        true if interaction in headless environment is possible

      • doInteractHeadless

        public String doInteractHeadless()
        Performs the interaction with the user in a headless environment.
        Specified by:
        doInteractHeadless in interface InteractiveActor
        Returns:
        null if successfully interacted, otherwise error message

      • getImapServer

        public jodd.mail.ImapServer getImapServer()
        Returns the imap server instance, instantiates it if necessary.
        Returns:
        the server instance

      • getImapSession

        public jodd.mail.ReceiveMailSession getImapSession()
        Returns image session, instantiates it if necessary and opens it.
        Returns:
        the session

      • doExecute

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

      • closeImap

        protected void closeImap()
        Closes the image connection.

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished. Graphical output is left untouched.
        Specified by:
        wrapUp in interface Actor
        Overrides:
        wrapUp in class AbstractActor