Settings (DavMail POP/IMAP/SMTP/Caldav/Carddav/LDAP Exchange and Office 365 Gateway 6.4.0 API)

java.lang.Object
- davmail.Settings

```
public final class Settings
extends Object
```
Settings facade. DavMail settings are stored in the .davmail.properties file in current user home directory or in the file specified on the command line.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO`
`static String`	`EDGE_USER_AGENT`
`static String`	`EWS`
`static String`	`GRAPH_URL`
`static String`	`O365`
`static String`	`O365_INTERACTIVE`
`static String`	`O365_LOGIN_URL`
`static String`	`O365_MANUAL`
`static String`	`O365_MODERN`
`static String`	`O365_URL`
`static String`	`OUTLOOK_URL`
`static String`	`WEBDAV`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`getBooleanProperty(String property)` Get a property value as boolean.
`static boolean`	`getBooleanProperty(String property, boolean defaultValue)` Get a property value as boolean.
`static char[]`	`getCharArrayProperty(String property)` Get a property value as char[].
`static String`	`getGraphUrl()` Handle custom graph endpoints.
`static int`	`getIntProperty(String property)` Get a property value as int.
`static int`	`getIntProperty(String property, int defaultValue)` Get a property value as int, return default value if null.
`static String`	`getLogFileDirectory()` Return DavMail log file directory
`static String`	`getLogFilePath()` Return DavMail log file path
`static org.apache.log4j.Level`	`getLoggingLevel(String category)` Return Log4J logging level for the category.
`static String`	`getO365LoginUrl()`
`static String`	`getO365Url()`
`static String`	`getOutlookUrl()`
`static String`	`getProperty(String property)` Get a property value as String.
`static String`	`getProperty(String property, String defaultValue)` Get property value or default.
`static Properties`	`getSubProperties(String scope)` Get all properties that are in the specified scope, that is, that start with '<scope>.'.
`static String`	`getUserAgent()`
`static boolean`	`isFirstStart()` Detect first launch (properties file does not exist).
`static boolean`	`isLinux()` Test if running on Linux
`static boolean`	`isUnix()`
`static boolean`	`isWindows()` Test if running on Windows
`static void`	`load()` Load properties from current file path (command line or default).
`static void`	`load(InputStream inputStream)` Load properties from provided stream (used in webapp mode).
`static String`	`loadRefreshToken(String username)`
`static void`	`save()` Save settings in current file path (command line or default).
`static void`	`saveProperty(String property, String value)` Change and save a single property.
`static void`	`setConfigFilePath(String path)` Set config file path (from command line parameter).
`static void`	`setDefaultSettings()` Set all settings to default values.
`static void`	`setLoggingLevel(String category, org.apache.log4j.Level level)` Set Log4J logging level for the category
`static void`	`setProperty(String property, String value)` Set a property value.
`static void`	`storeRefreshToken(String username, String refreshToken)`
`static void`	`updateLoggingConfig()` Update Log4J config from settings.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OUTLOOK_URL
```
public static final String OUTLOOK_URL
```
    See Also:
    
    Constant Field Values
  - O365_URL
```
public static final String O365_URL
```
    See Also:
    
    Constant Field Values
  - GRAPH_URL
```
public static final String GRAPH_URL
```
    See Also:
    
    Constant Field Values
  - O365_LOGIN_URL
```
public static final String O365_LOGIN_URL
```
    See Also:
    
    Constant Field Values
  - O365
```
public static final String O365
```
    See Also:
    
    Constant Field Values
  - O365_MODERN
```
public static final String O365_MODERN
```
    See Also:
    
    Constant Field Values
  - O365_INTERACTIVE
```
public static final String O365_INTERACTIVE
```
    See Also:
    
    Constant Field Values
  - O365_MANUAL
```
public static final String O365_MANUAL
```
    See Also:
    
    Constant Field Values
  - WEBDAV
```
public static final String WEBDAV
```
    See Also:
    
    Constant Field Values
  - EWS
```
public static final String EWS
```
    See Also:
    
    Constant Field Values
  - AUTO
```
public static final String AUTO
```
    See Also:
    
    Constant Field Values
  - EDGE_USER_AGENT
```
public static final String EDGE_USER_AGENT
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setConfigFilePath
```
public static void setConfigFilePath(String path)
```
    Set config file path (from command line parameter).
    
    Parameters:
    
    path - davmail properties file path
  - isFirstStart
```
public static boolean isFirstStart()
```
    Detect first launch (properties file does not exist).
    
    Returns:
    
    true if this is the first start with the current file path
  - load
```
public static void load(InputStream inputStream)
                 throws IOException
```
    Load properties from provided stream (used in webapp mode).
    
    Parameters:
    
    inputStream - properties stream
    
    Throws:
    
    IOException - on error
  - load
```
public static void load()
```
    Load properties from current file path (command line or default).
  - setDefaultSettings
