{"features":[{"Description":"This page describes the base configuration options for this Mobile API Facade.\n","Name":"Base"},{"Description":"This pages describes all properties related to Weakforce \/ Dovecot\nAnti-Abuse Shield.\n","Name":"Weakforce"}],"version":{"Year":2021,"Version":"1.12-test"},"properties":[{"Description":"This is the base URL under which the middlerware should be accessed from\nthe Mobile API Facade. If you have a multi-host installation of the middleware\nit's highly advised to use an URL which does not access directly a specific\nmiddleware host but a load balancer. This is needed to make the system more\nhighly available.\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":null,"File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.MiddlewareBaseUrl","Reloadable":true,"Tags":["Base"]},{"Description":"Enables\/Disables the version check on statup of the Mobile API Facade OSGi module.\n","ConfigCascadeAware":false,"Version":"1.4.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.versionCheckEnabled","Reloadable":true,"Tags":["Base"]},{"Description":"Defines which class to use for authentication of the users.\nDifferent authentication mechanisms are possible. The open-xchange-mobile-api-facade\npackage contains only com.openexchange.mobile.api.facade.auth.impl.DefaultAuthentication\nbut additional packages can provide other mechanisms.\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"com.openexchange.mobile.api.facade.auth.impl.DefaultAuthenticationService","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.authenticationClass","Reloadable":true,"Tags":["Base"]},{"Description":"Defines the type of threading used be the Mobile API Facade. This feature\ndepends on the capabilities of the underlaying IMAP server.<br><br>Currently known values:\n<ul>\n  <li><code>disabled<\/code><\/li>\n  <li><code>all<\/code><\/li>\n  <li><code>threadedAll<\/code><\/li>\n  <li><code>threadReferences<\/code><\/li>\n<\/ul>\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"threadReferences","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.threading","Reloadable":true,"Tags":["Base"]},{"Description":"Sets the number of mails to be synchronized to the clients per folder.\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"10000","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.numMailsPerFolder","Reloadable":true,"Tags":["Base"]},{"Description":"Enables\/Disables the retrieval of non-primary accounts. By default\nonly the primary account is returned to the clients.\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"false","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.returnNonPrimaryAccounts","Reloadable":true,"Tags":["Base"]},{"Description":"Enables\/Disables the generation of mail teasers in the Mobile API\nFacade.\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.mailTeasers.defaultLength\">com.openexchange.mobile.api.facade.mailTeasers.defaultLength<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.mailTeasers","Reloadable":true,"Tags":["Base"]},{"Description":"Sets the default lenght of the generated mail teasers when clients\ndon't request a maximum teaser length.\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.mailTeasers\">com.openexchange.mobile.api.facade.mailTeasers<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"300","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.mailTeasers.defaultLength","Reloadable":true,"Tags":["Base"]},{"Description":"The default minimum version for all Android clients. Clients with an\nolder client will get a force upgrade message and not be able to use\nthe API until the client is upgraded.<br><br>\nIt's also possible to configure a minimum version for a specific brand.\nFor this append a '.' and the brand name to the property key.\n","ConfigCascadeAware":false,"Version":"1.0.6","Package":"open-xchange-mobile-api-facade","Default":null,"File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.minimumClientVersion.android","Reloadable":true,"Tags":["Base"]},{"Description":"The default minimum version for all iOS clients. Clients with an\nolder client will get a force upgrade message and not be able to use\nthe API until the client is upgraded.<br><br>\nIt's also possible to configure a minimum version for a specific brand.\nFor this append a '.' and the brand name to the property key.\n","ConfigCascadeAware":false,"Version":"1.0.6","Package":"open-xchange-mobile-api-facade","Default":null,"File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.minimumClientVersion.ios","Reloadable":true,"Tags":["Base"]},{"Description":"The default minimum version for all Windows clients. Clients with an\nolder client will get a force upgrade message and not be able to use\nthe API until the client is upgraded.<br><br>\nIt's also possible to configure a minimum version for a specific brand.\nFor this append a '.' and the brand name to the property key.<br><br>\nThis property is deprecated. Windows support was cancelled.\n","ConfigCascadeAware":false,"Version":"1.0.6","Package":"open-xchange-mobile-api-facade","Default":null,"File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.minimumClientVersion.windows","Reloadable":true,"Tags":["Base"]},{"Description":"A comma separated ist of allowed brand names. This can be used to only\nallow for certain brand apps to connect to the Mobile API Facade. If\ncustomers want to restrict access to only their own branded apps their\nbrand needs to get added here.<br><br>\nBy default this property is not configured which basically means all\napps are allowed to connect. Even if this property is configured with\nan empty string all branded apps are allowed to access.<br><br>\nAn example configuration can look like this:<br><br>com.openexchange.mobile.api.facade.allowedBrands=Brand1, Brand2\n","ConfigCascadeAware":false,"Version":"1.0.9","Package":"open-xchange-mobile-api-facade","Default":null,"File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.allowedBrands","Reloadable":true,"Tags":["Base"]},{"Description":"Enables\/Disables the forwarding of the Host HTTP header to the\nmiddleware.<br><br>\nBy default this property is not configured, which means the default\nvalue is is used and the header is forwarded.\n","ConfigCascadeAware":false,"Version":"1.0.9","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Base","Key":"com.openexchange.mobile.api.facade.forwardHostHeader","Reloadable":true,"Tags":["Base"]},{"Description":"Enables\/Disables the weakforce feature.\n","ConfigCascadeAware":false,"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Weakforce","Key":"com.openexchange.mobile.api.facade.weakforce.enabled","Reloadable":true,"Tags":["Weakforce"]},{"Description":"Defines the base URL to the weakforce service.\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.weakforce.enabled\">com.openexchange.mobile.api.facade.weakforce.enabled<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Weakforce","Key":"com.openexchange.mobile.api.facade.weakforce.baseUrl","Reloadable":true,"Tags":["Weakforce"]},{"Description":"Sets the password used for the weakforce service.\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.weakforce.enabled\">com.openexchange.mobile.api.facade.weakforce.enabled<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Weakforce","Key":"com.openexchange.mobile.api.facade.weakforce.password","Reloadable":true,"Tags":["Weakforce"]},{"Description":"Sets the hash mechanism to used generate the user hash.<br><br>Currently known values:\n<ul>\n  <li><code>SHA-256<\/code><\/li>\n<\/ul>\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.weakforce.enabled\">com.openexchange.mobile.api.facade.weakforce.enabled<\/a>","<a href=\"#com.openexchange.mobile.api.facade.weakforce.hashNonce\">com.openexchange.mobile.api.facade.weakforce.hashNonce<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Weakforce","Key":"com.openexchange.mobile.api.facade.weakforce.hashMechanism","Reloadable":true,"Tags":["Weakforce"]},{"Description":"Sets the nonce used to generate the user hash.\n","ConfigCascadeAware":false,"Related":["<a href=\"#com.openexchange.mobile.api.facade.weakforce.enabled\">com.openexchange.mobile.api.facade.weakforce.enabled<\/a>","<a href=\"#com.openexchange.mobile.api.facade.weakforce.hashMechanism\">com.openexchange.mobile.api.facade.weakforce.hashMechanism<\/a>"],"Version":"1.0.0","Package":"open-xchange-mobile-api-facade","Default":"true","File":"facade.properties","Feature":"Weakforce","Key":"com.openexchange.mobile.api.facade.weakforce.hashNonce","Reloadable":true,"Tags":["Weakforce"]}],"tags":["Base","Weakforce"]}