Class SignUpConfiguration.EmailConfig

  • Enclosing class:
    SignUpConfiguration

    public static final class SignUpConfiguration.EmailConfig
    extends java.lang.Object
    Configures the options related to sending an email response, after a successful user registration.

    Emails can be fully customized by creating an HTML template and storing it under the Extension's folder or any sub-folder under that same path. Email templates use simple place holders to inject dynamic content from code. The pre-defined place holders are:

    • ${userName} for the user name
    • ${password} for the user password

    IMPORTANT:

    In order to be able to send emails from SmartFoxServer 2X you will need to configure the Mailer Service from the AdminTool>Server Configurator.

    You can read more about how to do this here.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.Map<java.lang.String,​java.lang.String> customEmailFields
      (Optional) a map of place holders and relative values to be populated in the email body.
      java.lang.String fromAddress
      The email's from address
      boolean isActive
      Turns on/off the automated email
      int maxResendTimes
      Determines how many times a user can request the Activation email to be re-sent in case the previous one wasn't received.
      java.lang.String subject
      The email's subject
      java.lang.String template
      The path to the email HTML template relative to the Extension's folder.
    • Constructor Summary

      Constructors 
      Constructor Description
      EmailConfig()  
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • isActive

        public boolean isActive
        Turns on/off the automated email
      • template

        public java.lang.String template
        The path to the email HTML template relative to the Extension's folder.
      • fromAddress

        public java.lang.String fromAddress
        The email's from address
      • subject

        public java.lang.String subject
        The email's subject
      • customEmailFields

        public java.util.Map<java.lang.String,​java.lang.String> customEmailFields
        (Optional) a map of place holders and relative values to be populated in the email body.

        This can be useful to dynamically generate HTML content in the response email.

      • maxResendTimes

        public int maxResendTimes
        Determines how many times a user can request the Activation email to be re-sent in case the previous one wasn't received. (default = 3 times)
    • Constructor Detail

      • EmailConfig

        public EmailConfig()