The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Zimlet Development Guide

This page contains a list with links to all developer guides for Zimbra 10 / Modern UI. These guides are here for your reference but you can also follow them as a self-paced course.

You are free to follow these guides in any order you wish, but guide #2 and #3 are basically Preact Zimlet 101. So if you have trouble understanding guides #4 and higher, please take a look at #2 and #3 first as we are building up the complexity of the guides gradually.

Update: When packaging your Zimlet the file /src/intl/en_US.json needs to be formatted like the example below, some of the guide Zimlets have not yet been updated to include this.

  "zimbra-zimlet-custom-mark": {
    "title": "Custom Mark"
  "zimlet": {
    "description": "Custom Mark",
    "label": "Custom Mark"
Zimbra 9 Zimlet Development Guide
1 Practical guide to writing Zimbra back-end extensions (Java).
2 Practical guide to writing Preact Zimlets for Zimbra 9 and above. Shows how to add a new tab with an iFrame in Zimbra and how to use the more-menu to do something with currently viewed email. Including getting started with Zimlet-CLI.
3 How to use internationalization and custom metadata to create a Sticky Notes Zimlet.
4 How to write a Zimlet that allows a user to attach files from a third party service. This way users can attach files from any service you wish to integrate directly from Zimbra.
5 Create, modify and remove tags in Zimbra, add and remove tags from emails and contacts. How to use GraphQL and Apollo Client from a Zimlet.
6 A Zimlet that can set the Location and Notes fields on a new appointment. Can be used for integrating 3rd party video conferencing solutions in Zimbra.
7 How to write a Zimlet that can be configured by the administrator.
8 Fully functional Zimlet that brings email template functionality to Zimbra 9. Learn how to write Zimlets to interact with the email composer. (get/set subject and body of new email)
9 Fully functional Zimlet. Use Voice Message Zimlet to record a message from Zimbra.
10 Guide on interacting with Zimbra Composer using Zimlets. Signature Template example Zimlet. An alternative to guide 8.
11 A guide on using Zimlet User Properties to store per-user Zimlet settings. Demos the use of GraphQL mutations.
12 How to add an onkeyup event to the Zimbra Composer, interact with the composer while the user is typing.
13 The X-Spam Zimlet displays X-Spam headers in the UI. Introduces @zimbra/api-client a GraphQL client for making SOAP API requests.
14 The Google Translate Zimlet shows you how to deal with a specific message in conversation view mode of Zimbra.
15 Create a Milter extension for Zimbra. Add or replace email headers, filter out specific email content. Automatically add BCC recipients, add disclaimers, etc.
16 Zimlet Events when the user logs-out or sends an email
17 A Zimlet that alerts you when forgetting to attach an attachment when sending an email. (Implementation of guide 16)
18 Empty subject Zimlet, alerts you when sending an email without subject. Introducing a new way to create a modal dialog and also introduces the use of Event Handlers using useCallback to improve performance.
19 Implement a CSRF token check in a Zimbra extension.
20 How to implement Custom Authentication using a Zimbra extension.
21 How to use DOMPurify in your Zimlet for XSS sanitizing
22 Admin Console Zimlets and extensions guide

Related open-source Zimbra Modern Zimlets
1 Zimlet that shows how to set the default cloudapp, can be modified for setting default Chat/Cloud vertical.
2 Integrate 3rd party web-apps in Zimbra with the AnyFrame Zimlet. No coding needed, add a frame as a tab.

See also: you can also search Zimbra's Github for all open-source Modern Zimlets via

Zimlet Zimlets ModernUI React Preact Zimlet-CLI ZimletCLI

Jump to: navigation, search