Package com.mendix.modules.email

Class SMTPConfiguration

    • Constructor Summary

      Constructors 
      Constructor Description
      SMTPConfiguration()
      Creates an empty default SMTP configuration.

    • Method Summary

      All Methods Instance Methods Concrete 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.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SMTPConfiguration

        public SMTPConfiguration()
        Creates an empty default SMTP configuration.

    • Method Detail

      • useSSLSMTP

        public boolean useSSLSMTP()
        Description copied from interface: ISMTPConfiguration
        Returns whether to use SSL for SMTP.
        Specified by:
        useSSLSMTP in interface ISMTPConfiguration
        Returns:
        true if SSL is used, false otherwise

      • setUseSSLSMTP

        public void setUseSSLSMTP​(boolean useSSLSMTP)
        Description copied from interface: ISMTPConfiguration
        Sets whether to use SSL for SMTP.
        Specified by:
        setUseSSLSMTP in interface ISMTPConfiguration
        Parameters:
        useSSLSMTP - true if SSL is to be used, false otherwise

      • setSMTPPort

        public void setSMTPPort​(int port)
        Description copied from interface: ISMTPConfiguration
        Sets the port number for SMTP to the specified value.
        Specified by:
        setSMTPPort in interface ISMTPConfiguration
        Parameters:
        port - the port number to set

      • setSMTPHost

        public void setSMTPHost​(java.lang.String host)
        Description copied from interface: ISMTPConfiguration
        Sets the host name for SMTP to the specified value.
        Specified by:
        setSMTPHost in interface ISMTPConfiguration
        Parameters:
        host - the host name to set

      • getUserName

        public java.lang.String getUserName()
        Description copied from interface: ISMTPConfiguration
        Returns the user name for SMTP authentication.
        Specified by:
        getUserName in interface ISMTPConfiguration
        Returns:
        the SMTP user name

      • setUserName

        public void setUserName​(java.lang.String userName)
        Description copied from interface: ISMTPConfiguration
        Sets the user name for SMTP authentication.
        Specified by:
        setUserName in interface ISMTPConfiguration
        Parameters:
        userName - the user name to set

      • getUserPass

        public java.lang.String getUserPass()
        Description copied from interface: ISMTPConfiguration
        Returns the password for SMTP authentication.
        Specified by:
        getUserPass in interface ISMTPConfiguration
        Returns:
        the SMTP password

      • setUserPass

        public void setUserPass​(java.lang.String userPass)
        Description copied from interface: ISMTPConfiguration
        Sets the password name for SMTP authentication.
        Specified by:
        setUserPass in interface ISMTPConfiguration
        Parameters:
        userPass - the password to set

      • setFromAddress

        public void setFromAddress​(java.lang.String fromAddress)
        Description copied from interface: ISMTPConfiguration
        Sets the From address for SMTP to the specified address.
        Specified by:
        setFromAddress in interface ISMTPConfiguration
        Parameters:
        fromAddress - the address from which emails will be sent

      • getReplyToAddress

        public java.lang.String getReplyToAddress()
        Description copied from interface: ISMTPConfiguration
        Returns the Reply-To address for sending emails.
        Specified by:
        getReplyToAddress in interface ISMTPConfiguration
        Returns:
        the address where replies should go

      • setReplyToAddress

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