Interface ISMTPConfiguration

  • All Known Implementing Classes:
    SMTPConfiguration

    public interface ISMTPConfiguration
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getFromAddress()
      Returns the From address for sending emails.
      java.lang.String getReplyToAddress()
      Returns the Reply-To address for sending emails.
      java.lang.String getSMTPHost()
      Returns the host name for SMTP.
      int getSMTPPort()
      Returns the port number for SMTP.
      java.lang.String getUserName()
      Returns the user name for SMTP authentication.
      java.lang.String getUserPass()
      Returns the password for SMTP authentication.
      void setFromAddress​(java.lang.String fromAddress)
      Sets the From address for SMTP to the specified address.
      void setReplyToAddress​(java.lang.String replyToAddress)
      Sets the Reply-To address for SMTP to the specified address.
      void setSMTPHost​(java.lang.String host)
      Sets the host name for SMTP to the specified value.
      void setSMTPPort​(int port)
      Sets the port number for SMTP to the specified value.
      void setUserName​(java.lang.String userName)
      Sets the user name for SMTP authentication.
      void setUserPass​(java.lang.String userPass)
      Sets the password name for SMTP authentication.
      void setUseSSLSMTP​(boolean useSSLSMTP)
      Sets whether to use SSL for SMTP.
      boolean useSSLSMTP()
      Returns whether to use SSL for SMTP.
    • Method Detail

      • useSSLSMTP

        boolean useSSLSMTP()
        Returns whether to use SSL for SMTP.
        Returns:
        true if SSL is used, false otherwise
      • setUseSSLSMTP

        void setUseSSLSMTP​(boolean useSSLSMTP)
        Sets whether to use SSL for SMTP.
        Parameters:
        useSSLSMTP - true if SSL is to be used, false otherwise
      • getSMTPPort

        int getSMTPPort()
        Returns the port number for SMTP.
        Returns:
        the port number
      • setSMTPPort

        void setSMTPPort​(int port)
        Sets the port number for SMTP to the specified value.
        Parameters:
        port - the port number to set
      • getSMTPHost

        java.lang.String getSMTPHost()
        Returns the host name for SMTP.
        Returns:
        the host name
      • setSMTPHost

        void setSMTPHost​(java.lang.String host)
        Sets the host name for SMTP to the specified value.
        Parameters:
        host - the host name to set
      • getUserName

        java.lang.String getUserName()
        Returns the user name for SMTP authentication.
        Returns:
        the SMTP user name
      • setUserName

        void setUserName​(java.lang.String userName)
        Sets the user name for SMTP authentication.
        Parameters:
        userName - the user name to set
      • getUserPass

        java.lang.String getUserPass()
        Returns the password for SMTP authentication.
        Returns:
        the SMTP password
      • setUserPass

        void setUserPass​(java.lang.String userPass)
        Sets the password name for SMTP authentication.
        Parameters:
        userPass - the password to set
      • getFromAddress

        java.lang.String getFromAddress()
        Returns the From address for sending emails.
        Returns:
        the from address
      • setFromAddress

        void setFromAddress​(java.lang.String fromAddress)
        Sets the From address for SMTP to the specified address.
        Parameters:
        fromAddress - the address from which emails will be sent
      • getReplyToAddress

        java.lang.String getReplyToAddress()
        Returns the Reply-To address for sending emails.
        Returns:
        the address where replies should go
      • setReplyToAddress

        void setReplyToAddress​(java.lang.String replyToAddress)
        Sets the Reply-To address for SMTP to the specified address. Set to null if no Reply-To headers should be included in emails.
        Parameters:
        replyToAddress - the address to which email replies should go, or null if no such header should be included