io.commercetools.sunrise.email.smtp

Enum SmtpConfiguration.TransportSecurity

java.lang.Object

java.lang.Enum<SmtpConfiguration.TransportSecurity>

io.commercetools.sunrise.email.smtp.SmtpConfiguration.TransportSecurity

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SmtpConfiguration.TransportSecurity>

Enclosing class:

SmtpConfiguration

public static enum SmtpConfiguration.TransportSecurity
extends java.lang.Enum<SmtpConfiguration.TransportSecurity>

How to secure the connection to an SMTP server.

Enum Constant Summary

Enum Constants

Enum Constant and Description
None This mode shall only be used for automatic tests.
SSL_TLS The connection will be established using SSL/TLS right from the start.
STARTTLS A plain-text connection will be established and be switched to TLS.

Method Summary

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

None

public static final SmtpConfiguration.TransportSecurity None

This mode shall only be used for automatic tests. A plain-text connection will be used to communicate to the server.

SSL_TLS

public static final SmtpConfiguration.TransportSecurity SSL_TLS

The connection will be established using SSL/TLS right from the start. If this mode is used, the SMTP client needs to be configured to connect to the dedicated port at which the server listens for SSL/TLS connections.

STARTTLS

public static final SmtpConfiguration.TransportSecurity STARTTLS

A plain-text connection will be established and be switched to TLS. SMTP servers supporting this mode listen on a single port only instead of opening a second secured port like in the case of SSL_TLS. An SMTP client using this transport security should require the switch to TLS and should not continue if the plain-text connection cannot be switched to TLS.

Method Detail

values

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

Returns:

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

valueOf

public static SmtpConfiguration.TransportSecurity valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null