Enum MailContext

    • Enum Constant Detail

      • NOTIFICATION

        public static final MailContext NOTIFICATION
        A notification received by e-mail
      • CUSTOM_NOTIFICATION

        public static final MailContext CUSTOM_NOTIFICATION
        A custom notification generated by script
      • FORWARD_INTERNAL_MESSAGE

        public static final MailContext FORWARD_INTERNAL_MESSAGE
        An internal message forwarded to e-mail
      • NEW_EMAIL_VALIDATION

        public static final MailContext NEW_EMAIL_VALIDATION
        A user e-mail address was changed, and an e-mail is sent to validate the new address
      • WIZARD_EMAIL_VALIDATION

        public static final MailContext WIZARD_EMAIL_VALIDATION
        During a wizard execution, the e-mail should be validated
      • EMAIL_CHANGE

        public static final MailContext EMAIL_CHANGE
        When the e-mail address of a user is changed, the old address is notified
      • NEW_MOBILE_PHONE

        public static final MailContext NEW_MOBILE_PHONE
        A new mobile phone was added to the user profile
      • LOGIN_ON_NEW_DEVICE

        public static final MailContext LOGIN_ON_NEW_DEVICE
        A login was performed from a device not previously used
      • PASSWORD_RESET

        public static final MailContext PASSWORD_RESET
        A password was reset and sent via e-mail
      • OTP

        public static final MailContext OTP
        A confirmation password OTP is sent via e-mail
      • REGISTRATION_ACTIVATION

        public static final MailContext REGISTRATION_ACTIVATION
        A new user was successfully activated, either by registering when e-mail validation is off, or when validating the e-mail address.
      • REGISTRATION_VALIDATION

        public static final MailContext REGISTRATION_VALIDATION
        A new pending user has been registered, and the e-mail address is validated
      • PENDING_ACTIVATION

        public static final MailContext PENDING_ACTIVATION
        A user was registered, but the initial status is not active
      • FORGOT_PASSWORD

        public static final MailContext FORGOT_PASSWORD
        A guest has requested a forgotten password retrieval by e-mail
      • TRUSTED_DEVICE_ACTIVATION

        public static final MailContext TRUSTED_DEVICE_ACTIVATION
        The activation code for a trusted device
      • TOTP_ACTIVATION

        public static final MailContext TOTP_ACTIVATION
        The activation code for a TOTP device
      • MAILING_LIST

        public static final MailContext MAILING_LIST
        An e-mail sent for a mailing list
      • ACCESS_CLIENT_ACTIVATION

        public static final MailContext ACCESS_CLIENT_ACTIVATION
        The activation code for an access client
    • Method Detail

      • values

        public static MailContext[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (MailContext c : MailContext.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static MailContext valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • unsubscribeType

        public EmailUnsubscribeType unsubscribeType()
        Returns the corresponding unsubscription type for this e-mail type, if any