Difference between revisions of "DevelopersGuide"

m (Zimlet Development Guide)
(Zimlet Development Guide)
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== Zimlet Development Guide ==
 
== Zimlet Development Guide ==
  
This page contains a list with links to all developer documentation for Zimbra 9 / Modern UI.
+
This page contains a list with links to all developer guides for Zimbra 9 / 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.
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+Zimbra 9 Zimlet Development Guide
 
|+Zimbra 9 Zimlet Development Guide
 +
|1
 
|Practical guide to writing Zimbra back-end extensions (Java).
 
|Practical guide to writing Zimbra back-end extensions (Java).
 
|https://github.com/Zimbra/zm-extension-guide
 
|https://github.com/Zimbra/zm-extension-guide
 
|-
 
|-
 +
|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.  
 
|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.  
 
|https://github.com/Zimbra/zm-zimlet-guide
 
|https://github.com/Zimbra/zm-zimlet-guide
 
|-
 
|-
 +
|3
 
|How to use internationalization and custom metadata to create a Sticky Notes Zimlet.
 
|How to use internationalization and custom metadata to create a Sticky Notes Zimlet.
 
|https://github.com/Zimbra/zimbra-zimlet-sticky-notes
 
|https://github.com/Zimbra/zimbra-zimlet-sticky-notes
 
|-
 
|-
 +
|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.
 
|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.
 
|https://github.com/Zimbra/zimbra-zimlet-attacher
 
|https://github.com/Zimbra/zimbra-zimlet-attacher
 +
|-
 +
|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.
 +
|https://github.com/Zimbra/zimbra-zimlet-tags
 +
|-
 +
|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.
 +
|https://github.com/Zimbra/zimbra-zimlet-appointment
 +
|-
 +
|7
 +
|How to write a Zimlet that can be configured by the administrator.
 +
|https://github.com/Zimbra/zimbra-zimlet-configuration
 +
|-
 +
|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)
 +
|https://github.com/Zimbra/zimbra-zimlet-email-templates
 +
|-
 +
|9
 +
|Fully functional Zimlet. Use Voice Message Zimlet to record a message from Zimbra.
 +
|https://github.com/Zimbra/zimbra-zimlet-voice-message
 +
|-
 +
|10
 +
|Guide on interacting with Zimbra Composer using Zimlets. Signature Template example Zimlet. An alternative to guide 8.
 +
|https://github.com/Zimbra/zimbra-zimlet-signature-template
 +
|-
 +
|11
 +
|A guide on using Zimlet User Properties to store per-user Zimlet settings. Demos the use of GraphQL mutations.
 +
|https://github.com/Zimbra/zimbra-zimlet-user-properties
 +
|-
 +
|12
 +
|How to add an onkeyup event to the Zimbra Composer, interact with the composer while the user is typing.
 +
|https://github.com/Zimbra/zimbra-zimlet-social-justice
 +
|-
 +
|13
 +
|The X-Spam Zimlet displays X-Spam headers in the UI. Introduces @zimbra/api-client a GraphQL client for making SOAP API requests.
 +
|https://github.com/Zimbra/zimbra-zimlet-xspam
 +
|-
 +
|14
 +
|The Google Translate Zimlet shows you how to deal with a specific message in conversation view mode of Zimbra.
 +
|https://github.com/Zimbra/zimbra-zimlet-google-translate
 +
|-
 +
|15
 +
|Create a Milter extension for Zimbra. Add or replace email headers, filter out specific email content. Automatically add BCC recipients, add disclaimers, etc.
 +
|https://github.com/Zimbra/custom-milter
 +
|-
 +
|16
 +
|Zimlet Events when the user logs-out or sends an email
 +
|https://github.com/Zimbra/zimlet-cli/wiki/Capture-Zimbra-events-inside-a-Zimlet
 +
|-
 +
|17
 +
|A Zimlet that alerts you when forgetting to attach an attachment when sending an email. (Implementation of guide 16)
 +
|https://github.com/Zimbra/zimbra-zimlet-attachment-alert
 
|}
 
|}
 +
 +
See also: https://wiki.zimbra.com/wiki/ModernUI-Zimlets
 +
 +
Zimlet Zimlets ModernUI React Preact Zimlet-CLI ZimletCLI
  
 
[[Category:ZCS 9.0]]
 
[[Category:ZCS 9.0]]

Latest revision as of 05:53, 17 July 2021

Zimlet Development Guide

This page contains a list with links to all developer guides for Zimbra 9 / 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.

Zimbra 9 Zimlet Development Guide
1 Practical guide to writing Zimbra back-end extensions (Java). https://github.com/Zimbra/zm-extension-guide
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. https://github.com/Zimbra/zm-zimlet-guide
3 How to use internationalization and custom metadata to create a Sticky Notes Zimlet. https://github.com/Zimbra/zimbra-zimlet-sticky-notes
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. https://github.com/Zimbra/zimbra-zimlet-attacher
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. https://github.com/Zimbra/zimbra-zimlet-tags
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. https://github.com/Zimbra/zimbra-zimlet-appointment
7 How to write a Zimlet that can be configured by the administrator. https://github.com/Zimbra/zimbra-zimlet-configuration
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) https://github.com/Zimbra/zimbra-zimlet-email-templates
9 Fully functional Zimlet. Use Voice Message Zimlet to record a message from Zimbra. https://github.com/Zimbra/zimbra-zimlet-voice-message
10 Guide on interacting with Zimbra Composer using Zimlets. Signature Template example Zimlet. An alternative to guide 8. https://github.com/Zimbra/zimbra-zimlet-signature-template
11 A guide on using Zimlet User Properties to store per-user Zimlet settings. Demos the use of GraphQL mutations. https://github.com/Zimbra/zimbra-zimlet-user-properties
12 How to add an onkeyup event to the Zimbra Composer, interact with the composer while the user is typing. https://github.com/Zimbra/zimbra-zimlet-social-justice
13 The X-Spam Zimlet displays X-Spam headers in the UI. Introduces @zimbra/api-client a GraphQL client for making SOAP API requests. https://github.com/Zimbra/zimbra-zimlet-xspam
14 The Google Translate Zimlet shows you how to deal with a specific message in conversation view mode of Zimbra. https://github.com/Zimbra/zimbra-zimlet-google-translate
15 Create a Milter extension for Zimbra. Add or replace email headers, filter out specific email content. Automatically add BCC recipients, add disclaimers, etc. https://github.com/Zimbra/custom-milter
16 Zimlet Events when the user logs-out or sends an email https://github.com/Zimbra/zimlet-cli/wiki/Capture-Zimbra-events-inside-a-Zimlet
17 A Zimlet that alerts you when forgetting to attach an attachment when sending an email. (Implementation of guide 16) https://github.com/Zimbra/zimbra-zimlet-attachment-alert

See also: https://wiki.zimbra.com/wiki/ModernUI-Zimlets

Zimlet Zimlets ModernUI React Preact Zimlet-CLI ZimletCLI

Jump to: navigation, search