Package com.atlassian.crowd.manager.mailer

Enum Class MailTemplateMacro

java.lang.Object

java.lang.Enum<MailTemplateMacro>

com.atlassian.crowd.manager.mailer.MailTemplateMacro

All Implemented Interfaces:

Serializable, Comparable<MailTemplateMacro>, Constable

public enum MailTemplateMacro
extends Enum<MailTemplateMacro>

Text macros used by MailTemplateRenderer to dynamically generate values for emails sent by Crowd.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Recipient's active status
ADMIN_CONTACT	Administrator contact macro key.
CHANGE_PASSWORD_LINK	Change password link macro key.
DATE	Current date macro key.
DAYS_TO_PASSWORD_EXPIRATION	Days until password will expire macro key.
DEPLOYMENT_TITLE	Crowd deployment title macro key.
EMAIL	Recipient's email address macro key.
FIRSTNAME	Recipient's first name macro key.
LASTNAME	Recipient's last name macro key.
PASSWORD	Deprecated.
RESET_LINK	Password reset link macro key.
USERNAME	Recipient's username macro key.

Method Summary

Modifier and Type	Method	Description
String	getMacro()
static MailTemplateMacro	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MailTemplateMacro[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATE

public static final MailTemplateMacro DATE

Current date macro key.

DEPLOYMENT_TITLE

public static final MailTemplateMacro DEPLOYMENT_TITLE

Crowd deployment title macro key.

ADMIN_CONTACT

public static final MailTemplateMacro ADMIN_CONTACT

Administrator contact macro key.

USERNAME

public static final MailTemplateMacro USERNAME

Recipient's username macro key.

FIRSTNAME

public static final MailTemplateMacro FIRSTNAME

Recipient's first name macro key.

LASTNAME

public static final MailTemplateMacro LASTNAME

Recipient's last name macro key.

PASSWORD

@Deprecated
public static final MailTemplateMacro PASSWORD

Deprecated.

Forgotten login key. For backwards compatibility only.

DAYS_TO_PASSWORD_EXPIRATION

public static final MailTemplateMacro DAYS_TO_PASSWORD_EXPIRATION

Days until password will expire macro key.

CHANGE_PASSWORD_LINK

public static final MailTemplateMacro CHANGE_PASSWORD_LINK

Change password link macro key.

ACTIVE

public static final MailTemplateMacro ACTIVE

Recipient's active status

RESET_LINK

public static final MailTemplateMacro RESET_LINK

Password reset link macro key.

EMAIL

public static final MailTemplateMacro EMAIL

Recipient's email address macro key.

Method Details

values

public static MailTemplateMacro[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MailTemplateMacro valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMacro

public String getMacro()