Lot of times you need to make a quick note about something in an email or a little reminder for yourself like “I need to confirm those dates” or “add John’s phone number” or “attach the PPT” etc.  But there is no easy way to capture that thought instantly.  Sticky Notes Zimlet helps solve that problem by allowing you to attach a note to a particular email.

The Sticky Notes Zimlet is really easy to use…all you do is make a quick note and attach it to your email. Once you attach your Sticky Note, it will automatically pop up the next time you re-open your email.

How to create your own Sticky Notes:

Simply select an email and click on the “StickyNotes” toolbar button or drag and drop your email onto the Zimlet to add your notes.

StickyNotes in Contacts (v1.6+):

Similar to emails, you can attach notes to Contacts as well. Simply select a Contact and press “StickyNotes” button.

StickyNotes in Calendar (v1.6+):

Similar to emails, you can attach notes to Appointments as well. Simply select a Contact and press “StickyNotes” button.

How to Enable the Sticky Notes Zimlet:

Click on “Sticky Notes” in the left overview pane and select the following:

a. Select “Add StickyNotes button to main toolbar” checkbox

b. Select “Enable Sticky Notes Zimlet” checkbox

How to Find Your Sticky Notes (via Tags):

After your enable the Sticky Notes Zimlet, a yellow-colored tag called “Emails with StickyNotes” is created. When you attach a StickyNote to your email message, your email or conversation will have a yellow tag. This yellow tag is removed when the Sticky Note is deleted.

How to Search for a Sticky Note (via Tags):

You can search and keep track of all of your Sticky Note emails by clicking on the tag or by searching for them in the main search bar.

Download:

You can download the Zimlet here:  http://gallery.zimbra.com/type/zimlet/sticky-notes

Release Notes:

1. Version 1.6 now allows attaching StickyNotes for Contacts & Appoints as well

2. Version  1.5 adds scalability via CustomMetadata API. You can now add Sticky Notes to as many of your emails as you want.

2. Version 1.5+ is only compatible with ZCS 6.0.7+

Every day, when you first login, this Zimlet scans your calendar and sends out a summary email about the current day’s events.

This Zimlet helps both frequent and lite calendaring users in different ways:

1. For power-users, this is like having a personal assistant; who summarizes appointments for the day, providing a concrete idea as to how many meetings you have.
2. For general-users, the Zimlet helps in reminding you that there is a meeting to prepare for (in case you’ve forgotten)

To make it easier to read, the appointments are sorted and divided along two simple categories:  Those that need your immediate attention (e.g confirmed or new events) and others that don’t (those you’ve marked tentative, free, out-of-office, or declined but not yet deleted).

Download:

Available in our Zimbra Gallery over here

Rate & Review:

After you have used the Appointment Summary Zimlet, please come-back to share what you thought of it at our Gallery.

PS: This is one of our favorite recent Zimlets within the Zimbra team, and we hope you enjoy it too!

For years, the Zimbra Collaboration Suite (ZCS) has exposed mailbox data via REST. And lately, a few customers have asked about the Zimbra REST API (e.g. How is the API used? What methods are available? How does the Zimbra REST API compare to the Zimbra SOAP API?). So I thought it would be good to revisit the topic.

Some background: REST (REpresentational State Transfer) is an approach for building application services that make application resources available via a URL. There is more than ample information about REST out there on the web so I’ll just point you to the REST Wikipedia article for simplicity.

The Zimbra REST API is a great mechanism for reading user mailbox data and outputting that data in different formats (everything from XML-and-JSON to RSS-and-Atom to iCal-and-VCF). In addition to reading data, we’ve exposed methods to import items — like contacts and appointments — into a mailbox. This capability is very useful when performing a migration (i.e. “how do I import contacts from one system into Zimbra?”)

Here is an example of using the REST API to read mailbox data: if you want an output of messages from the “john doe” inbox folder, you call the Zimbra REST API like this:

http://localhost:7070/home/john.doe/inbox?fmt=xml

You can try this method against a Zimbra server via a browser but more commonly customers use the REST API methods from perl scripts or PHP applications…or even just from the command line using curl.

Here is an example of importing contacts into the “john doe” account: perform a POST of a CSV file to the “contacts” folder. The following command shows importing contacts using curl:

curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts?fmt=csv

