org.mule.extension.email.internal.mailbox

Class MailboxConnection

java.lang.Object

org.mule.extension.email.internal.AbstractEmailConnection

org.mule.extension.email.internal.mailbox.MailboxConnection

public class MailboxConnection
extends AbstractEmailConnection

A connection with a mail server for retrieving and managing emails from an specific folder in a mailbox.

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

Method Summary

Modifier and Type	Method and Description
void	closeFolder(boolean expunge) Closes the current connection folder.
void	disconnect() disconnects the internal client used by the AbstractEmailConnection instance.
javax.mail.Folder	getFolder(String mailBoxFolder, int openMode) Opens and return the email Folder of name mailBoxFolder.
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

MailboxConnection

public MailboxConnection(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 of the MailboxConnection secured by TLS.

Parameters:

protocol - the desired protocol to use. One of imap or pop3 (and its secure versions)

username - the username to establish the connection.

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 - additional custom properties.

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

Throws:

EmailConnectionException

MailboxConnection

public MailboxConnection(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 of the of the MailboxConnection.

Parameters:

protocol - the desired protocol to use. One of imap or pop3 (and its secure versions)

username - the username to establish the connection.

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 - additional custom properties.

Throws:

EmailConnectionException

Method Detail

getFolder

public javax.mail.Folder getFolder(String mailBoxFolder,
                                   int openMode)

Opens and return the email Folder of name mailBoxFolder. The folder can contain Messages, other Folders or both.

If there was an already opened folder and a different one is requested the opened folder will be closed and the new one will be opened.

Parameters:

mailBoxFolder - the name of the folder to be opened.

openMode - open the folder in READ_ONLY or READ_WRITE mode

Returns:

the opened Folder

closeFolder

public void closeFolder(boolean expunge)

Closes the current connection folder.

Parameters:

expunge - whether to remove all the emails marked as DELETED.

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.

Specified by:

validate in class AbstractEmailConnection

Returns:

a ConnectionValidationResult indicating if the connection is valid or not.