com.icegreen.greenmail.util

Class GreenMail

java.lang.Object

com.icegreen.greenmail.util.GreenMail

All Implemented Interfaces:

GreenMailOperations

public class GreenMail
extends Object
implements GreenMailOperations

Utility class that manages a greenmail server with support for multiple protocols

Constructor Summary

Constructors

Constructor and Description
GreenMail() Creates a SMTP, SMTPS, POP3, POP3S, IMAP, and IMAPS server binding onto non-default ports.
GreenMail(ServerSetup config) Call this constructor if you want to run one of the email servers only
GreenMail(ServerSetup[] config) Call this constructor if you want to run more than one of the email servers

Method Summary

Methods

Modifier and Type	Method and Description
ImapServer	getImap()
ImapServer	getImaps()
Managers	getManagers()
Pop3Server	getPop3()
Pop3Server	getPop3s()
javax.mail.internet.MimeMessage[]	getReceivedMessages()
javax.mail.internet.MimeMessage[]	getReceviedMessagesForDomain(String domain) This method can be used as an easy 'catch-all' mechanism.
SmtpServer	getSmtp()
SmtpServer	getSmtps()
void	reset() Restart the GreenMail server.
void	setQuotaSupported(boolean isEnabled) Toggles the IMAP quota support.
GreenMailUser	setUser(String login, String password) Sets the password for the account linked to email.
GreenMailUser	setUser(String email, String login, String password) Sets the password for the account linked to email.
void	setUsers(Properties users) Sets up accounts with password based on a properties map where the key is the email/login and the value the password
void	start() Start the GreenMail server
void	stop() Stop the GreenMail server.
GreenMailUtil	util()
boolean	waitForIncomingEmail(int emailCount) Does the same thing as #wait(long, int) but with a timeout of 5000ms
boolean	waitForIncomingEmail(long timeout, int emailCount) Use this method if you are sending email in a different thread from the one you're testing from.

Methods inherited from class java.lang.Object

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

Constructor Detail

GreenMail

public GreenMail()

Creates a SMTP, SMTPS, POP3, POP3S, IMAP, and IMAPS server binding onto non-default ports. The ports numbers are defined in ServerSetupTest

GreenMail

public GreenMail(ServerSetup config)

Call this constructor if you want to run one of the email servers only

Parameters:

config -

GreenMail

public GreenMail(ServerSetup[] config)

Call this constructor if you want to run more than one of the email servers

Parameters:

config -

Method Detail

start

public void start()

Description copied from interface: GreenMailOperations

Start the GreenMail server

Specified by:

start in interface GreenMailOperations

stop

public void stop()

Description copied from interface: GreenMailOperations

Stop the GreenMail server. Clear all data (send messages, users, ...).

Specified by:

stop in interface GreenMailOperations

reset

public void reset()

Description copied from interface: GreenMailOperations

Restart the GreenMail server. Clear all data (send messages, users, ...)

Specified by:

reset in interface GreenMailOperations

getSmtp

public SmtpServer getSmtp()

Specified by:

getSmtp in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getImap

public ImapServer getImap()

Specified by:

getImap in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getPop3

public Pop3Server getPop3()

Specified by:

getPop3 in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getSmtps

public SmtpServer getSmtps()

Specified by:

getSmtps in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getImaps

public ImapServer getImaps()

Specified by:

getImaps in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getPop3s

public Pop3Server getPop3s()

Specified by:

getPop3s in interface GreenMailOperations

Returns:

SMTP server operated by this GreenMail instance or null if there is none

getManagers

public Managers getManagers()

Specified by:

getManagers in interface GreenMailOperations

Returns:

Greenmail protocol managers

waitForIncomingEmail

public boolean waitForIncomingEmail(long timeout,
                           int emailCount)

Description copied from interface: GreenMailOperations

Use this method if you are sending email in a different thread from the one you're testing from. Block waits for an email to arrive in any mailbox for any user. Implementation Detail: No polling wait implementation

Specified by:

waitForIncomingEmail in interface GreenMailOperations

Parameters:

timeout - maximum time in ms to wait for emailCount of messages to arrive before giving up and returning false

emailCount - waits for these many emails to arrive before returning

Returns:

Returns false if timeout period was reached, otherwise true.

waitForIncomingEmail

public boolean waitForIncomingEmail(int emailCount)

Description copied from interface: GreenMailOperations

Does the same thing as #wait(long, int) but with a timeout of 5000ms

Specified by:

waitForIncomingEmail in interface GreenMailOperations

Parameters:

emailCount - waits for these many emails to arrive before returning

Returns:

Returns false if timeout period was reached, otherwise true.

getReceivedMessages

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

Specified by:

getReceivedMessages in interface GreenMailOperations

Returns:

Returns all messags in all folders for all users GreenMailUtil has a bunch of static helper methods to extract body text etc.

getReceviedMessagesForDomain

public javax.mail.internet.MimeMessage[] getReceviedMessagesForDomain(String domain)

Description copied from interface: GreenMailOperations

This method can be used as an easy 'catch-all' mechanism.

Specified by:

getReceviedMessagesForDomain in interface GreenMailOperations

Parameters:

domain - returns all receved messages arrived to domain.

setUser

public GreenMailUser setUser(String login,
                    String password)

Description copied from interface: GreenMailOperations

Sets the password for the account linked to email. If no account exits, one is automatically created when an email is received The automatically created account has the account login and password equal to the email address.

Specified by:

setUser in interface GreenMailOperations

Parameters:

login - Login for which the password should be set. This is assumed to be the same as the email address.

password - New password

setUser

public GreenMailUser setUser(String email,
                    String login,
                    String password)

Description copied from interface: GreenMailOperations

Sets the password for the account linked to email. If no account exits, one is automatically created when an email is received The automatically created account has the account login and password equal to the email address.

Specified by:

setUser in interface GreenMailOperations

Parameters:

email - Email address for which the password should be set

login - Login name for login. This may be different to the email address. E.g. the email address could be "info@localhost", the login could be "info".

password - New password

setQuotaSupported

public void setQuotaSupported(boolean isEnabled)

Description copied from interface: GreenMailOperations

Toggles the IMAP quota support. Quotas are enabled by default.

Specified by:

setQuotaSupported in interface GreenMailOperations

Parameters:

isEnabled - true, if quotas should be supported.

setUsers

public void setUsers(Properties users)

Description copied from interface: GreenMailOperations

Sets up accounts with password based on a properties map where the key is the email/login and the value the password

Specified by:

setUsers in interface GreenMailOperations

Parameters:

users - User/password map

util

public GreenMailUtil util()