EmailProtocol (Mule Email Connector 4.0.0-M5.2 API)

java.lang.Object
- java.lang.Enum<EmailProtocol>
- - org.mule.extension.email.internal.EmailProtocol

All Implemented Interfaces:

Serializable, Comparable<EmailProtocol>
```
public enum EmailProtocol
extends Enum<EmailProtocol>
```
Email Protocols supported by the EmailConnector.
Each protocol have a set of properties that need to be configured to establish a connection with a mail server.
The full list of properties available for protocols can be found at:
Since:

4.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`IMAP` represents the Internet Message Access Protocol.
`IMAPS` represents the secured Internet Message Access Protocol.
`POP3` represents the Post Office Protocol.
`POP3S` represents the secured Post Office Protocol.
`SMTP` represents the Simple Mail Transfer Protocol.
`SMTPS` represents the secured Simple Mail Transfer Protocol.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getConnectionTimeoutProperty()` Socket connection timeout value in milliseconds.
`String`	`getHostProperty()` The host name of the mail server.
`String`	`getMailAuthProperty()` Indicates if should attempt to authorize or not.
`String`	`getMailMimeCharsetProperty()` Defines the default mime charset to use when none has been specified for the message.
`String`	`getName()` The name of the protocol.
`String`	`getPortProperty()` The port number of the mail server.
`String`	`getReadTimeoutProperty()` Socket read timeout value in milliseconds.
`String`	`getSocketFactoryFallbackProperty()` Whether to use `Socket` as a fallback if the initial connection fails or not.
`String`	`getSocketFactoryPortProperty()` Specifies the port to connect to when using a socket factory.
`String`	`getSocketFactoryProperty()`
`String`	`getSslCiphersuitesProperty()` Specifies the SSL ciphersuites that will be enabled for SSL connections.
`String`	`getSslEnableProperty()` Specifies if ssl is enabled or not.
`String`	`getSslProtocolsProperty()` Specifies the SSL protocols that will be enabled for SSL connections.
`String`	`getSslTrustProperty()` Specifies the trusted hosts.
`String`	`getStartTlsProperty()` Indicates if the STARTTLS command shall be used to initiate a TLS-secured connection.
`String`	`getTransportProtocolProperty()` Specifies the default transport name.
`String`	`getWriteTimeoutProperty()` Socket write timeout value in milliseconds.
`boolean`	`isSecure()` If the protocol is secure or not.
`static EmailProtocol`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EmailProtocol[]`	`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
  - SMTP
```
public static final EmailProtocol SMTP
```
    represents the Simple Mail Transfer Protocol.
  - SMTPS
```
public static final EmailProtocol SMTPS
```
    represents the secured Simple Mail Transfer Protocol.
  - IMAP
```
public static final EmailProtocol IMAP
```
    represents the Internet Message Access Protocol.
  - IMAPS
```
public static final EmailProtocol IMAPS
```
    represents the secured Internet Message Access Protocol.
  - POP3
```
public static final EmailProtocol POP3
```
    represents the Post Office Protocol.
  - POP3S
```
public static final EmailProtocol POP3S
```
    represents the secured Post Office Protocol.
- Method Detail
  - values
```
public static EmailProtocol[] 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 (EmailProtocol c : EmailProtocol.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EmailProtocol 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
  - getName
```
public String getName()
```
    The name of the protocol.
    
    Returns:
    
    the name of the protocol.
  - isSecure
```
public boolean isSecure()
```
    If the protocol is secure or not.
    
    Returns:
    
    whether a protocol is secured by SSL/TLS or not.
  - getHostProperty
```
public String getHostProperty()
```
    The host name of the mail server.
    
    Returns:
    
    the protocol host name property.
  - getPortProperty
```
public String getPortProperty()
```
    The port number of the mail server.
    
    Returns:
    
    the protocol port property.
  - getMailAuthProperty
```
public String getMailAuthProperty()
```
    Indicates if should attempt to authorize or not. Defaults to false.
    
    Returns:
    
    the protocol mail auth property.
  - getMailMimeCharsetProperty
```
public String getMailMimeCharsetProperty()
```
    Defines the default mime charset to use when none has been specified for the message.
    
    Returns:
    
    the mime charset property.
  - getSocketFactoryFallbackProperty
```
public String getSocketFactoryFallbackProperty()
```
    Whether to use Socket as a fallback if the initial connection fails or not.
    
    Returns:
    
    the protocol socket factory fallback property.
  - getSocketFactoryPortProperty
```
public String getSocketFactoryPortProperty()
```
    Specifies the port to connect to when using a socket factory.
    
    Returns:
    
    the protocol socket factory port property.
  - getSocketFactoryProperty
```
public String getSocketFactoryProperty()
```
    Returns:
    
    the protocol socket factory property.
  - getSslCiphersuitesProperty
```
public String getSslCiphersuitesProperty()
```
    Specifies the SSL ciphersuites that will be enabled for SSL connections.
    
    Returns:
    
    the protocol ssl ciphersuites property.
  - getSslProtocolsProperty
```
public String getSslProtocolsProperty()
```
    Specifies the SSL protocols that will be enabled for SSL connections.
    
    Returns:
    
    the protocol ssl enabled protocols property.
  - getSslEnableProperty
```
public String getSslEnableProperty()
```
    Specifies if ssl is enabled or not.
    
    Returns:
    
    the ssl enable property.
  - getSslTrustProperty
```
public String getSslTrustProperty()
```
    Specifies the trusted hosts.
    
    Returns:
    
    the protocol ssl trust property.
  - getStartTlsProperty
```
public String getStartTlsProperty()
```
    Indicates if the STARTTLS command shall be used to initiate a TLS-secured connection.
    
    Returns:
    
    the protocol start tls property.
  - getTransportProtocolProperty
```
public String getTransportProtocolProperty()
```
    Specifies the default transport name.
    
    Returns:
    
    the protocol name property.
  - getReadTimeoutProperty
```
public String getReadTimeoutProperty()
```
    Socket read timeout value in milliseconds. Default is infinite timeout.
    
    Returns:
    
    the protocol read timeout property.
  - getConnectionTimeoutProperty
```
public String getConnectionTimeoutProperty()
```
    Socket connection timeout value in milliseconds. Default is infinite timeout.
    
    Returns:
    
    the protocol connection timeout property.
  - getWriteTimeoutProperty
```
public String getWriteTimeoutProperty()
```
    Socket write timeout value in milliseconds. Default is infinite timeout.
    
    Returns:
    
    the protocol write timeout property.

Enum EmailProtocol

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SMTP

SMTPS

IMAP

IMAPS

POP3

POP3S

Method Detail

values

valueOf

getName

isSecure

getHostProperty

getPortProperty

getMailAuthProperty

getMailMimeCharsetProperty

getSocketFactoryFallbackProperty

getSocketFactoryPortProperty

getSocketFactoryProperty

getSslCiphersuitesProperty

getSslProtocolsProperty

getSslEnableProperty

getSslTrustProperty

getStartTlsProperty

getTransportProtocolProperty

getReadTimeoutProperty

getConnectionTimeoutProperty

getWriteTimeoutProperty