Basic Zimlet Definition Tags

Basic Zimlet Definition Tags

   KB 1366        Last updated on 2021-07-17  

(0 votes)
Warning: You are looking at legacy Zimlet documentation. For Zimbra Modern UI Zimlet development go to:


<zimlet> tag is the top level element for Zimlet definition file.

Supported attributes:

  • name - must match the name of Zimlet definition XML file.
  • version
  • description
  • target
    Space-separated list of targets. Valid values include "main" (default), "compose-window", and "view-window".

May contain following elements:

  • include
  • includeCSS
  • resource
  • handlerObject
  • zimletPanelItem
  • contentObject
  • serverExtension
  • userProperties


Indicates Javascript files used by the Zimlet. The listed Javascript files are automatically loaded by the Zimlet framework in the order specified in the definition file.


Indicates CSS style sheet files used by the Zimlet. The listed CSS files are automatically loaded by the Zimlet framework in the order specified in the definition file.


Indicates additional resource files, such as XSL, GIF, or JPEG images.


Name of the top level Javascript object. The object must declare ZimletBase as the prototype. The object is automatically instantiated by Zimlet framework.


Creates an entry in the Zimlet panel area.

Supported attributes:

  • label
  • icon

May contain following elements:

  • toolTipText
  • dragSource
  • contextMenu


Specify the behavior of content object in the document that Zimlet matches.

May contain following elements:

  • matchOn
  • toolTip


Specify the rules for server side indexing.

Supported attributes:

  • hasKeyword
  • extensionClass
  • regex


Lists per-user properties used by the Zimlet.


Verified Against: Zimbra Collaboration 8.0, 7.0 Date Created: 04/16/2014
Article ID: Date Modified: 2021-07-17

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search