Package adams.flow.standalone

Class SMTPConnection

  • 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 SMTPConnection
extends AbstractStandalone
implements OptionalPasswordPrompt, PasswordPrompter
    SMTP server setup for overriding default parameters. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SMTPConnection
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -server <java.lang.String> (property: server)
    The SMTP server (name/IP address) to use.
    default: smtp.gmail.com
 
    -port <int> (property: port)
    The SMTP port to use.
    default: 587
    minimum: 1
    maximum: 65536
 
    -use-tls <boolean> (property: useTLS)
    If enabled, TLS (transport layer security) is used.
    default: true
 
    -use-ssl <boolean> (property: useSSL)
    If enabled, SSL (secure sockets layer) is used for connecting.
    default: false
 
    -timeout <int> (property: timeout)
    The timeout in msecs.
    default: 30000
    minimum: 0
 
    -requires-auth <boolean> (property: requiresAuthentication)
    Enable this if SMTP server requires authentication using user/pw.
    default: true
 
    -user <java.lang.String> (property: user)
    The SMTP user to use.
 
    -password <adams.core.base.BasePassword> (property: password)
    The password of the SMTP 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:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Server

        protected String m_Server
        the SMTP server.

      • m_Port

        protected int m_Port
        the SMTP port.

      • m_UseTLS

        protected boolean m_UseTLS
        whether to use TLS.

      • m_Protocols

        protected String m_Protocols
        the protocols to use.

      • m_UseSSL

        protected boolean m_UseSSL
        whether to use SSL.

      • m_Timeout

        protected int m_Timeout
        the timeout in msecs.

      • m_RequiresAuthentication

        protected boolean m_RequiresAuthentication
        whether the SMTP server requires authentication.

      • m_User

        protected String m_User
        the SMTP user to use.

      • m_Password

        protected BasePassword m_Password
        the SMTP password to use.

      • m_ActualPassword

        protected BasePassword m_ActualPassword
        the actual SMTP 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.

    • Constructor Detail

      • SMTPConnection

        public SMTPConnection()

    • Method Detail

      • setServer

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

      • getServer

        public String getServer()
        Returns the SMTP 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 SMTP port to use.
        Parameters:
        value - the port

      • getPort

        public int getPort()
        Returns the SMTP 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.

      • setUseTLS

        public void setUseTLS​(boolean value)
        Sets whether to use TLS.
        Parameters:
        value - if true TLS is used

      • getUseTLS

        public boolean getUseTLS()
        Returns whether TLS is used.
        Returns:
        true if TLS is used

      • useTLSTipText

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

      • setProtocols

        public void setProtocols​(String value)
        Sets the SMTP protocols to use.
        Parameters:
        value - the protocols, empty to use default

      • getProtocols

        public String getProtocols()
        Returns the SMTP protocols in use.
        Returns:
        the protocols, empty to use default

      • protocolsTipText

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

      • setUseSSL

        public void setUseSSL​(boolean value)
        Sets whether to use SSL.
        Parameters:
        value - if true SSL is used

      • getUseSSL

        public boolean getUseSSL()
        Returns whether SSL is used.
        Returns:
        true if SSL is used

      • useSSLTipText

        public String useSSLTipText()
        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 SMTP server requires authentication.
        Parameters:
        value - if true user/pw is used

      • getRequiresAuthentication

        public boolean getRequiresAuthentication()
        Returns whether SMTP 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 SMTP user to use.
        Parameters:
        value - the user name

      • getUser

        public String getUser()
        Returns the SMTP 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

      • initializeSmtpSession

        public void initializeSmtpSession​(AbstractSendEmail sendEmail)
                           throws Exception
        Initializes the SMTP session with the specified parameters.
        Parameters:
        sendEmail - the object to initialize
        Throws:
        Exception - if initialization fails

      • doExecute

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