{"features":[{"Description":null,"Name":"USM"}],"version":{"Year":2026,"Version":"9.9.9"},"properties":[{"Description":"Specifies the module to check in the ajax configuration to test if USM is enabled.\nIf not set (or set to an empty string), the new (and final) method is used by checking\n\"modules\/com.openexchange.usm\/module\", otherwise \"modules\/interface\/<config-value\" is checked\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_ACCESS_CHECK_MODULE","Default":null,"File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.access_check_module","Reloadable":true,"Tags":["USM"]},{"Description":"Determines the limit for inactivity of an USM session after which the persistent session data is removed\n(i.e. slow sync is required afterwards). This value is specified in days, the default value is 60 (approx. 2 months).\nFor sessions that haven't been access using the new system which stores the accurate information in a\npersistent field, double that value is used and the newest sync key is used to determine an approximation\nof the last access.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_STORAGE_TIME_LIMIT","Default":"60","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session_storage_time_limit","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies a timeout (in seconds) after which USM sessions that are not accessed will be removed from memory. Removed sessions\nwill be automatically restored from DB on next access, but since server changes couldn't be traced while the session was not in\nmemory, the client has to perform an (incremental) sync for each folder (it will be notified that each folder changed regardless of\nany real server changes).\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_CACHE_SESSION_TIMEOUT","Default":"43200","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.cache.session.timeout","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies a timeout (in seconds) after which cached SyncStates that are not accessed will be removed from memory. Removed SyncStates\nwill be automatically restored from DB on next access.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_CACHE_SYNCSTATE_TIMEOUT","Default":"3600","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.cache.syncstate.timeout","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies the time interval (in milliseconds) for the periodical task USMSessionCacheCleanup,\nwhich removes unused SyncStates from the memory cache.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_CACHE_CHECK_INTERVAL","Default":"60000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session_cache_check_interval","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies the time interval (in milliseconds) for the periodical logging information about the\nnumber of USM sessions and SyncStates removed from the memory cache.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_CACHE_CHECK_INTERVAL_LOG_INFO","Default":"300000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session_cache_check_interval_log_info","Reloadable":true,"Tags":["USM"]},{"Description":"Defines the base URL that is used to access the OX server interface\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_URL","Default":"http:\/\/localhost\/ajax\/","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.url","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies the overall maximum number of (concurrent) connections the USM may use for requests to the OX server.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_MAX_CONNECTIONS","Default":"100","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.max_connections","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies the time (in milliseconds) after which idle connections to the OX server will be closed.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_IDLE_CONNECTION_TIMEOUT","Default":"60000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.idle_connection_timeout","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies if the HttpClient should perform stale checking of Connections before using them (increases security, lowers performance).\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_PERFORM_STALE_CHECKING","Default":"true","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.perform_stale_checking","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies for Connections whether to stay signed in (avoids expiration of running sessions to the OX server).\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_STAY_SIGNED_IN","Default":"true","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.stay_signed_in","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies a comma-separated list of OX error codes that will trigger an automatic re-login by USM\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_RELOGIN_ERROR_CODES","Default":"SES-0202,SES-0203,SES-0206","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.relogin_error_codes","Reloadable":true,"Tags":["USM"]},{"Description":"Specifies a comma-separated list of OX error codes that signify non-existing PIM items\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_OX_MISSING_OBJECT_ERROR_CODES","Default":"MSG-0032,OX-0001,CON-0125,TSK-0019","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.ox.missing_object_error_codes","Reloadable":true,"Tags":["USM"]},{"Description":"Defines the maximum number of sync retries if a sync fails due to a concurrent modification on the OX server while the sync is in progress\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_CONCURRENT_MODIFICATION_RETRIES","Default":"3","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.concurrent_modification_retries","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a wait time in milliseconds to gain exclusive access to synchronize a folder or the folder hierarchy in\ncase some other protocol method is still working on that resource (due to concurrent client accesses). If\nexclusive access cannot be granted within the configured timeout, the protocol will abort the request and\nnotify the client (in a protocol specific manner).\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_LOCK_TIMEOUT","Default":"10000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.lock.timeout","Reloadable":true,"Tags":["USM"]},{"Description":"Defines the delay that is used when waiting for changes in email folders (Session.waitForChanges()) after which\na pull on email folders is performed. The delay can either be specified as a fixed value in milliseconds which\ndefines the maximum time to wait (if the waitForChanges waits for a smaller interval, the pull will be performed\nat the end of the wait) or as a percentage (integer ending with a \"%\"), which indicates a portion of the given\nwait interval after which the pull will be performed.\nNote that the effective delay will be modified by the com.openexchange.usm.session.sync.email_pull_min_delay\nproperty which may increase the delay or prohibit a pull completely.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_EMAIL_PULL_DELAY","Default":"50%","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.email_pull_delay","Reloadable":true,"Tags":["USM"]},{"Description":"Defines the minimum delay that is required when waiting for changes in email folders (Session.waitForChanges())\nafter which a pull on email folders will be performed. The value is specified in milliseconds. The effective\ndelay will be the maximum of this property and the result of the computation based on the\ncom.openexchange.usm.session.sync.email_pull_delay property and the value specified as parameter to the\nwaitForChanges()-call. If the effective value is greater than the parameter to the waitForChanges()-call,\nno pull will be performed.\nTo disable pulling completely, set the value of this property to a negative value.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_EMAIL_PULL_MIN_DELAY","Default":"60000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.email_pull_min_delay","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a limit on the number of sync states that are stored in the database and local memory cache\nfor each folder and the folder hierarchy itself (per session\/client). If a client connects to the USM\nwith a given sync state, all older states are automatically removed, the new state is computed, stored in\nthe database and sent to the client. As long a client uses an old synckey, new keys keep getting generated,\nbut none deleted. If the limit specified here is reached, the USM deletes the oldest sync state on a client\nconnect that's not equal to the one the client just used to sync with.\nNote that the value of this property imposes an upper limit to the number of sync states stored in the cache\nand database. If a client behaves as expected, only 2 states will be stored (the one used by the client to\ninitiate synchronization in case the synchronization result does not reach the client, and the new generated\none that contains the base state for the next synchronization).\nThe lower limit for this property is 2, since at least 2 sync states are required to account for possible\ncommunication failures.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_MAX_STATES_IN_DB","Default":"5","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.max_states_in_db","Reloadable":true,"Tags":["USM"]},{"Description":"As long as there is no immediate need to make sure the newest OX server data is compared to\nthe client data\/requests, the data from previous sync calls# will be cached and no OX call will be\nperformed to determine its current data for the content of a folder (or for the folder hierarchy).\nThe cached data will be invalidated if an OX event indicates that some change has occurred, and\nit won't be used if any client requests (creation\/change\/deletion) are received (the sync system has\nto make sure that the client requests are compred to the current data on the server). It will also be\ninvalidated after some time, which can be configured for 2 different scenarios:\n- a complete sync, i.e. all pending server changes have been reported to the client\n- an incomplete sync, i.e. only some of the server changes have been reported to the client (in this case, the\nclient normally performs another sync call to retrieve the remaining changes until the sync is complete)\nFor performance reasons, the cache is completely in-memory (and therefore server-local), cached data will\nbe automatically removed if memory is running low.\nFor each scenario the cache can be disabled by setting the timeout value to 0.\nTime in milliseconds for which cached data will be stored for a complete sync.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_CACHE_TIME_LIMIT_COMPLETE","Default":"60000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.cache.time_limit.complete","Reloadable":true,"Tags":["USM"]},{"Description":"Time in milliseconds for which cached data will be stored for an incomplete sync.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_SESSION_SYNC_CACHE_TIME_LIMIT_INCOMPLETE","Default":"1200000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.session.sync.cache.time_limit.incomplete","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a limit for the maximum number of objects in a folder when\nsynchronizing via USM. If a folder contains more objects than\nspecified in the limit, only the newest changed ones are synchronized.\nThis limit is always additionally applied, regardless of the\nsetting requested by the client, to allow server\nadministrators to impose a hard limit on the synchronized\nobjects. A value of <=0 is interpreted as no filtering.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_MAX_OBJECTS_PER_FOLDER","Default":"65535","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.max_objects_per_folder","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a limit for the maximum number of synchronized PIM attachments per object when synchronizing via USM.\nIf 1 object has more PIM attachments than this limit, only the first attachments (sorted by OX ID) will be synchronized.\nA value < 0 disables the limit, all PIM attachments will be synchronized.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_MAX_ATTACHMENT_COUNT_PER_OBJECT","Default":"100","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.max_attachment_count_per_object","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a limit in bytes for the synchronized PIM attachments per object when synchronizing via USM.\nIf the sum of the sizes of the attachments to an object exceeds this limit, only the first attachments\n(sorted by OX ID) will be synchronized.\nA value < 0 disables the limit, all PIM attachments will be synchronized.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_MAX_ATTACHMENT_SIZE_PER_OBJECT","Default":"52428800","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.max_attachment_size_per_object","Reloadable":true,"Tags":["USM"]},{"Description":"If this property is set to true, usm passes the client host header in the login request to the server in a custom X-Host header.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_PASS_CLIENT_HOST_HEADER","Default":"true","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.pass_client_host_header","Reloadable":true,"Tags":["USM"]},{"Description":"Defines a timeout in milliseconds for how long temporary files created by protocols (e.g. uploaded by clients)\nwill be stored after they have been last accessed. This overrides the setting of the OX ManagedFileManagement\nfor temporary files generated by USM. To use the default setting of the OX ManagedFileManagement specify a\nvalue < 0.\n","ConfigCascadeAware":false,"Version":null,"Package":"open-xchange-usm","Env":"COM_OPENEXCHANGE_USM_TEMP_FILES_TIMEOUT","Default":"7200000","File":"usm.properties","Feature":"USM","Key":"com.openexchange.usm.temp_files.timeout","Reloadable":true,"Tags":["USM"]}],"tags":["USM"]}