Package io.micronaut.email

Enum Class TrackLinks

java.lang.Object

java.lang.Enum<TrackLinks>

io.micronaut.email.TrackLinks

All Implemented Interfaces:

Serializable, Comparable<TrackLinks>, Constable

public enum TrackLinks
extends Enum<TrackLinks>

Whether to track if the links are clicked in an email.

Since:

1.0.0

Author:

Sergio del Amo

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
DO_NOT_TRACK	Whether email links should not be tracked neither in HTML nor in plain text emails.
HTML	Whether to track links only in HTML emails.
HTML_AND_TEXT	Whether to track links in HTML and Plain text emails.
TEXT	Whether to track links only in Plain text emails.

Method Summary

Modifier and Type	Method	Description
static TrackLinks	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TrackLinks[]	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

HTML

public static final TrackLinks HTML

Whether to track links only in HTML emails.

TEXT

public static final TrackLinks TEXT

Whether to track links only in Plain text emails.

HTML_AND_TEXT

public static final TrackLinks HTML_AND_TEXT

Whether to track links in HTML and Plain text emails.

DO_NOT_TRACK

public static final TrackLinks DO_NOT_TRACK

Whether email links should not be tracked neither in HTML nor in plain text emails.

Method Details

values

public static TrackLinks[] 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 TrackLinks 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