That’s just a couple examples and as you can see, the REST API is a simple yet powerful mechanism for accessing mailbox data. For more information on the Zimbra REST API (i.e. information on authentication, output formats or just a list & syntax for the REST API methods), here is a link to Zimbra REST API Reference document:

http://wiki.zimbra.com/index.php?title=ZCS_6.0:Zimbra_REST_API_Reference

One more thing: A very common question is: “why does the SOAP API support so many more functions than the REST API?” Well, the Zimbra REST API is different (in form and function) than the Zimbra SOAP API. At a high level, it’s really an apples-to-oranges comparison. The REST API is for accessing user mailbox data, and the SOAP API is for executing functionality on the server (which can access user mailbox data and also perform account and administrative functions).

The Zimbra SOAP API is the foundational platform service that the Zimbra Web Client uses to communicate between the browser and the Zimbra server. As you can imagine, to create the rich interface experience the Zimbra Web Client delivers, the SOAP API is very complete with advanced and complex functionality, much more than the REST API. To re-create all of this complex functionality in REST API would be a challenge as well as take significant time. So as the alternative, we expose the SOAP API for direct use by our customers & partners.

But that’s another story…I’ll save the Zimbra SOAP API discussion for a different day…until then, enjoy the REST API and happy coding!

For the last post in the Power Zimlet Series (Attach Email, Ignore Conversations, Contact Organizer, Task Reminders), we are ending on a lighter note.

Zimlet 5: Emoticons in Email

Who doesn’t love emoticons? They are core part of life online and I admit am a huge fan of them.

Historically Zimbra has always supported emoticons – but only in IM.   For ZCS 6.0 (coming very soon) we have made some enhancements to the Zimlet platform (including the ability to create new ‘application tabs’) that enable us to now support emoticons in email compose as well.

When you write an email you can simply enter your standard text emoticon [example: :)  ], or now you can select an emoticon visually using a button in the compose window that will insert the text for you (see below).  When you receive an email, emoticon text is automatically displayed as an image.

Now, emoticons are great but occasionally you might not want to see emoticons in your email, may be because some code or some text that’s unintentionally matching emoticons. So, we have added “Temporarily Disable in Mail” to help disable emoticons. Right click on the Zimlet in the left pane, and select it, then reopen the email. Further, Double click on Zimlet in the over-view panel to permanently enable/disable it.

Enjoy!

PS: This will be shipped as a default Zimlet in ZCS 6.0.

In the last 3 posts in the Power Zimlet series we covered tools for improving email and contacts: contact organizer, ignoring conversations and attaching emails to messages.  Today we are turning to a new application in ZCS that many, including myself, find incredibly useful – Tasks.

Zimbra Collaboration Suite has had the Tasks application for some time now, but as of yet it doesn’t support reminders.  And without reminders it is hard to keep track of Tasks at hand, making it sometimes hard to use.  This new Zimlet fills that gap by providing a reminder digest once a day.

Zimlet 4: Tasks Reminders

How the Zimlet works:
Once a day (when you first login), this Zimlet searches for your Tasks (and shared Tasks) and displays a list of all Tasks that are overdue, in-progress, etc. This list is shown only for Tasks that are due 2-weeks (14 days) from today and continues to show for 2-weeks post due-date. This date range is user configurable.

Additional Features:
- It also has a “Send Email” Feature, which helps in follow up of tasks. For example: You might want to send mail to someone asking why they are lagging behind their tasks, etc.
- You can click on the Zimlet and press “Show Again” to see the Reminder dialogs again anytime.

Below is a picture of the Tasks Reminder dialog that appears (sorted by date urgency).

As usual, you can get this and learn more in the Zimbra Gallery.

Up next: Emoticons in Email

As a long-time Zimbra developer and employee, I’ve spent countless hours each week using Zimbra email.  I love the overall experience, especially because I have been able to tailor it to my personal style using Zimlets.  They are easy to create and over time I have built quite a few.  So without further ado, the following is the first of a 5 post series featuring new Zimlets which I think are incredibly useful and empower Zimbra users.

Zimlet 1: Attach Emails

Every so often I miss the ability to easily to attach an earlier email while composing an new email message.  This Zimlet does just that, it adds an “Attach Email” tab in the Attachments dialog in Mail Compose. Once you click on the Email tab you can search for emails that you want to attach or just scroll the list. You can even ‘browse’ for emails by clicking on the folder tree.  Finally, something I really like is with any of these methods you can also select multiple emails and attach them simultaneously.