```
public static void setDefaultSettings()
```
    Set all settings to default values. Ports above 1024 for unix/linux
  - getLogFilePath
```
public static String getLogFilePath()
```
    Return DavMail log file path
    
    Returns:
    
    full log file path
  - getLogFileDirectory
```
public static String getLogFileDirectory()
```
    Return DavMail log file directory
    
    Returns:
    
    full log file directory
  - updateLoggingConfig
```
public static void updateLoggingConfig()
```
    Update Log4J config from settings.
  - save
```
public static void save()
```
    Save settings in current file path (command line or default).
  - getProperty
```
public static String getProperty(String property)
```
    Get a property value as String.
    
    Parameters:
    
    property - property name
    
    Returns:
    
    property value
  - getProperty
```
public static String getProperty(String property,
                                 String defaultValue)
```
    Get property value or default.
    
    Parameters:
    
    property - property name
    
    defaultValue - default property value
    
    Returns:
    
    property value
  - getCharArrayProperty
```
public static char[] getCharArrayProperty(String property)
```
    Get a property value as char[].
    
    Parameters:
    
    property - property name
    
    Returns:
    
    property value
  - setProperty
```
public static void setProperty(String property,
                               String value)
```
    Set a property value.
    
    Parameters:
    
    property - property name
    
    value - property value
  - getIntProperty
```
public static int getIntProperty(String property)
```
    Get a property value as int.
    
    Parameters:
    
    property - property name
    
    Returns:
    
    property value
  - getIntProperty
```
public static int getIntProperty(String property,
                                 int defaultValue)
```
    Get a property value as int, return default value if null.
    
    Parameters:
    
    property - property name
    
    defaultValue - default property value
    
    Returns:
    
    property value
  - getBooleanProperty
```
public static boolean getBooleanProperty(String property)
```
    Get a property value as boolean.
    
    Parameters:
    
    property - property name
    
    Returns:
    
    property value
  - getBooleanProperty
```
public static boolean getBooleanProperty(String property,
                                         boolean defaultValue)
```
    Get a property value as boolean.
    
    Parameters:
    
    property - property name
    
    defaultValue - default property value
    
    Returns:
    
    property value
  - loadRefreshToken
```
public static String loadRefreshToken(String username)
```
  - storeRefreshToken
```
public static void storeRefreshToken(String username,
                                     String refreshToken)
```
  - getLoggingLevel
```
public static org.apache.log4j.Level getLoggingLevel(String category)
```
    Return Log4J logging level for the category.
    
    Parameters:
    
    category - logging category
    
    Returns:
    
    logging level
  - getSubProperties
```
public static Properties getSubProperties(String scope)
```
    Get all properties that are in the specified scope, that is, that start with '<scope>.'.
    
    Parameters:
    
    scope - start of property name
    
    Returns:
    
    properties
  - setLoggingLevel
```
public static void setLoggingLevel(String category,
                                   org.apache.log4j.Level level)
```
    Set Log4J logging level for the category
    
    Parameters:
    
    category - logging category
    
    level - logging level
  - saveProperty
```
public static void saveProperty(String property,
                                String value)
```
    Change and save a single property.
    
    Parameters:
    
    property - property name
    
    value - property value
  - isWindows
```
public static boolean isWindows()
```
    Test if running on Windows
    
    Returns:
    
    true on Windows
  - isLinux
```
public static boolean isLinux()
```
    Test if running on Linux
    
    Returns:
    
    true on Linux
  - isUnix
```
public static boolean isUnix()
```
  - getUserAgent
```
public static String getUserAgent()
```
  - getOutlookUrl
```
public static String getOutlookUrl()
```
  - getO365Url
```
public static String getO365Url()
```
  - getGraphUrl
```
public static String getGraphUrl()
```
    Handle custom graph endpoints. See https://learn.microsoft.com/en-us/graph/deployments
    
    Returns:
    
    graph endpoint url
  - getO365LoginUrl
```
public static String getO365LoginUrl()
```

Class Settings

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OUTLOOK_URL

O365_URL

GRAPH_URL

O365_LOGIN_URL

O365

O365_MODERN

O365_INTERACTIVE

O365_MANUAL

WEBDAV

EWS

AUTO

EDGE_USER_AGENT

Method Detail

setConfigFilePath

isFirstStart

load

load

setDefaultSettings

getLogFilePath

getLogFileDirectory

updateLoggingConfig

save

getProperty

getProperty

getCharArrayProperty

setProperty

getIntProperty

getIntProperty

getBooleanProperty

getBooleanProperty

loadRefreshToken

storeRefreshToken

getLoggingLevel

getSubProperties

setLoggingLevel

saveProperty

isWindows

isLinux

isUnix

getUserAgent

getOutlookUrl

getO365Url

getGraphUrl

getO365LoginUrl