Package org.cyclos.entities.messaging
Enum MailContext
- java.lang.Object
-
- java.lang.Enum<MailContext>
-
- org.cyclos.entities.messaging.MailContext
-
- All Implemented Interfaces:
Serializable,Comparable<MailContext>
public enum MailContext extends Enum<MailContext>
Mail context used mainly to determine the from name and to email address when sending mail
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCESS_CLIENT_ACTIVATIONThe activation code for an access clientCUSTOM_NOTIFICATIONA custom notification generated by scriptEMAIL_CHANGEWhen the e-mail address of a user is changed, the old address is notifiedFORGOT_PASSWORDA guest has requested a forgotten password retrieval by e-mailFORWARD_INTERNAL_MESSAGEAn internal message forwarded to e-mailLOGIN_ON_NEW_DEVICEA login was performed from a device not previously usedMAILING_LISTAn e-mail sent for a mailing listNEW_EMAIL_VALIDATIONA user e-mail address was changed, and an e-mail is sent to validate the new addressNEW_MOBILE_PHONEA new mobile phone was added to the user profileNOTIFICATIONA notification received by e-mailOTPA confirmation password OTP is sent via e-mailPASSWORD_RESETA password was reset and sent via e-mailPENDING_ACTIVATIONA user was registered, but the initial status is not activeREGISTRATION_ACTIVATIONA new user was successfully activated, either by registering when e-mail validation is off, or when validating the e-mail address.REGISTRATION_VALIDATIONA new pending user has been registered, and the e-mail address is validatedTOTP_ACTIVATIONThe activation code for a TOTP deviceTRUSTED_DEVICE_ACTIVATIONThe activation code for a trusted deviceWIZARD_EMAIL_VALIDATIONDuring a wizard execution, the e-mail should be validated
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MailContextPrioritygetPriority()Indicates the email priorityEmailUnsubscribeTypeunsubscribeType()Returns the corresponding unsubscription type for this e-mail type, if anystatic MailContextvalueOf(String name)Returns the enum constant of this type with the specified name.static MailContext[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
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 nameNullPointerException- if the argument is null
-
getPriority
public MailContextPriority getPriority()
Indicates the email priority
-
unsubscribeType
public EmailUnsubscribeType unsubscribeType()
Returns the corresponding unsubscription type for this e-mail type, if any
-
-