Here is how it works… assume you are composing or replying to an email and now you want to attach some earlier email…

1. Click on the Add Attachment Button

2. Click on the Attach Mail tab

3. Search or browse for emails (in this case below I’m looking in the Sent folder)

4. Select the email(s) you want to attach – ctrl to select multiple.

5. Click Attach button

You can repeat these steps again if you want for more emails or other attachment types.

Note – you need ZCS 5.0.15 and above or 6.x to use this Zimlet.

Next post… Ignoring Conversations.

Zimbra’s open source roots have always been of great importance to both the company and the Zimbra Collaboration Suite (ZCS).  When we set out to build a new collaboration system over five years ago, we wanted to bring a fresh perspective to the market, and a big part of that was our commitment to being open source.  We understood sharing ideas within the open source community keeps you a one step ahead of competitors by iterating faster to give users what they want.  A great example demonstrating how the community has flourished is the Zimlet development program.

Zimlets are simple but powerful extensions of ZCS that connect users’ email, calendar, and contacts with any number of outside services (for a couple of recent examples see Alfresco and Peru and TripIt).  Zimlet development growth in the community has been strong and steady, and we are excited to continue supporting the community’s work by providing a place where developers can feature the best of their integrations to share with other Zimbra users.   So, today we are launching an updated Zimlet Gallery where you can pick and choose from many handy new ZCS extensions.

At the same time, we also love seeing our Yahoo! friends continue to embrace openness as part of the Yahoo! Open Strategy. In addition to this announcement today, a number of our Yahoo! brethren are extending their platforms to become more open. Today, Yahoo! Mail is introducing applications which enable people to make online payments, access personal photos and more easily send large files directly from their inbox. In addition, My Yahoo! is adding even more third-party applications, driving enhanced personal productivity for users directly from their My Yahoo! start page. You can read more about the Mail and My Yahoo! updates on the Yodel and YDN blogs.

As part of the Zimlet Gallery launch today, we’d like to introduce you to a few new third-party Zimlets, including:

Xythos Zimlet – The Xythos Zimlet allows you to drag and drop email messages and file attachments directly into Xythos’ Enterprise Document Management System.  Secure document management is popular in the enterprise and universities; integration in email is key for ubiquitous adoption.

Processmaker Zimlet – The Processmaker Zimlet helps streamline workflows, like time-off requests, all within Zimbra email (see above).  This Zimlet is already becoming popular and is being deployed at Access America Transport and Ministerio de Vivienda by our Zimbra Partners.

In addition, Zimbra developers have created a handful of new Zimlets, including:

Place Sticky Notes on Email – The new Sticky Notes Zimlet allows you to attach and tag emails with “notes.” One can leave comments, reminders, additional info about the email and more. And Zimbra’s powerful search can search through emails based on the contents of the tags/notes attached to the email.

Email Highlighter – The Colored Emails Zimlet allows you to apply personally assigned colors to emails from specific senders such as a family member, your boss, etc. You can identify senders by color, but you can also create colored emails through tags, making it easier to prioritize any inbox.

Save Email as Documents – With one click, the Email-2-Doc Zimlet lets you save an important email as a Zimbra Document; it will automatically save any attachments as links in the Document as well. The email can then be edited and shared with others.

At Zimbra we’re always trying to provide our community with the most efficient tools for organizing email, address books, calendars and web documents, so it’s only natural that we look to work with other with companies who are as enthusiastic about streamlined processes as we are, and share the same commitment to open standards.

One of the latest things you can now do with Zimbra is integrate with TripIt – an innovative service that organizes and shares your travel itinerary. With TripIt, users simply email their booked travel plans to TripIt, and the service will create a master travel itinerary plan. Users may then access or share this itinerary online, via their mobile device, or from their personal calendar.

This is where we step in. Because Zimbra is an open platform, users of TripIt can instantly access flight times, hotel arrivals, and much more from the convenience of their own Zimbra calendar automatically.  The integration is especially useful in business settings, as Zimbra’s shareable schedule options and synched group calendars allow employees to view their own work-related travel itinerary alongside their co-workers’ in a shared Zimbra calendar. This way, all are kept in the loop regarding everyone’s travel whereabouts at work.

