The Kopano OL Extension (KOE) serves as an enhancement to the already included ActiveSync support of Microsoft Outlook 2013 and 2016 (Windows only, but for both 32bit and 64bit systems). KOE is available as an msi package and can be installed before or after creating the actual ActiveSync account in Outlook.
The client side documentation has been moved over to the Kopano Knowledge Base.
Configuring the GAB-Sync Script
The scripts and configuration files in the following article are part of the package z-push-kopano-gabsync
The GAB-Sync script can be run on any host that has the php-mapi module installed and that has access to your Zarafa/Kopano system. The script also brings its own config file (config.php), which needs to be customised to the local environment, so that the script can login at your Kopano/Zarafa system with admin privileges.
Amount of Chunks for GAB data
Depending on the total amount of GAB entries AMOUNT_OF_CHUNKS could be adjusted in the gab-sync config.php to have smaller chunks of data.
Excerpt of the gab-sync config.php. SERVER, USERNAME and PASSWORD may need to be adjusted to the local installation if the script is running on a different system than your Zarafa/Kopano installation. If Z-Push and Zarafa/Kopano are running on the same system no adjustments are necessary.
For multi-tenant systems it's not possible to authenticate using 'SYSTEM'. A user with full system admin privileges is required (kopanoAdmin=2 in LDAP).
Runtime example of gab-sync.php:
The id given in "Starting GAB sync to store 'SYSTEM' on id '97b7db77f54d4666ab345a2b8b13f26bed3000000000'" can be inserted into the KOE_GAB_FOLDERID variable of Z-Push's configuration file. If left empty Z-Push will search the folder by name and automatically discover the id.
Store of the user SYSTEM
The store associated with the user SYSTEM is the public store, available to all users by default. If your system does not yet have a public store, you need to run kopano-admin -s.
Make sure enough permissions are set on the public store so users can see the
Z-Push-KOE-GAB folder. At least "read-only" and "folder visible" permissions are required to get the GAB sync to KOE.
The gab-sync script itself automatically detects if multiple tenants are configured in an environment and exports the GAB to the public folder of each tenant. For Multi-Tenant Environments the KOE_GAB_FOLDERID always needs to be kept empty.
Hidden GAB entries
If contacts or accounts are marked as hidden in the GAB they were still visible in Outlook when using this script. This is done via the
zarafaHidden flag (depending on your LDAP schema).
With Z-Push 2.3.4 this was fixed, but versions prior to KC 8.2 require additional configuration.
It's required to add the following line to your
If you use the Zarafa LDAP schema you need do the same, but changing
/etc/zarafa/ldap.propmap.cfg adding the mapping of the '
When using KC 8.2 or newer, check /usr/share/kopano/ldap.propmap.cfg if this already mapped.
After doing this change it's required to restart
Executing the sync-gab script will output an additional line for hidden users, like:
Automating execution of z-push-gabsync
Depending on the amount of changes to the GAB of your Kopano system you should setup a cronjob to invoke z-push-gabsync from time to time. For normal system we recommend to add the following snippet to your daily cron run (e.g. /etc/cron.daily):
If Z-Push is running on the same system as your Kopano, then you could also add the above script to /etc/kopano/userscripts/createuser.d to additionally run it whenever a new user has been created.
The Kopano OL Extension is available for Kopano partners and customers from https://download.kopano.io/supported/olextension:/ (Login with credentials from the Kopano Partner Portal).