Package com.icegreen.greenmail.configuration

Class GreenMailConfiguration

java.lang.Object

com.icegreen.greenmail.configuration.GreenMailConfiguration

public class GreenMailConfiguration
extends Object

Properties that can be defined to configure a GreenMail instance or GreenMailRule.

Constructor Summary

Constructors

Constructor	Description
GreenMailConfiguration()

Method Summary

Modifier and Type	Method	Description
static GreenMailConfiguration	aConfig()
String	getPreloadDir()	Gets preload directory value or null if not set.
List<UserBean>	getUsersToCreate()
boolean	hasPreloadDir()	Checks if preload directory value exists.
boolean	isAuthenticationDisabled()
boolean	isSieveIgnoreDetailEnabled()
GreenMailConfiguration	withDisabledAuthentication()	Disables authentication.
GreenMailConfiguration	withPreloadDir(String preloadDir)	Configures directory path for preloading emails from filesystem.
GreenMailConfiguration	withSieveIgnoreDetail()	Enables Sieve detail handling, also known as RFC 5233 sub-address extension.
GreenMailConfiguration	withUser(String login, String password)	The given GreenMailUser will be created when servers will start.
GreenMailConfiguration	withUser(String email, String login, String password)	The given GreenMailUser will be created when servers will start.

Methods inherited from class java.lang.Object

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

Constructor Detail

GreenMailConfiguration

public GreenMailConfiguration()

Method Detail

withUser

public GreenMailConfiguration withUser(String login,
                                       String password)

The given GreenMailUser will be created when servers will start.

Parameters:

login - User id and email address

password - Password of user that belongs to login name

Returns:

Modified configuration

withUser

public GreenMailConfiguration withUser(String email,
                                       String login,
                                       String password)

The given GreenMailUser will be created when servers will start.

Parameters:

email - Email address

login - Login name of user

password - Password of user that belongs to login name

Returns:

Modified configuration

aConfig

public static GreenMailConfiguration aConfig()

Returns:

New GreenMail configuration

getUsersToCreate

public List<UserBean> getUsersToCreate()

Returns:

Users that should be created on server startup

withDisabledAuthentication

public GreenMailConfiguration withDisabledAuthentication()

Disables authentication.

Useful if you want to avoid setting up users up front.

Returns:

Modified configuration.

isAuthenticationDisabled

public boolean isAuthenticationDisabled()

Returns:

true, if authentication is disabled.

See Also:

withDisabledAuthentication()

withSieveIgnoreDetail

public GreenMailConfiguration withSieveIgnoreDetail()

Enables Sieve detail handling, also known as RFC 5233 sub-address extension.

Returns:

Modified configuration.

isSieveIgnoreDetailEnabled

public boolean isSieveIgnoreDetailEnabled()

Returns:

true, if Sieve detail handling is enabled.

See Also:

()

withPreloadDir

public GreenMailConfiguration withPreloadDir(String preloadDir)

Configures directory path for preloading emails from filesystem.

Parameters:

preloadDir - directory containing emails

Returns:

Modified configuration.

See Also:

GreenMailOperations.loadEmails(Path)

getPreloadDir

public String getPreloadDir()

Gets preload directory value or null if not set.

Returns:

the directory

hasPreloadDir

public boolean hasPreloadDir()

Checks if preload directory value exists.

Returns:

true if available