org.jahia.services.mail

Class MailSettings

java.lang.Object

org.jahia.services.mail.MailSettings

All Implemented Interfaces:

Serializable

public class MailSettings
extends Object
implements Serializable

Mail configuration values.

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MailSettings() Initializes an instance of this class.
MailSettings(boolean serviceEnabled, String uri, String from, String to, String notificationLevel) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
String	getFrom() Returns the from.
String	getNotificationLevel() Returns the notificationLevel.
int	getNotificationSeverity() Returns the notification severity.
Map<String,String>	getOptions()
String	getPassword()
int	getPort()
String	getSmtpHost()
String	getTo() Returns the to.
String	getUri() Returns the mail server connection URI.
String	getUser()
boolean	isConfigurationValid() Returns the configugationValid.
boolean	isServiceActivated() Returns the serviceEnabled.
boolean	isWorkflowNotificationsDisabled() Returns the value of the flag for workflow tasks e-mail notifications.
void	setConfigurationValid(boolean configugationValid) Sets the value of configugationValid.
void	setFrom(String from) Sets the value of from.
void	setNotificationLevel(String notificationLevel) Sets the value of notificationLevel.
void	setServiceActivated(boolean serviceActivated) Sets the value of serviceActivated.
void	setTo(String to) Sets the value of to.
void	setUri(String uri) Sets the value of uri.
void	setWorkflowNotificationsDisabled(boolean workflowNotificationsDisabled) Updates the flag for disabling e-mail notifications for workflow tasks.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MailSettings

public MailSettings()

Initializes an instance of this class.

MailSettings

public MailSettings(boolean serviceEnabled,
                    String uri,
                    String from,
                    String to,
                    String notificationLevel)

Initializes an instance of this class.

Parameters:

serviceEnabled - is service enabled

uri - the mail server connection URI

from - sender address

to - recipient address

notificationLevel - event notification level

Method Detail

getFrom

public String getFrom()

Returns the from.

Returns:

the from

getNotificationLevel

public String getNotificationLevel()

Returns the notificationLevel.

Returns:

the notificationLevel

getNotificationSeverity

public int getNotificationSeverity()

Returns the notification severity.

Returns:

the notification severity

getTo

public String getTo()

Returns the to.

Returns:

the to

getUri

public String getUri()

Returns the mail server connection URI.

Returns:

the mail server connection URI

isConfigurationValid

public boolean isConfigurationValid()

Returns the configugationValid.

Returns:

the configugationValid

isServiceActivated

public boolean isServiceActivated()

Returns the serviceEnabled.

Returns:

the serviceEnabled

setConfigurationValid

public void setConfigurationValid(boolean configugationValid)

Sets the value of configugationValid.

Parameters:

configugationValid - the configugationValid to set

setFrom

public void setFrom(String from)

Sets the value of from.

Parameters:

from - the from to set

setNotificationLevel

public void setNotificationLevel(String notificationLevel)

Sets the value of notificationLevel.

Parameters:

notificationLevel - the notificationLevel to set

setServiceActivated

public void setServiceActivated(boolean serviceActivated)

Sets the value of serviceActivated.

Parameters:

serviceActivated - is the service activated

setTo

public void setTo(String to)

Sets the value of to.

Parameters:

to - the to to set

setUri

public void setUri(String uri)

Sets the value of uri.

Parameters:

uri - the connection URI to set

toString

public String toString()

Overrides:

toString in class Object

getUser

public String getUser()

getPassword

public String getPassword()

getPort

public int getPort()

getSmtpHost

public String getSmtpHost()

getOptions

public Map<String,String> getOptions()

isWorkflowNotificationsDisabled

public boolean isWorkflowNotificationsDisabled()

Returns the value of the flag for workflow tasks e-mail notifications.

Returns:

true if the e-mail notifications for workflow tasks are globally enabled; false if they are disabled globally

setWorkflowNotificationsDisabled

public void setWorkflowNotificationsDisabled(boolean workflowNotificationsDisabled)

Updates the flag for disabling e-mail notifications for workflow tasks.

Parameters:

workflowNotificationsDisabled - true to disable workflow task notifications; false to enable it