com.stc.connector.emailadapter.appconn
Interface EmailClientApplication

All Known Implementing Classes:

EmailClientApplicationImpl

public interface EmailClientApplication

Email Application interface.

Version:

$Versiion$

Author:

$Author: jtran $

Method Summary

EmailConfiguration	getEmailConfiguration() Get the EmailConfiguration object for setting Email connection information.
EmailMessage	getEmailMessage() Get the EmailMessage instance.
boolean	hasMessage() Determines whether there are any message(s) to be received.
void	receiveMessage() Receives the next email message.
void	reset() Initializes the email configuration to the default configuration and initializes the email message to an empty message.
void	sendMessage() Sends the email message set in the EmailMessage.

Method Detail

getEmailMessage

EmailMessage getEmailMessage()
                             throws EmailApplicationException

Get the EmailMessage instance. In the case of sending a message, the EmailMessage can be used to populate the email message for delivery. In the case of receiving email message(s), the EmailMessage contains the current email message received.

Returns:

An EmailMessage object for populating data in an email message for delivery or for reading the current email message received.

Throws:

EmailApplicationException - upon error.

getEmailConfiguration

EmailConfiguration getEmailConfiguration()
                                         throws EmailApplicationException

Get the EmailConfiguration object for setting Email connection information.

Returns:

An EmailConfiguration object for populating Email connection information.

Throws:

EmailApplicationException - upon error.

sendMessage

void sendMessage()
                 throws EmailApplicationException

Sends the email message set in the EmailMessage.

Throws:

EmailApplicationException - upon error.

See Also:

getEmailMessage()

receiveMessage

void receiveMessage()
                    throws EmailApplicationException

Receives the next email message. The email message received is in the EmailMessage.

Throws:

EmailApplicationException - upon error.

See Also:

#getEmailMessage.

hasMessage

boolean hasMessage()
                   throws EmailApplicationException

Determines whether there are any message(s) to be received.

Parameters:

configuration - The EmailConfiguration instance containing connection specific information.

Returns:

If there are messages to be read then true will be returned; otherwise, false will be returned.

Throws:

EmailApplicationException - upon error.

See Also:

receiveMessage()

reset

void reset()
           throws EmailApplicationException

Initializes the email configuration to the default configuration and initializes the email message to an empty message.

Throws:

EmailApplicationException - upon error.