org.simplejavamail.config

Class ConfigLoader

java.lang.Object

org.simplejavamail.config.ConfigLoader

public final class ConfigLoader
extends Object

Contains list of possible properties names and can produce a map of property values, if provided as file "simplejavamail.properties" on the classpath or as environment property.

The following properties are allowed:

• simplejavamail.javaxmail.debug
• simplejavamail.transportstrategy
• simplejavamail.smtp.host
• simplejavamail.smtp.port
• simplejavamail.smtp.username
• simplejavamail.smtp.password
• simplejavamail.custom.sslfactory.class
• simplejavamail.proxy.host
• simplejavamail.proxy.port
• simplejavamail.proxy.username
• simplejavamail.proxy.password
• simplejavamail.proxy.socks5bridge.port
• simplejavamail.defaults.content.transfer.encoding
• simplejavamail.defaults.subject
• simplejavamail.defaults.from.name
• simplejavamail.defaults.from.address
• simplejavamail.defaults.replyto.name
• simplejavamail.defaults.replyto.address
• simplejavamail.defaults.bounceto.name
• simplejavamail.defaults.bounceto.address
• simplejavamail.defaults.to.name
• simplejavamail.defaults.to.address
• simplejavamail.defaults.cc.name
• simplejavamail.defaults.cc.address
• simplejavamail.defaults.bcc.name
• simplejavamail.defaults.bcc.address
• simplejavamail.defaults.poolsize
• simplejavamail.defaults.poolsize.keepalivetime
• simplejavamail.defaults.connectionpool.clusterkey.uuid
• simplejavamail.defaults.connectionpool.coresize
• simplejavamail.defaults.connectionpool.maxsize
• simplejavamail.defaults.connectionpool.claimtimeout.millis
• simplejavamail.defaults.connectionpool.expireafter.millis
• simplejavamail.defaults.connectionpool.loadbalancing.strategy
• simplejavamail.defaults.sessiontimeoutmillis
• simplejavamail.defaults.trustallhosts
• simplejavamail.defaults.trustedhosts
• simplejavamail.defaults.verifyserveridentity
• simplejavamail.transport.mode.logging.only
• simplejavamail.opportunistic.tls
• simplejavamail.smime.signing.keystore
• simplejavamail.smime.signing.keystore_password
• simplejavamail.smime.signing.key_alias
• simplejavamail.smime.signing.key_password
• simplejavamail.smime.encryption.certificate
• simplejavamail.embeddedimages.dynamicresolution.enable.dir
• simplejavamail.embeddedimages.dynamicresolution.enable.url
• simplejavamail.embeddedimages.dynamicresolution.enable.classpath
• simplejavamail.embeddedimages.dynamicresolution.base.dir
• simplejavamail.embeddedimages.dynamicresolution.base.url
• simplejavamail.embeddedimages.dynamicresolution.base.classpath
• simplejavamail.embeddedimages.dynamicresolution.outside.base.dir
• simplejavamail.embeddedimages.dynamicresolution.outside.base.classpath
• simplejavamail.embeddedimages.dynamicresolution.outside.base.url
• simplejavamail.embeddedimages.dynamicresolution.mustbesuccesful

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigLoader.Property List of all the properties recognized by Simple Java Mail.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILENAME By default, the optional file "simplejavamail.properties" will be loaded from classpath to load initial defaults.

Method Summary

Modifier and Type	Method and Description
static @Nullable Boolean	getBooleanProperty(ConfigLoader.Property property)
static @Nullable Integer	getIntegerProperty(ConfigLoader.Property property)
static <T> T	getProperty(ConfigLoader.Property property)
static @Nullable String	getStringProperty(ConfigLoader.Property property)
static boolean	hasProperty(ConfigLoader.Property property)
static Map<ConfigLoader.Property,Object>	loadProperties(File filename, boolean addProperties) Loads properties from property File, if provided.
static Map<ConfigLoader.Property,Object>	loadProperties(@Nullable InputStream inputStream, boolean addProperties) Loads properties from InputStream.
static Map<ConfigLoader.Property,Object>	loadProperties(Properties properties, boolean addProperties) Loads properties from another properties source, in case you want to provide your own list.
static Map<ConfigLoader.Property,Object>	loadProperties(String filename, boolean addProperties) Loads properties from property file on the classpath, if provided.
static <T> T	valueOrProperty(T value, ConfigLoader.Property property)
static <T> T	valueOrProperty(T value, @NotNull ConfigLoader.Property property, T defaultValue) Returns the given value if not null and not empty, otherwise tries to resolve the given property and if still not found resort to the default value if provided.
static @Nullable Boolean	valueOrPropertyAsBoolean(@Nullable Boolean value, @NotNull ConfigLoader.Property property, @Nullable Boolean defaultValue) See valueOrProperty(Object, Property, Object).
static @Nullable Integer	valueOrPropertyAsInteger(@Nullable Integer value, @NotNull ConfigLoader.Property property, @Nullable Integer defaultValue) See valueOrProperty(Object, Property, Object).
static @Nullable String	valueOrPropertyAsString(@Nullable String value, @NotNull ConfigLoader.Property property, @Nullable String defaultValue) See valueOrProperty(Object, Property, Object).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONFIG_FILENAME

