Adding global address book plugin to Roundcube
How to install / add Global Address book plugin to Roundcube
Here we are going see, how to add global addressbook plugin to our Roundcube webmail client.
This plugin adds an SQL based global address book to our Roundcube. It can be global per installation, per IMAP host.
1.Prerequisites for installing
- CentOS 7 with Roundcube installation.
- root privileges.
2.Installing / Adding Global Address Book plugin
Download the Plugin in the below URL
- Place this plugin folder into plugins directory of Roundcube
- Add globaladdressbook to $config[‘plugins’] in your Roundcube config
Note : When downloading the plugin from the above URL you will need to create a directory in the name “globaladdressbook” where the roundcube is installed and place the files in there.
3.Configuring Global Address Book plugin
As default, the config file is
plugins/globaladdressbook/config.inc.php.dist, we need to rename this to
This is the name of the dummy user which holds the global address book. The username does not have to belong to a valid email account. The username will be stored in the Roundcube database but will not be able to log into Roundcube unless it belongs to a valid email account on your server.
To create a single global address book for everyone who access Roundcube set this options to ‘[global_addressbook_user]’
To create a global address book per email domain which Roundcube serves set this options to ‘global_addressbook@%d’
The username can contain the following macros that will be expanded as follows:
- %d is replaced with the domain part of the logged in user’s username
- %h is replaced with the imap host (from the session info)
Restrict the actions that can be performed by users in the global address book
- 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
Always copy a contact from the global address book to another one, for example when using drag ‘n drop. Default behaviour is to move the contact.
Should contact groups be available in the global address book
The admin is a user or users who will always have full read/write access even if the address book is set to read only. The follow options are available:
- To set a single user as admin then enter their username as a string like: ‘email@example.com‘
- If you wish give admin rights to multiple users then enter the usernames in an array like: array(‘firstname.lastname@example.org‘, ‘email@example.com‘)
- You can also use regular expressions to match the admin username, regular expressions must be started and finished with a ‘/’. Eg: ‘/^admin@/’
Show contacts from this book in the auto complete menu when composing an email
Use addresses in the global address book to identify known senders before displaying remote inline images in HTML messages (in addition to other configured address books).