org.sakaiproject.mailsender.logic

Interface ConfigLogic

public interface ConfigLogic

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_PREFIX_CHANGE_PROP
static String	CONFIG_SAVED
static String	DEFAULT_SUBJECT_PREFIX
static String	DEFAULT_SUBJECT_PREFIX_PROP
static String	DISPLAY_EMPTY_GROUPS
static String	EMAIL_TEST_MODE_PROP
static String	UPLOAD_DIRECTORY_PROP

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowSubjectPrefixChange() Allow the user to change the prefix that is prepended to the subject of emails.
ConfigEntry	getConfig() Get the current tool placement config
String	getDefaultSubjectPrefix() Returns the default subject prefix.
String	getUploadDirectory() Get the directory where uploads should be stored
boolean	isEmailTestMode() Check if the system is currently set up in a "test" mode, indicating that e-mails should not be actually dispatched, but rather spit into a log or external file for verification purposes.
String	saveConfig(ConfigEntry ce) Save the configuration to the tool placement config space

Field Detail

DEFAULT_SUBJECT_PREFIX

static final String DEFAULT_SUBJECT_PREFIX

See Also:

Constant Field Values

ALLOW_PREFIX_CHANGE_PROP

static final String ALLOW_PREFIX_CHANGE_PROP

See Also:

Constant Field Values

DEFAULT_SUBJECT_PREFIX_PROP

static final String DEFAULT_SUBJECT_PREFIX_PROP

See Also:

Constant Field Values

UPLOAD_DIRECTORY_PROP

static final String UPLOAD_DIRECTORY_PROP

See Also:

Constant Field Values

DISPLAY_EMPTY_GROUPS

static final String DISPLAY_EMPTY_GROUPS

See Also:

Constant Field Values

EMAIL_TEST_MODE_PROP

static final String EMAIL_TEST_MODE_PROP

See Also:

Constant Field Values

CONFIG_SAVED

static final String CONFIG_SAVED

See Also:

Constant Field Values

Method Detail

getConfig

ConfigEntry getConfig()

Get the current tool placement config

Returns:

saveConfig

String saveConfig(ConfigEntry ce)

Save the configuration to the tool placement config space

Parameters:

ce -

Returns:

"saveConfig" is returned upon completion

getUploadDirectory

String getUploadDirectory()

Get the directory where uploads should be stored

Returns:

allowSubjectPrefixChange

boolean allowSubjectPrefixChange()

Allow the user to change the prefix that is prepended to the subject of emails. Set through system property "mailsender.allowSubjectPrefixChange".

Returns:

true if allowed, false otherwise [default: false]

getDefaultSubjectPrefix

String getDefaultSubjectPrefix()

Returns the default subject prefix. This is normally DEFAULT_SUBJECT_PREFIX but can be set by the system property "mailsender.subjectprefix".

Returns:

isEmailTestMode

boolean isEmailTestMode()

Check if the system is currently set up in a "test" mode, indicating that e-mails should not be actually dispatched, but rather spit into a log or external file for verification purposes.

Returns:

true if the system has specified an email test mode, false otherwise