com.mailchimp.domain

Enum SubscribeStatus

java.lang.Object

java.lang.Enum<SubscribeStatus>

com.mailchimp.domain.SubscribeStatus

All Implemented Interfaces:

Serializable, Comparable<SubscribeStatus>

public enum SubscribeStatus
extends Enum<SubscribeStatus>

Explanation and usage of the possible values: Mail Chimp status usage

Author:

Ed Bras

Enum Constant Summary

Enum Constants

Enum Constant and Description
cleaned Used to archive a subscriber.
pending Used for double opt-in.
subscribed
unsubscribed Used to archive a subscriber.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

subscribed

public static final SubscribeStatus subscribed

unsubscribed

public static final SubscribeStatus unsubscribed

Used to archive a subscriber.

pending

public static final SubscribeStatus pending

Used for double opt-in. The subscriber will receive an email to confirm his subscription.
Subscribing a subscriber with the same email address, will result in an http 400 error indicating that the user already exists. As such, he will not receive a confirmation email again.

cleaned

public static final SubscribeStatus cleaned

Used to archive a subscriber.

Method Detail

values

public static SubscribeStatus[] 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 (SubscribeStatus c : SubscribeStatus.values())
    System.out.println(c);

Returns:

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

valueOf

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