Developers Documentation



301 error for file:

User Tools

Site Tools

Prototyping of the Global Address Book for Roundcube

This document is intended to be used by developers and testers to implement the Global Address Book for Roundcube. This development is tied to this feature request in the bug tracker. If the bug is closed, you will not need to perform these steps to get the functionality of the Global Address Book in Roundcube. Please check your existing interface for functionality before using these steps.

Open Source Defaults

The plugin for the Global Address Book (GAB) is stubbed into the interface for Roundcube but is not functional as it is a separate project. Possibly it is modular and would allow different/competing GABs. The one most tightly associated with Roundcube is the JohnDoh “Roundcube Webmail GlobalAddressBook

Getting the Code

We tested with the latest master build}} and it had bugs and was unstable. The [[|release version worked well in testing.

Once you have the code, extract it, rename it to 'globaladdressbook' and place it in roundcube plugins directory as the folder called 'globaladdressbook':

[root@server plugins]# pwd
[root@server plugins]# ls -la globaladdressbook/
total 44
drwxr-xr-x  3 root root 4096 Nov  3 23:19 .
drwxr-xr-x 36 root root 4096 Nov  3 23:12 ..
-rw-r--r--  1 root root 1608 Oct 25 04:05 CHANGELOG
-rw-r--r--  1 root root  699 Oct 25 04:05 composer.json
-rw-r--r--  1 root root 1622 Nov  3 23:19
-rw-r--r--  1 root root 1621 Oct 25 04:05
-rw-r--r--  1 root root   15 Aug 31  2014 .gitignore
-rw-r--r--  1 root root 6043 Oct 25 04:05 globaladdressbook.php
drwxr-xr-x  2 root root 4096 Oct 25 04:05 localization
-rw-r--r--  1 root root 3390 Oct 25 04:05

You can then copy the '' to '' and make some modifications.

The parameters which have the biggest 'bang for the buck' are:

  • $config['globaladdressbook_perms'] = 1;
  • $config['globaladdressbook_admin'] = null;

These could potentially be extended in the app-roundcubemail to allow for better address book management.

The options for globaladdressbook_perms are:

  • 0 - global address book is read only
  • 1 - users can add, edit and delete contacts (full permissions)
  • 2 - users can add but not edit or delete contacts
  • 3 - users can add and edit but not delete contacts

The admin overrides option 0, 2, and 3 so that those users in the array can modify and delete contacts. Here is a list of valid formats for the field:

  • No admin
    • $config['globaladdressbook_admin'] = null;
  • One admin (non-array format)
    • $config['globaladdressbook_admin'] = 'testuser';
  • One admin (array format)
    • $config['globaladdressbook_admin'] = array('testuser');
  • Multiple admins
    • $config['globaladdressbook_admin'] = array('testuser', 'testuser1');
content/en_us/skunkworks_gab_plugin_for_roundcube.txt · Last modified: 2015/11/20 14:58 by dloper