com.atlassian.jira.mail.settings
Class MailSettings.Send

java.lang.Object
  extended by com.atlassian.jira.mail.settings.MailSettings.Send
Enclosing interface:
MailSettings

public static class MailSettings.Send
extends Object

Represents the state of outgoing mail for this JIRA instance. This can either be enabled or disabled.


Field Summary
static String DISABLED_APPLICATION_PROPERTY
           
static String DISABLED_SYSTEM_PROPERTY_KEY
           
 
Method Summary
 boolean disable()
          Disables sending outgoing mail from JIRA.
 boolean enable()
          Enables sending outgoing mail from JIRA.
 String getModifiedBy()
          Returns the key of the last user to have enabled or disabled outgoing mail, or null if it has never been enabled or disabled.
 Date getModifiedDate()
          Returns the date when outgoing mail was last enabled or disabled, or null if it has never been modified.
 boolean isDisabled()
          Whether outgoing mail is currently disabled.
 boolean isDisabledViaApplicationProperty()
          Whether outgoing mail is currently disabled via the application property.
 boolean isEnabled()
          Whether outgoing mail is currently enabled.
 boolean isModifiable()
          Whether the outgoing mail setting can be changed from enabled to disabled, or viceversa.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DISABLED_APPLICATION_PROPERTY

public static final String DISABLED_APPLICATION_PROPERTY
See Also:
Constant Field Values

DISABLED_SYSTEM_PROPERTY_KEY

public static final String DISABLED_SYSTEM_PROPERTY_KEY
See Also:
Constant Field Values
Method Detail

isEnabled

public boolean isEnabled()
Whether outgoing mail is currently enabled.

Returns:
true, if outgoing mail is enabled. Otherwise, false.

isDisabled

public boolean isDisabled()
Whether outgoing mail is currently disabled.

Returns:
true, if outgoing mail is disabled. Otherwise, false.
See Also:
isEnabled()

isDisabledViaApplicationProperty

public boolean isDisabledViaApplicationProperty()
Whether outgoing mail is currently disabled via the application property.

Returns:
true, if outgoing mail is disabled. Otherwise, false.
See Also:
isEnabled()

isModifiable

public boolean isModifiable()
Whether the outgoing mail setting can be changed from enabled to disabled, or viceversa.

Returns:
true, if outgoing mail can be changed. Otherwise, false.

getModifiedBy

@Nullable
public String getModifiedBy()
Returns the key of the last user to have enabled or disabled outgoing mail, or null if it has never been enabled or disabled.

Returns:
the key of the last user to have enabled/disabled outgoing mail, or null
Since:
6.1
See Also:
ApplicationUser

getModifiedDate

@Nullable
public Date getModifiedDate()
Returns the date when outgoing mail was last enabled or disabled, or null if it has never been modified.

Returns:
the date when outgoing mail was last enabled/disabled, or null.
Since:
6.1

enable

public boolean enable()
Enables sending outgoing mail from JIRA.

Returns:
true, if outgoing mail was succesfully enabled. Otherwise, false.
See Also:
isModifiable()

disable

public boolean disable()
Disables sending outgoing mail from JIRA.

Returns:
true, if outgoing mail was succesfully disabled. Otherwise, false.
See Also:
isModifiable()


Copyright © 2002-2014 Atlassian. All Rights Reserved.