Zimbra SkillZ: Configuring Zimlets

Hi Zimbra Friends, Partners & Customers,

Today’s post is from Barry de Graaff, Channel Evangelist for Zimbra Synacor, and it provides Zimlet configure info.

Zimlets can use additional configuration properties, so you can write a Zimlet that can be configured by the administrator of the Zimbra server. This means you can avoid hard-coding client-id’s, on-premises service URL’s, message templates, etc.

Adding config_template.xml to your Zimlet

This works using an XML configuration template that you prepare when developing the Zimlet. Add a file with the name config_template.xml to the root folder of your Zimlet to look like this:

├── build
├── config_template.xml
├── node_modules
├── package.json
├── package-lock.json
├── pkg
├── README.md
├── src
├── tsconfig.json
└── zimlet.config.js

The config_template.xml file has the following structure:

<zimletConfig name="zm-zimlet-configuration" version="0.0.1">
        <property name="configPropertyName">valueOfConfig</property>
        <property name="Hello">World</property>

To include the config_template.xml in the Zimlet, build and package it using Zimlet CLI. See https://github.com/Zimbra/zm-zimlet-guide.

Here’s an example for this Zimlet:

  zimlet package -v 0.0.1 --zimbraXVersion ">=0.0.1" -n 
"zm-zimlet-configuration" --desc "zm-zimlet-configuration" 
-l "zm-zimlet-configuration"

The name and version of the Zimlet have been set to match the Zimlet version and the configuration template version. This is useful because the Administrator can extract the config_template.xml from the Zimlet. By putting the Zimlet version in the config_template.xml, you can keep track of what Zimlet version the configuration belongs to.

A pre-packaged version of the example Zimlet used in this blog can be downloaded from https://github.com/Zimbra/zimbra-zimlet-configuration/releases/download/0.0.1/zm-zimlet-configuration.zip.

Configuring Zimlets on Zimbra

Deploy the example Zimlet like so:

  wget https://github.com/Zimbra/zimbra-zimlet-configuration/releases/
  zmzimletctl deploy /tmp/zm-zimlet-configuration.zip

To make changes to the configuration, get the configuration template:

  zmzimletctl getConfigTemplate /tmp/zm-zimlet-configuration.zip >

Review and make changes to /tmp/myconfig.xml using vi or nano and deploy using:

  zmzimletctl configure  /tmp/myconfig.xml

Please note that it is not possible to side-load config_template.xml files. You must always deploy an actual Zimlet to read the configuration properties.

Using configuration properties in a Zimlet

This blog assumes you have already set up your development environment, have basic understanding of Preact Zimlets and Zimlet CLI. If you are new to this, please take a look at https://wiki.zimbra.com/wiki/DevelopersGuide#Zimlet_Development_Guide.

Log on to your Zimbra development server and make sure that you are seeing the modern UI. Go to the right top Gear menu, and click the Global Config Test option to display the loaded configuration properties.

Global Config Test option in Gear menu Global Config Test option in Gear menu

Global Config Test option in the Gear menu

The file src/components/more-menu/index.js implements the Global Config Test option in the Gear menu. The in-code comments explain how it works:

import { createElement, Component } from 'preact';

export default class MoreMenu extends Component {
    constructor(props) {
        this.zimletContext = props.children.context;

        //Get all zimlets
        const zimlets = this.zimletContext.getAccount().zimlets
        this.globalConfig = new Map();
        //Get demo zimlet
        const zimlet = zimlets.zimlet.find(zimlet => zimlet.zimlet[0].name === "zm-zimlet-configuration");

        //Add all demo zimlet configuration properties to an ES6 Map
        if (zimlet) {
            const globalConfig = zimlet.zimletConfig[0].global[0].property || [];
            for (var i = 0; i < globalConfig.length; i++) {
                this.globalConfig.set(globalConfig[i].name, globalConfig[i].content);
        //now you can get a property value by doing: this.globalConfig.get('name-of-property')

    //Show properties of this Zimlet in the browser developer console, and alert to the user.
    handleClick = e => {

        //Use forEach on ES6 Map to show it on screen for demo purpose.
        let globalConfigLogString = "";
        this.globalConfig.forEach(function (value, key, map) {
            globalConfigLogString += key + ":" + value + "\n";


    render() {
        return (
            <div onClick={this.handleClick} class="zimbra-client_menu-item_navItem zimbra-client_action-menu-item_item">
                <span class="zimbra-client_action-menu-item_icon">
                    <span role="img" class="zimbra-icon zimbra-icon-about blocks_icon_md"></span></span>
                <span class="zimbra-client_menu-item_inner">Global Config Test</span></div>

Thanks for reading today’s blog,
Your Zimbra Team

, , , , , , , ,

Comments are closed.

Copyright © 2022 Zimbra, Inc. All rights reserved.

All information contained in this blog is intended for informational purposes only. Synacor, Inc. is not responsible or liable in any manner for the use or misuse of any technical content provided herein. No specific or implied warranty is provided in association with the information or application of the information provided herein, including, but not limited to, use, misuse or distribution of such information by any user. The user assumes any and all risk pertaining to the use or distribution in any form of any subject matter contained in this blog.

Legal Information | Privacy Policy | Do Not Sell My Personal Information | CCPA Disclosures