org.mule.extension.email.internal

Class AbstractEmailConnection

java.lang.Object

org.mule.extension.email.internal.AbstractEmailConnection

Direct Known Subclasses:

MailboxConnection, SenderConnection

public abstract class AbstractEmailConnection
extends Object

Generic implementation for an email connection of a connector which operates over the SMTP, IMAP, POP3 and it's secure versions protocols.

Performs the creation of a persistent set of properties that are used to configure the Session instance.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	PASSWORD_NO_USERNAME_ERROR
protected EmailProtocol	protocol
protected javax.mail.Session	session
static String	USERNAME_NO_PASSWORD_ERROR

Constructor Summary

Constructors

Constructor and Description
AbstractEmailConnection(EmailProtocol protocol, String username, String password, String host, String port, long connectionTimeout, long readTimeout, long writeTimeout, Map<String,String> properties) Base constructor for AbstractEmailConnection implementations.
AbstractEmailConnection(EmailProtocol protocol, String username, String password, String host, String port, long connectionTimeout, long readTimeout, long writeTimeout, Map<String,String> properties, org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory) Base constructor for AbstractEmailConnection implementations that aims to be secured by TLS.

Method Summary

Modifier and Type	Method and Description
abstract void	disconnect() disconnects the internal client used by the AbstractEmailConnection instance.
javax.mail.Session	getSession()
abstract org.mule.runtime.api.connection.ConnectionValidationResult	validate() Checks if the current AbstractEmailConnection instance is valid or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PASSWORD_NO_USERNAME_ERROR

public static final String PASSWORD_NO_USERNAME_ERROR

See Also:

Constant Field Values

USERNAME_NO_PASSWORD_ERROR

public static final String USERNAME_NO_PASSWORD_ERROR

See Also:

Constant Field Values

protocol

protected final EmailProtocol protocol

session

protected final javax.mail.Session session

Constructor Detail

AbstractEmailConnection

public AbstractEmailConnection(EmailProtocol protocol,
                               String username,
                               String password,
                               String host,
                               String port,
                               long connectionTimeout,
                               long readTimeout,
                               long writeTimeout,
                               Map<String,String> properties)
                        throws EmailConnectionException

Base constructor for AbstractEmailConnection implementations.

Parameters:

protocol - the protocol used to send mails.

username - the username to establish connection with the mail server.

password - the password corresponding to the username

host - the host name of the mail server.

port - the port number of the mail server.

connectionTimeout - the socket connection timeout

readTimeout - the socket read timeout

writeTimeout - the socket write timeout

properties - the custom properties added to configure the session.

Throws:

EmailConnectionException

AbstractEmailConnection

public AbstractEmailConnection(EmailProtocol protocol,
                               String username,
                               String password,
                               String host,
                               String port,
                               long connectionTimeout,
                               long readTimeout,
                               long writeTimeout,
                               Map<String,String> properties,
                               org.mule.runtime.api.tls.TlsContextFactory tlsContextFactory)
                        throws EmailConnectionException

Base constructor for AbstractEmailConnection implementations that aims to be secured by TLS.

Parameters:

protocol - the protocol used to send mails.

username - the username to establish connection with the mail server.

password - the password corresponding to the username

host - the host name of the mail server.

port - the port number of the mail server.

connectionTimeout - the socket connection timeout

readTimeout - the socket read timeout

writeTimeout - the socket write timeout

properties - the custom properties added to configure the session.

tlsContextFactory - the tls context factory for creating the context to secure the connection

Throws:

EmailConnectionException

Method Detail

getSession

public javax.mail.Session getSession()

Returns:

the email Session used by the connection.

disconnect

public abstract void disconnect()

disconnects the internal client used by the AbstractEmailConnection instance.

validate

public abstract org.mule.runtime.api.connection.ConnectionValidationResult validate()

Checks if the current AbstractEmailConnection instance is valid or not.

Returns:

a ConnectionValidationResult indicating if the connection is valid or not.