org.wso2.esb.integration.common.utils

Class MailToTransportUtil

java.lang.Object

org.wso2.esb.integration.common.utils.MailToTransportUtil

public class MailToTransportUtil
extends Object

This Provides utility methods to sending, receiving and verifying emails by reading logs By using javax mail api to send emails and LogViewerClient to read the log

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
MailToTransportUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkDeletedEmail(String emailSubject)
static void	deleteAllUnreadEmailsFromGmail() Delete all unread emails from inbox
static Properties	getSMTPProperties()
static boolean	isMailReceivedBySubject(String emailSubject, String folder) Check a particular email has received to a given email folder by email subject.
static void	readXMLforEmailCredentials() Read automation.xml to set email credentials to relevant variables.
static boolean	searchStringInLog(String backendURL, String stringToFind, String cookie)
static boolean	sendMailAndCheckReceived(String emailSubject) Send email and check email received successfully
static boolean	waitToCheckEmailReceived(String subjectToCheck, String emailFolder) This method wait to check the expected mail subject.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

Constructor Detail

MailToTransportUtil

public MailToTransportUtil()

Method Detail

getSMTPProperties

public static Properties getSMTPProperties()

Returns:

SMTP properties of Gmail server

sendMailAndCheckReceived

public static boolean sendMailAndCheckReceived(String emailSubject)
                                        throws Exception

Send email and check email received successfully

Parameters:

emailSubject - - Massage to send in email

Returns:

Email - Email sent successfully or not

Throws:

Exception - - Error while sending the gmail

isMailReceivedBySubject

public static boolean isMailReceivedBySubject(String emailSubject,
                              String folder)
                                       throws ESBMailTransportIntegrationTestException

Check a particular email has received to a given email folder by email subject.

Parameters:

emailSubject - - Email emailSubject to find email is in inbox or not

Returns:

- found the email or not

Throws:

ESBMailTransportIntegrationTestException - - Is thrown if an error occurred while reading the emails

checkDeletedEmail

public static boolean checkDeletedEmail(String emailSubject)
                                 throws ESBMailTransportIntegrationTestException

Parameters:

emailSubject - - Subject of the email which should be deleted by ESB

Returns:

- Email has deleted successfully or not

Throws:

ESBMailTransportIntegrationTestException - - Is thrown if an error occurred when reading the emails

deleteAllUnreadEmailsFromGmail

public static void deleteAllUnreadEmailsFromGmail()
                                           throws ESBMailTransportIntegrationTestException

Delete all unread emails from inbox

Throws:

ESBMailTransportIntegrationTestException - - Is thrown if an error when deleting the emails

searchStringInLog

public static boolean searchStringInLog(String backendURL,
                        String stringToFind,
                        String cookie)
                                 throws ESBMailTransportIntegrationTestException

Parameters:

backendURL - - server backend URL

stringToFind - - string to find in the logs

cookie - - cookie

Returns:

- found the string or not

Throws:

ESBMailTransportIntegrationTestException - - Is thrown if an error when getting or reading the log.

waitToCheckEmailReceived

public static boolean waitToCheckEmailReceived(String subjectToCheck,
                               String emailFolder)
                                        throws ESBMailTransportIntegrationTestException

This method wait to check the expected mail subject.

Parameters:

subjectToCheck - - Email Subject to check in the inbox

Returns:

boolean - If found the email true , else false

Throws:

InterruptedException - - Error occurred in thread sleep

ESBMailTransportIntegrationTestException - - Is thrown if an error while reading the emails

readXMLforEmailCredentials

public static void readXMLforEmailCredentials()
                                       throws ESBMailTransportIntegrationTestException

Read automation.xml to set email credentials to relevant variables.

Throws:

ESBMailTransportIntegrationTestException