Package com.icegreen.greenmail.util

Class PropertiesBasedServerSetupBuilder

java.lang.Object

com.icegreen.greenmail.util.PropertiesBasedServerSetupBuilder

public class PropertiesBasedServerSetupBuilder
extends Object

Creates a GreenMail server setup configuration based on System properties.

Default setups using well-known ports:

• greenmail.setup.all : ServerSetup.ALL
• greenmail.setup.smtp : ServerSetup.SMTP
• greenmail.setup.smtps : ServerSetup.SMTPS
• greenmail.setup.imap : ServerSetup.IMAP
• greenmail.setup.imaps : ServerSetup.IMAPS
• greenmail.setup.pop3 : ServerSetup.POP3
• greenmail.setup.pop3s : ServerSetup.POP3S

Default test setups with added offsets to well-known ports:

• greenmail.setup.test.all : ServerSetupTest.ALL
• greenmail.setup.test.smtp : ServerSetupTest.SMTP
• greenmail.setup.test.smtps : ServerSetupTest.SMTPS
• greenmail.setup.test.imap : ServerSetupTest.IMAP
• greenmail.setup.test.imaps : ServerSetupTest.IMAPS
• greenmail.setup.test.pop3 : ServerSetupTest.POP3
• greenmail.setup.test.pop3s : ServerSetupTest.POP3S

Protocol specific setups

Replace PROTOCOL with a value from ServerSetup.PROTOCOLS:

• greenmail.PROTOCOL.port
• greenmail.PROTOCOL.hostname (defaults to ServerSetup.getLocalHostAddress()

General settings

• greenmail.startup.timeout : timeout for server startup (defaults to ServerSetup.SERVER_STARTUP_TIMEOUT<
• greenmail.hostname : The default hostname to bind to, eg localhost or 0.0.0.0
• greenmail.verbose : Enables verbose mode including debug output

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GREENMAIL_HOSTNAME
static final String	GREENMAIL_SETUP_ALL
static final String	GREENMAIL_SETUP_TEST_ALL
static final String	GREENMAIL_VERBOSE	Enables verbose JavaMail debug output by setting JavaMail 'mail.debug' property.

Constructor Summary

Constructors

Constructor	Description
PropertiesBasedServerSetupBuilder()

Method Summary

Modifier and Type	Method	Description
protected void	addDefaultSetups(String hostname, Properties properties, List<ServerSetup> serverSetups)
protected void	addSetup(String hostname, String protocol, Properties properties, List<ServerSetup> serverSetups)
protected void	addTestSetups(String hostname, Properties properties, List<ServerSetup> serverSetups)
ServerSetup[]	build(Properties properties)	Creates a server setup based on provided properties.

Methods inherited from class java.lang.Object

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

Field Details

GREENMAIL_VERBOSE

public static final String GREENMAIL_VERBOSE

Enables verbose JavaMail debug output by setting JavaMail 'mail.debug' property.

See Also:

• Constant Field Values

GREENMAIL_SETUP_ALL

public static final String GREENMAIL_SETUP_ALL

See Also:

• Constant Field Values

GREENMAIL_SETUP_TEST_ALL

public static final String GREENMAIL_SETUP_TEST_ALL

See Also:

• Constant Field Values

GREENMAIL_HOSTNAME

public static final String GREENMAIL_HOSTNAME

See Also:

• Constant Field Values

Constructor Details

PropertiesBasedServerSetupBuilder

public PropertiesBasedServerSetupBuilder()

Method Details

build

public ServerSetup[] build(Properties properties)

Creates a server setup based on provided properties.

Parameters:

properties - the properties.

Returns:

the server setup, or an empty array.

addSetup

protected void addSetup(String hostname,
 String protocol,
 Properties properties,
 List<ServerSetup> serverSetups)

addTestSetups

protected void addTestSetups(String hostname,
 Properties properties,
 List<ServerSetup> serverSetups)

addDefaultSetups

protected void addDefaultSetups(String hostname,
 Properties properties,
 List<ServerSetup> serverSetups)