SmtpSecurity (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<SmtpSecurity>
- - org.cyclos.model.system.configurations.SmtpSecurity

All Implemented Interfaces:

Serializable, Comparable<SmtpSecurity>, HasMessageKey
```
public enum SmtpSecurity
extends Enum<SmtpSecurity>
implements HasMessageKey
```
Security protocol used for SMTP connections

Enum Constant Summary

Enum Constants
Enum Constant Description

NONE
An unencrypted connection will be used

SSL
Use the SSL protocol

STARTTLS
Use the STARTTLS protocol

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`static SmtpSecurity`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SmtpSecurity[]`	`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 SmtpSecurity NONE
```
    An unencrypted connection will be used
  - STARTTLS
```
public static final SmtpSecurity STARTTLS
```
    Use the STARTTLS protocol
  - SSL
```
public static final SmtpSecurity SSL
```
    Use the SSL protocol
- Method Detail
  - values
```
public static SmtpSecurity[] 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 (SmtpSecurity c : SmtpSecurity.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SmtpSecurity 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
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey