org.mule.extension.email.internal.sender

Class SenderConnection

java.lang.Object

org.mule.extension.email.internal.AbstractEmailConnection

org.mule.extension.email.internal.sender.SenderConnection

public final class SenderConnection
extends AbstractEmailConnection

A connection with a mail server for sending emails.

Since:

4.0

Field Summary

Fields inherited from class org.mule.extension.email.internal.AbstractEmailConnection

PASSWORD_NO_USERNAME_ERROR, protocol, session, USERNAME_NO_PASSWORD_ERROR

Constructor Summary

Constructors

Constructor and Description
SenderConnection(EmailProtocol protocol, String username, String password, String host, String port, long connectionTimeout, long readTimeout, long writeTimeout, Map<String,String> properties) Creates a new instance.
SenderConnection(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) Creates a new instance of the connection secured by TLS.

Method Summary

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

Methods inherited from class org.mule.extension.email.internal.AbstractEmailConnection

getSession

Methods inherited from class java.lang.Object

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

Constructor Detail

SenderConnection

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

Creates a new instance.

Parameters:

protocol - the protocol used to send mails. Smtp or smtps

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

SenderConnection

public SenderConnection(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

Creates a new instance of the connection secured by TLS.

Parameters:

protocol - the protocol used to send mails. Smtp or smtps

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

disconnect

public void disconnect()

disconnects the internal client used by the AbstractEmailConnection instance.

Specified by:

disconnect in class AbstractEmailConnection

validate

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

Checks if the current AbstractEmailConnection instance is valid or not.

if the SenderConnection instance exists, then the validation will always be successful

Specified by:

validate in class AbstractEmailConnection

Returns:

a ConnectionValidationResult indicating if the connection is valid or not.