Package africa.sendbyte.apikeys

Enum KeyMode

java.lang.Object

java.lang.Enum<KeyMode>

africa.sendbyte.apikeys.KeyMode

All Implemented Interfaces:

Serializable, Comparable<KeyMode>, java.lang.constant.Constable

public enum KeyMode
extends Enum<KeyMode>

The environment mode of an API key.

Use fromWire(String) to parse defensively; unknown values map to UNKNOWN rather than throwing.

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
LIVE	Sends real email.
TEST	Sandbox mode; fully simulated delivery, no domain required.
UNKNOWN

Method Summary

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

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

LIVE

public static final KeyMode LIVE

Sends real email. Requires a verified sending domain. Keys are prefixed sk_live_.

TEST

public static final KeyMode TEST

Sandbox mode; fully simulated delivery, no domain required. Keys are prefixed sk_test_.

UNKNOWN

public static final KeyMode UNKNOWN

Method Details

values

public static KeyMode[] values()

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

Returns:

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

valueOf

public static KeyMode 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

wire

public String wire()

fromWire

public static KeyMode fromWire(String value)