Package com.icegreen.greenmail.configuration

Class PropertiesBasedGreenMailConfigurationBuilder

java.lang.Object

com.icegreen.greenmail.configuration.PropertiesBasedGreenMailConfigurationBuilder

public class PropertiesBasedGreenMailConfigurationBuilder
extends Object

Creates GreenMailConfiguration from properties.

Example usage: GreenMailConfiguration config = new PropertyBasedGreenMailConfigurationBuilder().build(System.getProperties());

• greenmail.users : List of comma separated users of format login:pwd[@domain][,login:pwd[@domain]]

  Example: user1:pwd1@localhost,user2:pwd2@0.0.0.0

  Note: domain part must be DNS resolvable!

• greenmail.users.login : Overrides the login for authentication

  By default use the local-part of an email. Can be changed to full email.

• greenmail.preload.dir : Preloads emails from filesystem (see GreenMailOperations.loadEmails(Path) for expected structure)

Field Summary

Fields

Modifier and Type	Field	Description
static String	GREENMAIL_AUTH_DISABLED	Disables authentication check.
static String	GREENMAIL_PRELOAD_DIR
static String	GREENMAIL_SIEVE_IGNORE_DETAIL
static String	GREENMAIL_USERS	Property for list of users.
static String	GREENMAIL_USERS_LOGIN	Overrides the login for authentication for configured users (@see GREENMAIL_USERS).

Constructor Summary

Constructors

Constructor	Description
PropertiesBasedGreenMailConfigurationBuilder()

Method Summary

Modifier and Type	Method	Description
GreenMailConfiguration	build(Properties properties)	Builds a configuration object based on given properties.
protected String	buildEmailLogin(String localPart, String domain)
protected String	buildLocalPartLogin(String localPart, String domain)
protected void	extractAndAddUser(GreenMailConfiguration configuration, BinaryOperator<String> buildLogin, String user)

Methods inherited from class java.lang.Object

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

Field Detail

GREENMAIL_USERS

public static final String GREENMAIL_USERS

Property for list of users.

See Also:

Constant Field Values

GREENMAIL_USERS_LOGIN

public static final String GREENMAIL_USERS_LOGIN

Overrides the login for authentication for configured users (@see GREENMAIL_USERS).

By default, use the local-part of an email and can be changed to full email (@see UsersLoginConfigurationType.EMAIL).

See Also:

Constant Field Values

GREENMAIL_AUTH_DISABLED

public static final String GREENMAIL_AUTH_DISABLED

Disables authentication check.

See Also:

GreenMailConfiguration.withDisabledAuthentication(), Constant Field Values

GREENMAIL_SIEVE_IGNORE_DETAIL

public static final String GREENMAIL_SIEVE_IGNORE_DETAIL

See Also:

Constant Field Values

GREENMAIL_PRELOAD_DIR

public static final String GREENMAIL_PRELOAD_DIR

See Also:

Constant Field Values

Constructor Detail

PropertiesBasedGreenMailConfigurationBuilder

public PropertiesBasedGreenMailConfigurationBuilder()

Method Detail

build

public GreenMailConfiguration build(Properties properties)

Builds a configuration object based on given properties.

Parameters:

properties - the properties.

Returns:

a configuration and never null.

buildEmailLogin

protected String buildEmailLogin(String localPart,
                                 String domain)

buildLocalPartLogin

protected String buildLocalPartLogin(String localPart,
                                     String domain)

extractAndAddUser

protected void extractAndAddUser(GreenMailConfiguration configuration,
                                 BinaryOperator<String> buildLogin,
                                 String user)