This integration also takes advantage of a number of open standards that are supported by Zimbra and TripIt including email and iCal.  Here’s how you can get TripIt integration within your Zimbra account:

1.   Go to TripIt.com and create an account
2.   When you receive an email from your travel company, forward it to plans@tripit.com
3.   Go to TripIt and find the iCal feed URL and find the URL to subscribe to your calendar
4.   Go back to Zimbra and create a new calendar called “My Trips” or whatever you prefer to call it
5.   Paste in the iCal URL after you select sync with external cal
6.   Right click refresh and your trip calendar should appear!

Someone in the forums recently asked about ways to migrate individual accounts from one ZCS instance to another, so thought I’d share the enlightenment with all. Whether you are going from an on-premise install to a hosting provider, want to create handy archives of old employee accounts, or just need to duplicate mailbox contents of a user; the syntax in this article proves remarkably useful, and applies to all editions.

There are a multitude of comparable RFE’s on addressing this need via different approaches. (Bugzilla entries 19630, 29573, 28443 & 30163 to name a few.) Some want graphical tools to browse data and selectively migrate certain things, while others would be happy with a cross LDAP zmmailboxmove.

Depending on your situation, several backup tools can take care of a large portion of your daily needs; and there are ways to do Zimbra-to-Zimbra migrations using the Network Edition’s backup and restore capabilities – however they require admin abilities on both systems. Meanwhile, most of the frequently used open source backup solutions are simply an “all accounts at-once” approach. So what to do when you need to move from your personal setup to a hosting provider? Or if you’re a hosting provider, move a tiny handful of accounts to a separate infrastructure? Before diving into the wiki on user migration for info on Imapsync, REST exports, CURL imports, etc; there’s a handy way to avoid the “one item type at-a-time” transfer methods.

In ZCS 5.0.9+ you can export an entire mailbox with:
/opt/zimbra/bin/zmmailbox -z -m user@domain.com getRestURL “//?fmt=tgz” > /tmp/account.tgz

Next transfer via rsync, scp, sftp, etc. You’ll also need to create the account on the 2nd server if the desired account doesn’t exist at your destination server yet.

Then import with:
/opt/zimbra/bin/zmmailbox -z -m user@domain.com postRestURL “//?fmt=tgz&resolve=reset” /tmp/account.tgz

The resolve= paramater has several options:

• “skip” ignores duplicates of old items, it’s also the default conflict-resolution.
• “modify” changes old items.
• “reset” will delete the old subfolder (or entire mailbox if /).
• “replace” will delete and re-enter them.

‘Reset’ will be a bit faster on an empty destination mailbox because it skips most dupe checks.

Note: There were some duplication fixes and additional issues (mainly sync related) corrected with the tar formatter in 5.0.10.

Not a Zimbra Admin? Users can get the same zip/tar formatter on REST URL’s by visiting:
http:// server.domain.com/home/user?fmt=zip&query=is:anywhere

The zip format has been around for a long time, but doesn’t contain account & item metadata like the tar formatter automatically does:
http:// server.domain.com/home/user/?fmt=tgz

Infact, this same technique is currently used in Zimbra Desktop’s alpha backup solution.

If this approach doesn’t scale performance wise for your situation, or you simply don’t want to have everyone hit a REST URL for 30GB mailboxes all at the same time, here’s a collection of helpful scripts and other ways to systematically migrate:

Mysqldump & rsync with an interesting blob management technique: Zimbra2Zimbra

Imapsync for mail + postRestURL for contacts, calendar & filters: ZimbraMigrate (Expand the concept for tasks, documents, and briefcase items.)

Another method that could be extrapolated upon for migrations: Per User Mailbox Backup (OE Version – Zimbra :: Wiki)

Most of these solutions aren’t going to respect share permissions, but when pulling an account out of an environment that’s to be expected.

Zimlet spin-offs:
- Mail backup options for end users (.eml)
- Zimlet to save email in a txt file (.txt or html)

The above Zimlets are aimed at making quick self-copies & not for restores, but there are many methods for putting messages back into Zimbra, including tools like zmmailbox addMessge, zmlmtpinject, CURL, etc; for more info checkout these threads: Recover data from store folders & Moving Folders between users

If moving your entire server, I’m a huge fan of the install.sh -s trick when using NE backups to do so isn’t an option.