public final class MailProperties extends java.lang.Object implements IMailProperties
MailProperties
- Global mail properties read from properties file.Modifier and Type | Method and Description |
---|---|
java.util.List<IPRange> |
getAccountBlacklistRanges()
Gets the ranges for account black-list
|
int |
getAttachDisplaySize()
Gets the max. allowed size (in bytes) for attachment for being displayed.
|
java.lang.String |
getAuthProxyDelimiter() |
java.lang.String |
getDefaultMailProvider()
Gets the default mail provider.
|
java.lang.String |
getDefaultMimeCharset()
Gets the default MIME charset.
|
char |
getDefaultSeparator()
Gets the default separator character.
|
static MailProperties |
getInstance()
Gets the singleton instance of
MailProperties . |
java.util.Properties |
getJavaMailProperties()
Gets the JavaMail properties.
|
MailConfig.LoginSource |
getLoginSource()
Gets the login source.
|
int |
getMailAccessCacheIdleSeconds()
Gets the mail access cache idle seconds.
|
int |
getMailAccessCacheShrinkerSeconds()
Gets the mail access cache shrinker-interval seconds.
|
int |
getMailFetchLimit()
Gets the mail fetch limit.
|
java.lang.String |
getMailServer()
Gets the global mail server.
|
MailConfig.ServerSource |
getMailServerSource()
Gets the mail server source.
|
java.lang.String |
getMasterPassword()
Gets the master password.
|
int |
getMaxToCcBcc()
Gets the sent mail rate limit (how many mails can be sent in
|
MailConfig.PasswordSource |
getPasswordSource()
Gets the password source.
|
java.lang.String[] |
getPhishingHeaders()
Gets the phishing headers.
|
java.lang.String[] |
getQuoteLineColors()
Gets the quote line colors.
|
int |
getRateLimit()
Gets the sent mail rate limit (how many mails can be sent in
|
boolean |
getRateLimitPrimaryOnly()
Gets the setting if the rate limit should only affect the primary account or all accounts
|
java.lang.String |
getTransportServer()
Gets the global transport server
|
MailConfig.ServerSource |
getTransportServerSource()
Gets the transport server source.
|
int |
getWatcherFrequency()
Gets the watcher frequency.
|
int |
getWatcherTime()
Gets the watcher time.
|
boolean |
isAddClientIPAddress()
Checks if client's IP address should be added to mail headers on delivery as custom header
"X-Originating-IP" . |
boolean |
isAdminMailLoginEnabled()
Indicates if admin mail login is enabled; meaning whether admin user's try to login to mail system is permitted or not.
|
boolean |
isAllowNestedDefaultFolderOnAltNamespace()
Checks if default folders (e.g.
|
boolean |
isHidePOP3StorageFolders() |
boolean |
isIgnoreSubscription()
Indicates whether subscription shall be ignored or not.
|
boolean |
isSupportMsisdnAddresses()
Signals if MSISDN addresses are supported or not.
|
boolean |
isSupportSubscription()
Indicates whether subscription is supported or not.
|
boolean |
isUserFlagsEnabled()
Indicates if user flags are enabled.
|
boolean |
isWatcherEnabled()
Indicates if watcher is enabled.
|
boolean |
isWatcherShallClose()
Indicates if watcher is allowed to close exceeded connections.
|
void |
loadProperties()
Exclusively loads the global mail properties
|
static void |
releaseInstance()
Releases the singleton instance of
MailProperties . |
void |
resetProperties()
Exclusively resets the global mail properties
|
void |
waitForLoading()
Waits for loading this properties.
|
public static MailProperties getInstance()
MailProperties
.MailProperties
public static void releaseInstance()
MailProperties
.public void loadProperties() throws com.openexchange.exception.OXException
com.openexchange.exception.OXException
- If loading of global mail properties failspublic void resetProperties()
public void waitForLoading() throws java.lang.InterruptedException
waitForLoading
in interface IMailProperties
java.lang.InterruptedException
- If another thread interrupted the current thread before or while the current thread was waiting for
loading the properties.public boolean isAllowNestedDefaultFolderOnAltNamespace()
IMailProperties
Note that personal namespace folder must allow subfolder creation.
isAllowNestedDefaultFolderOnAltNamespace
in interface IMailProperties
true
if default folders are supposed to be created below personal namespace folder; otherwise false
public int getAttachDisplaySize()
IMailProperties
getAttachDisplaySize
in interface IMailProperties
public java.util.List<IPRange> getAccountBlacklistRanges()
null
if not setpublic java.lang.String getDefaultMimeCharset()
public java.lang.String getDefaultMailProvider()
public boolean isAdminMailLoginEnabled()
true
if admin mail login is enabled; otherwise false
public char getDefaultSeparator()
IMailProperties
getDefaultSeparator
in interface IMailProperties
public boolean isIgnoreSubscription()
IMailProperties
isIgnoreSubscription
in interface IMailProperties
true
if subscription shall be ignored; otherwise false
public boolean isHidePOP3StorageFolders()
public boolean isSupportSubscription()
IMailProperties
isSupportSubscription
in interface IMailProperties
true
if subscription is supported; otherwise false
public boolean isAddClientIPAddress()
"X-Originating-IP"
.true
if client's IP address should be added otherwise false
public java.util.Properties getJavaMailProperties()
public MailConfig.LoginSource getLoginSource()
public MailConfig.PasswordSource getPasswordSource()
public MailConfig.ServerSource getMailServerSource()
public MailConfig.ServerSource getTransportServerSource()
public int getMailFetchLimit()
IMailProperties
getMailFetchLimit
in interface IMailProperties
public java.lang.String getMailServer()
public java.lang.String getMasterPassword()
public int getMaxToCcBcc()
public java.lang.String[] getQuoteLineColors()
public int getRateLimit()
public boolean getRateLimitPrimaryOnly()
public java.lang.String getTransportServer()
public boolean isUserFlagsEnabled()
IMailProperties
isUserFlagsEnabled
in interface IMailProperties
true
if user flags are enabled; otherwise false
public boolean isWatcherEnabled()
IMailProperties
isWatcherEnabled
in interface IMailProperties
true
if watcher is enabled; otherwise false
public int getWatcherFrequency()
IMailProperties
getWatcherFrequency
in interface IMailProperties
public boolean isWatcherShallClose()
IMailProperties
isWatcherShallClose
in interface IMailProperties
true
if watcher is allowed to close exceeded connections; otherwise false
public int getWatcherTime()
IMailProperties
getWatcherTime
in interface IMailProperties
public java.lang.String[] getPhishingHeaders()
null
if none definedpublic int getMailAccessCacheShrinkerSeconds()
IMailProperties
getMailAccessCacheShrinkerSeconds
in interface IMailProperties
public int getMailAccessCacheIdleSeconds()
IMailProperties
getMailAccessCacheIdleSeconds
in interface IMailProperties
public final java.lang.String getAuthProxyDelimiter()
public boolean isSupportMsisdnAddresses()
true
, if MSISDN addresses are supported; otherwise false