public static final String DEFAULT_CONFIG_FILENAME

By default, the optional file "simplejavamail.properties" will be loaded from classpath to load initial defaults.

See Also:

Constant Field Values

Method Detail

valueOrProperty

@Nullable
public static <T> T valueOrProperty(@Nullable
                                              T value,
                                              ConfigLoader.Property property)

Returns:

The value if not null or else the value from config file if provided or else null.

valueOrPropertyAsString

@Nullable
public static @Nullable String valueOrPropertyAsString(@Nullable
                                                                 @Nullable String value,
                                                                 @NotNull
                                                                 @NotNull ConfigLoader.Property property,
                                                                 @Nullable
                                                                 @Nullable String defaultValue)

See valueOrProperty(Object, Property, Object).

valueOrPropertyAsBoolean

@Nullable
public static @Nullable Boolean valueOrPropertyAsBoolean(@Nullable
                                                                   @Nullable Boolean value,
                                                                   @NotNull
                                                                   @NotNull ConfigLoader.Property property,
                                                                   @Nullable
                                                                   @Nullable Boolean defaultValue)

See valueOrProperty(Object, Property, Object).

valueOrPropertyAsInteger

@Nullable
public static @Nullable Integer valueOrPropertyAsInteger(@Nullable
                                                                   @Nullable Integer value,
                                                                   @NotNull
                                                                   @NotNull ConfigLoader.Property property,
                                                                   @Nullable
                                                                   @Nullable Integer defaultValue)

See valueOrProperty(Object, Property, Object).

valueOrProperty

@Nullable
public static <T> T valueOrProperty(@Nullable
                                              T value,
                                              @NotNull
                                              @NotNull ConfigLoader.Property property,
                                              @Nullable
                                              T defaultValue)

Returns the given value if not null and not empty, otherwise tries to resolve the given property and if still not found resort to the default value if provided.

Null or blank values are never allowed, so they are always ignored.

Returns:

The value if not null or else the value from config file if provided or else defaultValue.

hasProperty

public static boolean hasProperty(ConfigLoader.Property property)

getProperty

@Nullable
public static <T> T getProperty(ConfigLoader.Property property)

getStringProperty

@Nullable
public static @Nullable String getStringProperty(ConfigLoader.Property property)

getIntegerProperty

@Nullable
public static @Nullable Integer getIntegerProperty(ConfigLoader.Property property)

getBooleanProperty

@Nullable
public static @Nullable Boolean getBooleanProperty(ConfigLoader.Property property)

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(String filename,
                                                               boolean addProperties)

Loads properties from property file on the classpath, if provided. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

filename - Any file that is on the classpath that holds a list of key=value pairs.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(Properties properties,
                                                               boolean addProperties)

Loads properties from another properties source, in case you want to provide your own list.

Parameters:

properties - Your own list of properties

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(File filename,
                                                               boolean addProperties)

Loads properties from property File, if provided. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

filename - Any file reference that holds a properties list.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.

loadProperties

public static Map<ConfigLoader.Property,Object> loadProperties(@Nullable
                                                               @Nullable InputStream inputStream,
                                                               boolean addProperties)

Loads properties from InputStream. Calling this method only has effect on new Email and Mailer instances after this.

Parameters:

inputStream - Source of property key=value pairs separated by newline \n characters.

addProperties - Flag to indicate if the new properties should be added or replacing the old properties.

Returns:

The updated properties map that is used internally.