com.atlassian.confluence.it.mail
Class MailServices

java.lang.Object
  com.atlassian.confluence.it.mail.MailServices

public class MailServices
extends java.lang.Object

This class provides mail services like POP3 and SMTP for the acceptance tests. It will try to find free TCP/IP ports for the services within a given range.

Constructor Summary

MailServices(int portRangeStart, int portRangeEnd, java.lang.String hostName)

Method Summary

void	addUser(MailUser user)
void	addUser(java.lang.String email, java.lang.String login, java.lang.String password) Adds a user to the mail service.
void	addUser(User user) Adds a user to the mail service.
java.lang.String	getHostName()
int	getPop3Port()
int	getPort(java.lang.String protocol)
javax.mail.internet.MimeMessage	getReceivedMessage() Get the first message of all messages received until now.
javax.mail.internet.MimeMessage[]	getReceivedMessages() Returns an array of all messages received until now.
int	getSmtpPort()
boolean	isRunning() Returns true if the mail servers are running.
void	removeAllReceivedMessages() Removes all received mails.
void	sendMimeMessage(java.io.InputStream messageStream) Sends an email based on a MimeMessage input stream, most likely read from a file.
void	sendTextMessage(java.lang.String to, java.lang.String from, java.lang.String subject, java.lang.String body) Sends an email with the content type "text/plain" and the given contents using the test SMTP server.
void	start() Tries to start a SMTP and a POP3 server on any free port in the range given in the constructor.
void	stop() Stops the SMTP and POP3 server.
javax.mail.internet.MimeMessage	waitAndGetReceivedMessage() Does the same as getReceivedMessage() but waits until a message is received or until a timeout is reached.
javax.mail.internet.MimeMessage[]	waitAndGetReceivedMessages(int numMessages) Does the same as getReceivedMessages() but waits until a message is received or until a timeout is reached.
javax.mail.internet.MimeMessage[]	waitAndGetReceivedMessages(long timeout, int numMessages) Does the same as getReceivedMessages() but waits until a message is received or until specified timeout is reached.
boolean	waitForIncomingMessage(int numberOfMessages) Wait until the specified number of mails is received or until a timeout is reached.
boolean	waitForIncomingMessage(java.lang.Long timeout, int numberOfMessages) Wait until the specified number of mails is received or until specified timeout is reached.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailServices

public MailServices(int portRangeStart,
                    int portRangeEnd,
                    java.lang.String hostName)

Method Detail

start

public void start()
           throws java.net.BindException

Tries to start a SMTP and a POP3 server on any free port in the range given in the constructor.

Throws:

java.net.BindException - if there is no free port available in the given range

stop

public void stop()

Stops the SMTP and POP3 server.

isRunning

public boolean isRunning()

Returns true if the mail servers are running.

addUser

public void addUser(java.lang.String email,
                    java.lang.String login,
                    java.lang.String password)

Adds a user to the mail service. The SMTP server will then accept incoming mails for email and you can fetch these mails via POP3 using login/password for authentication.

Parameters:

email - email of the user to be created

login - login of the user to be created

password - password of the user to be created

addUser

public void addUser(User user)

Adds a user to the mail service. The SMTP server will then accept incoming mails for email and you can fetch these mails via POP3 using login/password for authentication.

Parameters:

user - the user to be created - only the email and password fields are needed

addUser

public void addUser(MailUser user)

getHostName

public java.lang.String getHostName()

Returns:

the host name the mail services are bound to

getPop3Port

public int getPop3Port()

Returns:

the port the POP3 server is bound to

getSmtpPort

public int getSmtpPort()

Returns:

the port the SMTP server is bound to

getPort

public int getPort(java.lang.String protocol)

Parameters:

protocol - the name of the protocol you want the port number (like "pop3", "pop3s", "smtp", "smtps", "imap", "imaps"...)

Returns:

the port number, -1 if protocol is unknown

sendTextMessage

public void sendTextMessage(java.lang.String to,
                            java.lang.String from,
                            java.lang.String subject,
                            java.lang.String body)

Sends an email with the content type "text/plain" and the given contents using the test SMTP server.

Parameters:

to - email address this mail should be sent to

from - email address this mail should appear to be sent from

subject - subject of the email

body - body of the email

sendMimeMessage

public void sendMimeMessage(java.io.InputStream messageStream)

Sends an email based on a MimeMessage input stream, most likely read from a file.

Parameters:

messageStream - input stream of the Mime message to send

getReceivedMessages

public javax.mail.internet.MimeMessage[] getReceivedMessages()

Returns an array of all messages received until now.

Returns:

all received messages

getReceivedMessage

public javax.mail.internet.MimeMessage getReceivedMessage()

Get the first message of all messages received until now.

Returns:

the first message received as MimeMessage or null if there was no message received

waitAndGetReceivedMessage

public javax.mail.internet.MimeMessage waitAndGetReceivedMessage()

Does the same as getReceivedMessage() but waits until a message is received or until a timeout is reached.

Returns:

the first message received as MimeMessage or null if there was no message received

Throws:

java.lang.InterruptedException

waitAndGetReceivedMessages

public javax.mail.internet.MimeMessage[] waitAndGetReceivedMessages(int numMessages)

Does the same as getReceivedMessages() but waits until a message is received or until a timeout is reached.

Returns:

the first message received as MimeMessage or null if there was no message received

Throws:

java.lang.InterruptedException

waitAndGetReceivedMessages

public javax.mail.internet.MimeMessage[] waitAndGetReceivedMessages(long timeout,
                                                                    int numMessages)

Does the same as getReceivedMessages() but waits until a message is received or until specified timeout is reached.

Returns:

the first message received as MimeMessage or null if there was no message received

Throws:

java.lang.InterruptedException

removeAllReceivedMessages

public void removeAllReceivedMessages()
                               throws com.icegreen.greenmail.store.FolderException

Removes all received mails.

Throws:

com.icegreen.greenmail.store.FolderException

waitForIncomingMessage

public boolean waitForIncomingMessage(int numberOfMessages)

Wait until the specified number of mails is received or until a timeout is reached.

Returns:

Returns false if timeout period was reached, otherwise true.

waitForIncomingMessage

public boolean waitForIncomingMessage(java.lang.Long timeout,
                                      int numberOfMessages)

Wait until the specified number of mails is received or until specified timeout is reached.

Returns:

Returns false if timeout period was reached, otherwise true.