From Zimbra :: Wiki

Jump to: navigation, search
Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

UPDATE This page holds a Table of Contents of all my pages EXCEPT:

Please remember to search them as well.



   Article-check.png  - This is certified documentation and is protected for editing by Zimbra Employees & Moderators only.

Admin Article

Article Information

This article applies to the following ZCS versions.
  ZCS 8.0 Article  ZCS 8.0
  ZCS 7.0 Article  ZCS 7.0
  ZCS 6.0 Article  ZCS 6.0

Information For New Support Customers

Details On Response Times and What's Supported

Please review the Support Overview and Support Program, specifically the "Exclusions" and "Reasonable Use Policy" sections. You can also find a link to the Support Plan document when you log in to your Zimbra Support Portal account (Network Edition Customers). As of 12 August 2008, it includes the following statement:

Requests that are excluded from support include but are not limited to: performing initial installs of customer systems, performing migrations, performing upgrades of customer systems, performing configuration changes to add or remove servers or services, and testing a customer’s system. Zimbra Professional Services may be available to assist with these projects.

New Network Edition Customers

Your sales contact should already have made a support record for your company and added one or more user accounts for our primary support tool, the Support Portal. Please Contact Sales if you are unsure whether you and/or your company have been set up for access to the Support Portal. Additional user accounts can be associated with your support record if necessary by submitting a case to support with the following information:

  • Full name of new contact
  • Title of new contact
  • Email address of new contact
  • Best phone number to reach new contact (this will potentially be used in the event of an email outage)

Understanding The Support Process For Urgent Issues

In order to receive the most efficient and timely response, please follow this procedure.

  1. Create a new case via the Support Portal
    • In the lower section of the navigation menu on the left, choose Case Menu > Submit A New Case
    • When you need urgent help, please open a case through the Support Portal instead of sending email to support@zimbra.com. Cases submitted through email will not be assigned the appropriate urgency for an outage or otherwise urgent situation, and they will appear lower in priority in our incoming case queue. When submitting a case through the Support Portal you may assign the appropriate urgency level according to scope, impact, and urgency of issue.
    • Please include as much detail as possible to allow us to effectively prepare prior to calling you. Having details of the situation allows us to reach out to any resources (people) we may feel are needed prior to calling you back.
    • Include contact information in the new case record. Desk phone, cell phone, alternate email address, and YahooIM handle are all useful. This allows us to contact you for clarification as needed.
  2. Call the Support Phone Line
    • If you get the voice mail - don't panic or hang up without leaving a voice mail.
      • Give your name and company first
      • Provide the number of the case that you created in the Support Portal
      • Summarize the outage situation
      • Mention your contact information
  3. Continue to work on the issue yourself.
    • Promptly update the case with all relevant information you discover
      • Left-hand lower section, Case Menu > Case Management
      • If you can't "email", use the Comments section with your case record to input the information.
  4. If you have not received a response from us, please try updating the case and calling into the Support Phone Line again
    • Note that depending on the day and hour of your outage, time might be needed for the information to route to the on-call staff and for them to get into a position to respond.

How To Communicate Support Need Clearly

Over the years, open source luminary Eric Raymond has assembled a guide to getting help with technical issues online. Bear in mind that the guide has been written for those seeking free help, so the overall guide taken at face value is most applicable for posting to the Zimbra Forums. There is, however, plenty of useful guidance for those submitting support cases. The complete guide is available online as How To Ask Questions The Smart Way. Here are a few examples:

  • Use meaningful, specific subject headers
  • Write in clear, grammatical, correctly-spelled language
  • Be precise and informative about your problem
  • Describe your problem's symptoms in chronological order

Simon Tatham, author of the PuTTY software, wrote a similar guide for How to Report Bugs Effectively.

Support Tools

Case Management

Subscribe To RSS Feeds

Recently we completed an internal RFE for our sites to have unrestricted (anonymous) access for RSS feeds. The new RSS feeds are:

Clicking on an article from the RSS feed will direct the user to the login page with an "Authorization Required" message.

Email Communication

When you send emails to support@zimbra.com, it will create a case for us and show in our new case tool. What is important to note though, is our tools first check to see if the subject line of the email has SF: Case ########: in it. If so, it redirects that email to update an existing case. If those values aren't in the subject line, it creates a new case. So, if you wanted to update an existing case - let's say case number 00000001 - you would have your subject line as "SF: Case 00000001: some text of the topic" .

New Cases Created By Email Are Always Sev-4

If you send your initial support request via email to support@zimbra.com it will automatically be set at a "Severity Level 4", which is the lowest priority. If you need your case set to a higher severity level, please create your case via the support portal page where you can set the severity level. At this time, you can not change a case severity level once it's made via the support portal case management tools.

Always Include support@zimbra.com In Case Email Threads

If emails for your case do not include the support@zimbra.com address, there's a good chance the support member your working with will not be updated about your response correctly.

Sales Force Case Comments

Sales Force [zimbra support portal case management tool] has the option to do "Case Comments". Please use this only when necessary - for example, your email isn't working. Currently, case comments from sales force don't work appropriately with our other tools because it doesn't create a email subject to match the "SF: Case ########:" pattern and it also doesn't change the status of the case to reflect "customer replied". The email subject line is important because most of us here at support use the Zimbra's email conversation view and also "tagging" of our case threads. The case comments from Sales Force doesn't work against this. And of course, the case not being updated as "customer replied" causes issues as it most likely leaves it in the state of "Awaiting Customer Response".


Zimbra uses the Bugzilla bug database system. This is a critical tool for Zimbra development, and allows anyone with an account to interact directly with Zimbra developers and product managers. It has been suggested that customers who ignore Bugzilla do so at their own peril. That may sound a little over the top, but you will find that Bugzilla provides fascinating insight and connection to the development process. If you'd prefer not to work directly with Bugzilla, Zimbra Support will communicate relevant case information to the developers. On the other hand, if you'd like to get hands-on with the bug database, here are some basics to get you started.

Create a Bugzilla Account

This is open to anyone. It's not tied to your Network Edition support id.

Recommended Saved Searches

Once you've created your account and logged in, create a search to list any bugs whose progress you are following (i.e. you have added your email address to the CC: field).

  1. Go to http://bugzilla.zimbra.com/query.cgi
  2. Decide if you want to adjust the highlighted items under "Status:". You might choose to only display bugs that are still not fixed (UNCONFIRMED, NEW, ASSIGNED, REOPENED), or you might choose to display all of them, or you might choose to create two different saved searches to accommodate both cases.
  3. Under "Email Addresses, Bug Numbers, and Votes", make sure only the checkbox for "a CC list member" is selected. The "contains" field should then include your email address.
  4. Click on "Search" at the bottom.
  5. Scroll down to bottom of search results window, type a name of your choice (e.g. "My CC's") in the field for "Remember Search as", and click the "Remember search" button.

When you are logged in, your custom searches will show up in the "Saved Searches:" section at the bottom of Bugzilla pages. You can reconfigure or delete them under the "Saved Searches" tab of your Bugzilla Preferences.

When a support case is related to a given bug or RFE ("request for enhancement"), it will be cross linked internally between Bugzilla and our case management system. Once you know the bug number, you can add yourself to the CC: field and Bugzilla will notify you of changes via email. With the saved search that lists bugs you are following, it will be easy for you to manage those as well.

My Saved Bugs

There is also a default saved search, "My Bugs". This will list any bugs or RFE's that you have created.

Bugs And RFE's Related To Your Support Case

When you have a case that's related to a bug or RFE, the support staff will add the case number to the bug or RFE, which serves to increase its priority (not the Bugzilla "Priority" field). Note that case numbers are not visible publicly.

Here's what you can do in addition:

  • Login to bugzilla and navigate to the page of the bug or RFE in question.
  • Add your email address to the CC field and save.
    • You will be notified of updates by email.
  • Click on the Vote button.
    • This is another way to increase the priority.

At this point, the issue in question can be tracked through Bugzilla, and the support case will typically be closed.

Use The Advanced Search

  • Navigate to http://bugzilla.zimbra.com/query.cgi
  • Click on the "Advanced Search" link if you are not already on the Advanced Search page.
  • Shift-click all the items under "Status" if you'd like to include bugs that have already been fixed.
    • The default search function only queries against "UNCONFIRMED, NEW, ASSIGNED, REOPENED".
  • Add search terms
    • Use the "Summary:" field to search bug titles.
    • Use the "A Comment:" field to search through bug comments.
  • You can also narrow your search by choosing from the "Component:" field. This can be useful when you're using generic search terms, but it can be tricky to identify the appropriate component.

Privacy Option For Bug Postings

You must have a bugzilla account and be logged in to use the privacy option.

When creating a bug, you can select an option to only make that information available to you [the poster] and with Zimbra staff.

The page will have an option that states: Make bug visible only to reporter and Zimbra

If you need this privacy option but also identified an existing bug that is related, you could create your new bug with the privacy choice and just include in the comment the other bug number. Even though your bug might become a duplicate of the other, you'll still be able to post to your private bug - maintaining the privacy option.

Support Staff Can Make All Bugzilla Entries Private

The Zimbra Support staff has the option to make any existing comment, attachment, or bug private to the internal Zimbra staff. They can do this on behalf of a customer you needs a post they made switched from public to private.

Also, for some situations, it might be easier to just send the 'data' to the support team via your support case. The support team can then add to the bug the relevant data with the appropriate privacy options.

Also - data sent to our ftp site is private and secured. We generally purge data after 60 days.

Zimbra Product Portal Page - The Birdseye View Of Bugzilla

Zimbra's Product Portal Page is like the executive summary of the bugzilla activity and future release information.

The most useful part of this site is the ability to drill down on a ZCS version until you'll be able to see the various targeted release dates. For example, clicking on the 6.0 (GunsNRoses) listing under Releases will show the subversions of 6.x. This will show a target date for the release, if one has been made public yet. You then can click on a particular version, 6.0.4 for example. This will now show all bugs and rfe's tied to the 6.0.4 release.

Zimbra Forums

The forums provide a place where the greater Zimbra community (server administrators, users, developers, commentators, etc) can work together on solving problems. There is a wide range of experience among the community, and a long history of issues available for searching.

Create A Forums Account

This is open to anyone. It is not tied to your Network Edition support id.

Zimbra Wiki

The wiki also centers around the community, providing a site where anyone with an account can contribute documentation, especially how-to guides, non-standard configurations, and topics related to but external to ZCS.

Create A Wiki Account

This is open to anyone. It is not tied to your Network Edition support id.

Why is this important?

  • It allows you to participate in improving the wiki articles and content. Note that you need to be logged in to make edits.
    • Create your own articles if you find something missing that might prove useful to others.
    • Improve existing articles.
    • Add to the "discussion" page for an article. This is a good place to add comments for those less inclined to be bold and modify the main article.
      • You can propose questions and other things here as well.
  • You can add articles to your "watchlist" in order to monitor your favorite articles for changes.
    • In your wiki preferences you can specify whether to be notified by email when different events occur.
  • You can create your own personal section on the wiki.
    • Use the category of "community sandbox" at the bottom of them.
      • [[Category: Community Sandbox]]
    • If you decide to create sandbox articles, the wiki convention is to prefix the topic with your wiki username: Username-Topic
      • For example, the original staging page for this article was written by Ajcody, so the sandbox article was named Ajcody-New-Customers-Users
    • Use {{:Special:PrefixIndex/YourUsername}} to automatically generate a list of these articles in a wiki document, on your user profile page for example
      • This wiki tag on Ajcody's profile page causes a list of all of his notes articles to be displayed: {{:Special:PrefixIndex/Ajcody}}

Yahoo! IM

Most of the Zimbra support staff have Yahoo! Instant Messenger accounts, and this can prove useful even when on a telephone call since it speeds up the sharing of copy-and-pasted information. Communication over IM is available at the discretion of support staff.

Create A Yahoo! IM Account

This is open to anyone. It is not tied to your Network Edition support id.

Remote Server Access

Conditions For Remote Access

In some cases, a Zimbra TSE may request access to the system in question. Direct access is not generally the preferred method of investigation on cases, and we typically request that the customer please perform the hands-on administration of your system, with which you would be far more familiar than Zimbra; in some cases however, direct access may be considered an option for investigating the situation.

Zimbra TSE's will need some way to communicate with someone on your IT staff when they are going to log in to your servers. Zimbra Support helps and facilitates customers with their problems but we are not the "administrators" of customers servers and can't make independent decisions on what to do or not on their servers. We need to have access to immediate forms of communication [phone, IM, etc.] with someone at the company with the authority to make those decisions.

Remote Access Starts With Webex

Support agents can setup Webex sessions with customers when the situation calls for it. The standard policy is to use Webex for various legal & other policy justifications. Support staff will give guidance to the customer over the Webex session for the particular tasks in question. Customer participation is required throughout the Webex session. Other forms of access, ssh for example, should occur along side the Webex session. Ssh would use the screen utility mentioned below to accomplish this.

Your Webex meeting request will most likely also include a telephone conference number and instructions on how to file transfer log files as necessary.

Secondary Remote Access Options

Support SSH Keys
Note that it is not required that customers allow remote server access.
Updated: Switched to rsa rather than dsa. [2010/02/23]

In the Zimbra Support Portal, a public key for ssh is available for situations when Zimbra support will log in to a customer server using ssh. You can allow remote connections for a user (typically zimbra or root) by logging in to the server as that user and following these steps.

Running the script command within the ssh/shell session is a good idea for both the support staff and customer. See the following script man page

1. Save the key file on the server as /opt/zimbra/.ssh/zsupport_rsa.key.pub

2. Add the key to the user's authorized_keys file; command #1 outputs the current list of keys; command #2 appends the support key

1% cat ~/.ssh/authorized_keys
2% cat /opt/zimbra/.ssh/zsupport_rsa.key.pub >> ~/.ssh/authorized_keys
Note, the ~/ above will be setting up the ssh access for the same username that is running the commands. This is the "user" that you'll tell Zimbra is the login account for ssh to the server.

3. Verify that public key access is allowed by sshd

In the sshd config file (typically /etc/ssh/sshd_config), the value of the PubkeyAuthentication keyword should not be no. It's OK if it is not listed or if it is commented out; the default is yes.

4. Confirm, if appropriate, that the user you setup for ssh access will be able to su and/or sudo to gain zimbra and/or root access.

5. You'll then need to communicate to support that the key is setup and provide the necessary information:

  • username to login with
  • password if required for ssh access
  • the initial server [hostname/ipaddr] to ssh to and then how to access other servers inside if needed
  • way to gain zimbra or root access [su - [username] or via sudo]
It is up to you, how you would like to communicate the login information to support - email, IM, phone, etc..
Shared Sessions With the screen Utility

The screen command line utility allows multiple users to attach to the same terminal session. To start a new screen session, run screen -m or screen -R. To attach to an existing screen session, run screen -x. Additional documentation for screen is available online.

Sun Shared Shell Application

Sun Microsystems offers a java application to allow shared access to a terminal session. More information is available at their site.


This might interest some customers as well DimDim Web Conferencing . They have an OSS edition - DimDim OSS Edition

Installation and Migration Planning


Support doesn't do migration for customers, nor do we do migration planning. We can help if you run into issues during migration. Are there gray areas involved in this? Yes, of course. Some guidelines to follow:

  • Engage your sales contact about your needs.
    • Sales has access to pre-sales engineers and tools that can help plan your Zimbra deployment and migrations.
    • If your needs exceed the above, they can determine if our Professional Services group would be a good option for you.
  • When you start to engage the Support Team
    • Try to have specific questions or issues rather than large open-ended ones - those that imply support is doing the planning or migration for you.
    • It would be helpful if you documented your "plan" to the best of your ability and to share that with support as issues or questions come up.
      • This gives us more "concrete" information to work against.
    • Be prepared to know and investigate the technical requirements for the "other" mail server. Support will offer what we can but there is no obligation for us to know all the in's and out's of another mail server product. The exception to this would be when we are working with our tools that we developed for migration. And even then, there is a certain expectation of knowledge we require of the administrator in regards to the other mail system.
  • Remember, anyone can use the Zimbra Forums! Advise and help is free and open to everyone on the forums.

ZCS Upgrade And Install Specific Expectations

Zimbra support works on a break-fix model, we do not provide administrative services.

For upgrades and installs, we generally offer :

  1. Provide input on upgrade and install plans or the remaining questions that aren't addressed documentation resources listed below:
    • Latest Releases are at:
    • Documentation Resources are at:
    • Please see "System Requirements" under the "Documentation Resources" section for system requirements - server and client.
    • The "Installation Resources" section addresses:
      • Steps to install ZCS - see either the Single-Server Installation Guide or Multi-Server Installation Guide.
      • Checks, prerequisites, and other items you might need to address prior to installing.
    • The Release Notes & Upgrade Instructions addresses:
      • Steps to upgrade your server/s.
      • Checks, prerequisites, and other items you might need to address prior to upgrading.
      • List of notable bugs and RFE's addressed with this release. It will have a history going back through other older versions also.
    • After reviewing the above resources for your specific version, you should also login to the support portal for any other critical information that might not be listed in the Release Notes & Upgrade Instructions.
  2. We can add a customer's intentions about upgrading or installing ZCS on our team calendar. This allows our staff during our 'after hours' to be aware of customers that are intending to upgrade/install ZCS and that they might be submitting sev1 support cases if they run into issues.
  3. If the customer runs into a problem during an upgrade/install, they should submit a support case [setting the right severity level] for the specific issue at hand. The resolution of the support case is specific to the issue that was encountered. The support case is closed and the customer continues to do upgrade/install or other remaining steps they have independently.


Please take time to review the Administrators Guide. Noting what features you might want or need for the installation. It would be wise to make notes while your skimming the guide of features your wanting. Depending on the choices you have, it might drastically effect your installation steps. Do you want HSM, Archive & Discovery, Proxies - what type, and so forth.

The Basics

Starting Official Source Guides

Other Resources To Review

General Ways To Find More Specific Information:

Please Consider Your Backup Issues Before Deploying

Assuming you've consulted the other above resources as well.

More items to consider:

Be Aware Of DR Processes

Multi-Server Installations

Assuming you read or skimmed the above.

Starting Official Source Guides

Other Resources To Review

Migration Issues

This will pull all of them regardless of their "status".

Quick Tips

License issues (Dos/Unix New Lines)

Sometimes when customers get their license file on a Windows machine and then go about transferring it to the zimbra server they accidentally convert the license file to have windows new line characters that will not work when Zimbra goes to read the file. To see if this happen, to the following on the zimbra server:

vi file and then

:set list

Confirm you're not getting the ^M characters at the end. The ^M is the windows new line character, they'll need to be removed. There is a script or even rpm package you can get, usually called dos2unix, that will do this for you.

Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

General Notes

Actual General Notes Homepage

Please see Ajcody-General-Notes

Zimbra Variables

Ways to check on different zimbra variables.

su - zimbra
zmlocalconfig -i
zmlocalconfig -d
cd /opt/zimbra/conf/attrs
more zimbra-attrs.xml
cd /opt/zimbra/openldap/etc/openldap/schema/
more zimbra.schema

Made the following concerning zmlocalconfig's behavior:

Also, with newer versions of ZCS, you can get it via zmprov - for example:

#zmprov desc -a zimbraFreeBusyExchangeAuthScheme
        auth scheme to use

                   type : enum
                  value : basic,form
               callback :
              immutable : false
            cardinality : single
             requiredIn :
             optionalIn : cos,domain,globalConfig,account
                  flags : accountInherited,domainInherited
               defaults :
                    min :
                    max :
                     id : 611
        requiresRestart :
                  since : 5.0.3
        deprecatedSince : 

Addition note, example, for those checking source : src/6.0.7/com/zimbra/cs/account/ProvUtil.java.html

Zimbra Contact Fields For CSV Import Mapping

Please see /opt/zimbra/conf/zimbra-contact-fields.xml

This will show you what "fields" Zimbra is looking for and mapping to in regards to importing from another applications contact csv files.

One easy way to do this is the following:

  • From zimbra ajax client as a test user (or any old user) do an export Addressbook.
    • This is under the preference tab > Address Book > Import / Export > Export - select Addressbook and click Export button
  • Then open file file something like Excel or a Text Editor
    • Your only interested in the Top line - that gives the default fields for a Zimbra Addressbook.
    • You'll get something like this:
    • Note, ordering [left to right] isn't important. What is important, is the data lines up under the right column header.
  • With your other Mail system, export the addressbook to a csv file.
    • Open this file in another Excel window.
  • Copy the column data from the one Excel sheet and paste it into the appropriate column within the Zimbra Excel sheet.
  • Move as much as you can and then save.
    • For example:
"Apple Computer Inc.","1-800-MY-APPLE","","3","","http://www.apple.com","","","","Cupertino","United States","","","","","95014","CA","1 Infinite Loop"
  • Now you can try importing this csv file back into Zimbra.
  • Either with the webclient or you can use some on the CLI commands
    • See User_Migration for variations of CLI commands that could be used.
    • Here's the documented example:
    • curl -u schemers:password --data-binary @/tmp/new.csv http://server/service/home/schemers/contacts?fmt=csv

Example Header For Horde Contacts

I have not used this myself, I found it on the forums.


I'm hoping the forum user simply renamed the top header column to match description fields that Zimbra knows and that it's in order of the data (left to right) that Horde normally exports in. You'll need to review it and make sure it fits with your exported data columns from Horde.

Admin With Curl And Wget

You will most likely need to include :7071 in the url string to get around the pop-up issue that you would get if you used the same string in a web browser, without :7071 you'll see a permission error when trying to see/get data from a users account via the admin account.

curl -u admin:pass https://hostname:7071/home/user/Contacts
wget https://admin:pass@hostname:7071/home/user/Contacts

What's My Server Like

To dump out your server details, these commands are useful.

zmprov gs yourdomainname
zmprov gacf

Another good document to review for "odd performance" issues is the large server wiki.


Restarting Jetty - ZCS 5+

As zimbra

zmmailboxdctl restart

How Do I Find Out What Version Of Zimbra I'm Using


Get Version From Ajax Client

Put the below in the search field of the Ajax client:

$set:get version



Search for the CLIENT_VERSION line.

Other Ways To Get Version Of Server

See this forum post:

What's Compiled With Postfix

Do the following (return is from my test box):

postconf -m

REST Information

Resources to review

Format to get around permission denied on multi-domain hosting servers

If you getting permission denied rather than resource not found...try this format example:




I but both in case one issue is where the username has special characters, like the period.

Server Source Doc's

Please see:


Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.


Actual Logging Homepage

Please see Ajcody-Logging


RFE's Related To Better Logging And Historical Data Of Systems

See : Ajcody-Testing-Debugging#RFE.27s_Related_To_Better_Logging_And_Historical_Data_Of_Systems


See : Ajcody-Testing-Debugging for more complete debugging information.

When Was A ZCS Service Enabled Or Disabled

See : Ajcody-Notes-Archive-Discovery#When_Was_A_ZCS_Service_Enabled_Or_Disabled

Syslog Items

Single Server Setup

/etc/syslog.conf should have lines similiar to:

[towards bottom of conf file]
local0.*                -/var/log/zimbra.log
auth.*                  -/var/log/zimbra.log
mail.*                  -/var/log/zimbra.log

Make sure syslog allows messages from log4j to be written, log4j doesn't do unix pipes. Specifically, it uses internet domain sockets (514/upd) instead of unix domain sockets (/dev/log). On a single server setup, this means log4j talking to localhost via 514/udp. Again, /dev/log is never used by log4j (AFAIK, this could change in the future). Adding the "-r" applies for the centralized syslog server as usual, but it also applies for the case where you want log4j data to be logged via syslog locally [single server setup]:

[root@zimbra sysconfig]# diff -u /etc/sysconfig/syslog.ORIG /etc/sysconfig/syslog
--- /etc/sysconfig/syslog.ORIG  2008-03-25 09:14:28.000000000 -0400
+++ /etc/sysconfig/syslog       2009-06-09 16:01:13.000000000 -0400
@@ -3,7 +3,7 @@
 # -r enables logging from remote machines
 # -x disables DNS lookups on messages recieved with -r
 # See syslogd(8) for more details
 # Options to klogd
 # -2 prints all kernel oops messages twice; once for klogd to decode, and
 #    once for processing with 'ksymoops'

Restart syslog:

/etc/init.d/syslog restart

Setup ZCS to be aware of syslog [we'll restart Zimbra later once all the changes are done]:

zmprov mcf zimbraLogToSyslog TRUE

This will set the appropriate ldap values (after a zimbra restart) to make log4j.properties be written correctly:

/opt/zimbra/conf/log4j.properties will now show some modifications, for example:

[snips - DON'T cut cut/paste this info below for your server]
# Syslog appender
log4j.appender.SYSLOG.layout.ConversionPattern=mailboxd: %-5p [%t] [%z] %c{1} - %m

This will actually cause very little to goto syslog though, it's a very minimalist setup. Now adjust /opt/zimbra/conf/log4j.properties.in to log more items to syslog.

Note: You may or may not want all these things going to syslog and you may be able to send more/other things to syslog as well. I've not spend lots of time with log4j and I'm not familiar enough with all the code to know which pieces are using which logger/settings.

WARNING: the AUDIT logs may have sensitive data so be careful to protect the logs so that sensitive data is not leaked accidentally.

[zimbra@zimbra conf]$ diff -u log4j.properties.in.ORIG log4j.properties.in
--- log4j.properties.in.ORIG    2009-06-05 15:31:20.000000000 -0400
+++ log4j.properties.in 2009-06-09 15:54:07.000000000 -0400
@@ -35,7 +35,7 @@

 # Save zimbra.security to AUDIT appender

 # Syslog appender
@@ -88,7 +88,7 @@


At this point, you can restart zimbra for all the changes to be in effect:

zmcontrol stop ; zmcontrol start

Centralized Syslog Server

Please see:

This will show you how to setup a syslog server and then to configure the "clients" to log to the local filesystem as well as the syslog server.

You'll need to then take into account the information in Ajcody-Logging#Single_Server_Setup to handle the "Zimbra" part as well as dealing with log4j.

Centralized Log Server Project Ideas


  • Logs are to large to manage on each server.
  • Want to build a central logging server for all logging events.
  • The syslog events are very minimal with Zimbra (/var/log/zimbra.log). Most of the logging is control by Log4j (tomcat/jetty). Output from log4j generally goes into the /opt/zimbra/log/ directory. There's some conf files in /opt/zimbra/conf/log4j.properties* for log4j. You can adjust this file to also output into the syslog environment but syslog has very limited choices for "facility". See Ajcody-Logging#Single_Server_Setup and Log4j & Syslog facility for details. You'll end up getting huge files and god knows how many log events per second if you adjusted log4j to dump all zimbra logging into syslog control.

General Thought On This:

Use syslog-ng with mysql for the central log server. Add on php-syslog-ng for comfort.

Leave the log4j stuff alone and configure syslog-ng to monitor the actual log files as they are generated by log4j in /opt/zimbra/log/* .

Then decrease the log sizes and archiving done on the local servers, i.e. zimbraLogRawLifetime & zimbraLogSummaryLifetime .


Log Rotation and Removal

Logs In /opt/zimbra/log Directory

Please look at the output of your crontab - AS ZIMBRA, look for the "Log pruning" line.

crontab -l

And also the config files for logrotate:



Example From 5.0.11 - Complete ZCS Install Single Server

crontab for zimbra:

# Log pruning
30 2 * * * find /opt/zimbra/log/ -type f -name \*.log\* -mtime +8 -exec rm {} \; > /dev/null 2>&1
35 2 * * * find /opt/zimbra/log/ -type f -name \*.out.???????????? -mtime +8 -exec rm {} \; > /dev/null 2>&1

# Log pruning
30 2 * * * find /opt/zimbra/mailboxd/logs/ -type f -name \*log\* -mtime +8 -exec rm {} \; > /dev/null 2>&1

And the logrotate files:

$ cat /etc/logrotate.conf 
# see "man logrotate" for details
# rotate log files weekly

# keep 4 weeks worth of backlogs
rotate 4

# create new (empty) log files after rotating old ones

# uncomment this if you want your log files compressed

# RPM packages drop log rotation information into this directory
include /etc/logrotate.d

# no packages own wtmp -- we'll rotate them here
/var/log/wtmp {
    minsize 1M
    create 0664 root utmp
    rotate 1

# system-specific logs may be also be configured here.

And also:

$ cat /etc/logrotate.d/zimbra 
/var/log/zimbra.log {
    create 0644 zimbra zimbra
      killall -HUP syslogd 2> /dev/null || true
      kill -HUP `cat /opt/zimbra/log/swatch.pid 2> /dev/null` 2> /dev/null || true
      kill -HUP `cat /opt/zimbra/log/logswatch.pid 2> /dev/null` 2> /dev/null || true

/opt/zimbra/log/myslow.log {
    rotate 30
    create 0644 zimbra zimbra

/opt/zimbra/log/logger_myslow.log {
    create 0660 zimbra zimbra
    size 5000k
    rotate 7

/opt/zimbra/log/clamd.log {
    create 0660 zimbra zimbra
     kill -HUP `cat /opt/zimbra/log/clamd.pid 2> /dev/null` 2> /dev/null || true
    size 5000k
    rotate 7

/opt/zimbra/log/zmlogswatch.out {
    create 0740 zimbra zimbra
      su - zimbra -c "/opt/zimbra/bin/zmlogswatchctl stop"
      su - zimbra -c "/opt/zimbra/bin/zmlogswatchctl start"
    rotate 5

/opt/zimbra/log/zmswatch.out {
    create 0740 zimbra zimbra
      su - zimbra -c "/opt/zimbra/bin/zmswatchctl stop"
      su - zimbra -c "/opt/zimbra/bin/zmswatchctl start"
    rotate 5

/opt/zimbra/log/zmmtaconfig.log {
    create 0740 zimbra zimbra
      su - zimbra -c "/opt/zimbra/bin/zmmtaconfigctl restart"
    rotate 5

/opt/zimbra/log/nginx.log {
    create 0644 zimbra zimbra
      kill -USR1 `cat /opt/zimbra/log/nginx.pid 2> /dev/null` 2> /dev/null || true
    rotate 7

/opt/zimbra/log/zmconvertd.log {
    create 0644 zimbra zimbra
    rotate 7

/opt/zimbra/zmstat/zmstat.out {
    rotate 7

Openldap Logs - In /opt/zimbra/openldap-data/

Ldap logs files in /opt/zimbra/openldap-data/ and in /opt/zimbra/data/ldap/* subdirectories [ZCS 6+] that are like log.0000000001 , log.0000000002 , etc.

This logpurge is controlled by:

$ cd /opt/zimbra/openldap/etc/openldap/
[zimbra@mail3 openldap]$ grep logpurge *
master-accesslog-overlay.conf:logpurge	07+00:00	01+00:00
Logpurge Directive Description

From Accesslog Chapter

logpurge Directive

logpurge age interval

Defines both the maximum age for log entries to be retained in the database and how often to scan the database for old entries. Bothage and interval are specified as a time span in days, hours, minutes, and seconds. The time format is [ddd+]hh:mm[:ss], for example, the days and seconds components are optional but hours and minutes are required. Except for days, which can be up to 5 digits, each numeric field must be exactly two digits. Example:

  1. the log database will be scanned every day
  2. entries older than two days will be deleted.

logpurge 2+00:00 1+00:00

When using a log database that supports ordered indexing on generalizedTime attributes, specifying an eq index on the reqStart attribute will increase the performance of purge operations.

What's up with all the logs?

Other Logging Page Resources





The Bread And Butter Logs

/opt/zimbra/log/mailbox.log - where most of your mailbox store activity is logged
  • This log is the mailboxd log4j server log containing the logs from the mailbox server. This includes activity from the mailbox store, LMTP server, IMAP and POP servers, and Index server.
    • Location: /opt/zimbra/log/mailbox.log
/opt/zimbra/log/zmmailboxd.out - mailboxd/jvm output log
  • Mailstore not coming up and nothing is being logged in mailbox.log, check here for errors.
    • Location: /opt/zimbra/log/zmmailboxd.out
/opt/zimbra/log/stacktrace.<pid> - stacktrace logs
  • stacktraces related to mailboxd
    • Location: /opt/zimbra/log/stacktrace.<pid>
/opt/zimbra/db/data/YOURHOSTNAME.err - errors for MySQL - ZCS 4.x & ZCS 5.x
  • This is the message store database error log.
    • Location: /opt/zimbra/db/data/YOURHOSTNAME.err
/var/log/zimbra.log - mta and system status log, postfix, amavisd
  • The Zimbra syslog details the activities of the Zimbra MTA (Postfix, amavisd, antispam, antivirus), Logger, Authentication (cyrus-sasl), and Directory (OpenLDAP). By default LDAP activity is logged to Zimbra.log.
    • Location: /var/log/zimbra.log
/var/log/messages - mta and OS related log events
  • Probably has mta logging events [which also show in /var/log/zimbra.log] and also log events related to your OS
    • Location: /var/log/messages
/opt/zimbra/log/mysql_error.log - problems with MySQL
  • If there is data corruption or another problem causing direct mysql errors, events will be logged here.
    • /opt/zimbra/log/mysql_error.log
/opt/zimbra/log/myslow.log - slow db/MySQL queries
  • If certain search requests are taking longer to complete than others, they will be logged here.
    • /opt/zimbra/log/myslow.log

Other Logs

/opt/zimbra/log/audit.log - authentication events
  • A log of all admin actions taken as well as logins to the server.
    • /opt/zimbra/log/audit.log
Want to see all uses of the "View Mail" button from the admin console? Will have the IP address, User Agent of the browser, user that the admin is logged in as, and the account that they are viewing.
 grep DelegateAuth /opt/zimbra/log/audit.log 
/opt/zimbra/log/clamd.log - antivrius db
  • Status and checks for clamav
    • /opt/zimbra/log/clamd.log
If your clamav db is out of date, you'll see a log event here like this:
LibClamAV Warning: **************************************************
LibClamAV Warning: *** The virus database is older than 7 days! ***
LibClamAV Warning: *** Please update it as soon as possible. ***
LibClamAV Warning: **************************************************
/opt/zimbra/log/convertd.log - attachment conversion
  • If your having problems with your attachments and the ability to view them in ZWC, check here for errors.
    • /opt/zimbra/log/convertd.log
/opt/zimbra/log/freshclam.log - clam antivirus updates
  • Shows the actual attempt to update the clamav updates.
    • /opt/zimbra/log/freshclam.log
/opt/zimbra/log/spamtrain.log - spam/ham training details
  • Spam/Ham training details are logged here. Errors are also logged here related to this service.
  • From a default single ZCS configurations crontab [zimbra]:
# Spam training
0 :23 * * * /opt/zimbra/bin/zmtrainsa >> /opt/zimbra/log/spamtrain.log 2>&1
# Spam training cleanup
45 23 * * * /opt/zimbra/bin/zmtrainsa --cleanup >> /opt/zimbra/log/spamtrain.log 2>&1
/opt/zimbra/log/sync.log - zimbra mobile and activesync
  • Your mobile devices will basically log here.
    • /opt/zimbra/log/sync.log
/opt/zimbra/log/synctrace.log - zimbra mobile and activesync
  • Still looking for description that describes difference with sync.log
    • /opt/zimbra/log/synctrace.log
/opt/zimbra/log/syncstate.log - no description found
  • No description found.
    • /opt/zimbra/log/syncstate.log
/opt/zimbra/log/wbxml.log - no description found
  • No description found.
    • /opt/zimbra/log/wbxml.log
/opt/zimbra/log/zmlogswatch.out -
/opt/zimbra/log/zmmtaconfig.log -
/opt/zimbra/log/zmmyinit.log -
/opt/zimbra/log/zmsetup.`date`-'pid'.log -
/tmp/install.log -

After install, gets moved to : /opt/zimbra/.install/

/tmp/zmsetup.log -

After install, gets moved to : /opt/zimbra/log/zmsetup.log.[some numbers]

/opt/zimbra/httpd_access.log -
/opt/zimbra/httpd_error.log -

New Data Directory In ZCS6+

In ZCS 6+ , there's a directory to organize 'data' from our various components.

[root@mail3 data]# pwd

[root@mail3 data]# ls -F
altermime/  amavisd/  clamav/  dspam/  ldap/  postfix/  tmp/

This information could prove useful as well with trouble-shooting and debugging problems.

Increase Logging

Increase Logging Per User

Depending on the ZCS version the below will clear all the per account loggers on zimbra reboot. IMAP is used for these examples.

  • addAccoutLogger
zmprov aal user@domain.com zimbra.imap debug
  • removeAccountLogger
zmprov ral user@domain.com zimbra.imap

Example usuage:

zmprov aal user@domain.com zimbra.soap debug 

And tail the log file, while attempting to login to the AJAX client.:

tail -f /opt/zimbra/log/mailbox.log

See Ajcody-Logging#Log4J_Variables for variables that can be used.

To See What Accounts Have Extended Logging Enabled

There's the gaal option for zmprov . It list the accounts on a per mailstore basis :

  getAllAccountLoggers(gaal) [-s/--server hostname]
[zimbra@zcs806 ~]$ zmprov gaal `zmhostname`
# name test01@zcs806.domain.com
Bugs And RFE's

I filed the following RFE:

Increase Logging Per Server

If you want to do it globally edit this file:

vi /opt/zimbra/conf/log4j.properties

Add a line at the end that's similar to something like this: log4j.logger.zimbra.imap=DEBUG.

No restart of any service is needed, BUT if something happens that causes a regeneration of the log4j.properties file then your changes will be overwritten. A regeneration of this file takes the contents of /opt/zimbra/conf/log4.properties.in .

To permanently make a change, modify the /opt/zimbra/conf/log4.properties.in file, then a restart would be necessary.

$ zmcontrol stop
$ zmcontrol start

or you could run this on the server:

$ zmmtaconfig mailboxd

Wait for a minute for the server to pick up your change.

See Ajcody-Logging#Log4J_Variables for variables that can be used.

Log4J Variables

An Official page has been made for this topic now per my RFE request, bug 41894

Please see:

OpenLDAP Logging Levels

Please see King0770-Notes-Change-LDAP-Log-Levels

Want To See What's In Redolog Files

If you suspect there's too much redolog activity during a time window or have another need to inspect the contents of the redolog, dump it and examine it:

$ zmjava com.zimbra.cs.redolog.util.RedoLogVerify /opt/zimbra/redolog/redo.log > out.file

Pick the right redolog file, either redo.log or one of the files under archive/, based on timestamp.

See Ajcody-Backup-Restore-Issues#Redolog_Files for more details.

Internal Zimbra Charting - zmstat-chart

RFE/Bugs You Might Be Interested In

zmstat IS NOT Logger (graphs in admin console)

Please note, zmstat is different than the processes and graphs involved with Logger. Logger is behind the graphs that show up in the admin web console.

Please see Logger for details and trouble-shooting steps with Logger.

Rick has some other steps for King0770-Notes#Reinitialize_the_Logger_DB

Main References For zmstat-chart Command

Please see the following:

zmstat-chart CLI Administration Guide

zmstat-chart-config CLI Administration Guide

zmstatctl CLI Administration Guide

Zmstats Wiki

Server Monitoring Wiki

Monitoring Administration Guide

JFreeChart is the project/binary behind the charting tool. You'll find the jar files here [ZCS 5.0.9 example]:

  • /opt/zimbra/lib/jars/jfreechart-1.0.1.jar
  • /opt/zimbra/jetty-6.1.5/common/lib/jfreechart-1.0.1.jar

Issues Being Investigated With zmstat And Other "Charting" Items

I currently have an internal thread going with the dev's about some issues with zmstat and also with attempts of getting the active sessions data from the admin web console to be seen in trends.

I'll just be dumping my notes here and then cleaning them up once I'm done with the internal conversation.

  • Question: (mailboxd: active connections by client protocol) What exactly is this tracking? I'm on a test box with no connections and it has the different threads in the 100's/1000's. Customer was hoping (as was I) that this would be giving data much like is shown in the admin console about user connections. Also, there doesn't seem to be a comparable "active connections" for the web client (soap)?
    • Answer: For the connections issue, it's the number of clients that are currently connected. There's no analog for SOAP because SOAP doesn't have persistent connections. We may be able to log stats for number of SOAP sessions, but that would include noise for cases where the user closes the browser window and the session hasn't timed out yet. If you think this is useful, please file an RFE.
  • Question: (graph time plot) If I run zmstat-chart with the --aggregate-start-at option with something like "08/07/2008 01:00:00" I notice that the graphs don't actually reference "days" at the bottom but still use what looks to be "hours". Is this a bug where the bottom reference of the graph doesn't get adjusted or is the syntax to run zmstat-chart to do this more tricky that I think.
    • Answer: zmstat-chart doesn't support multi-day ranges, it really only supports a single directory with a single day of charts, the aggregate options are for specifying ranges at which to calculate the max(col)/min(col)/avg(col) values. Our usual practice is to generate one set of charts for each day we want to look at; I think it gives us a better look at when peaks occur and how they compare day-to-day (it's much easier to look at them in an overlay fashion).
    • Answer: Seems like a reasonable request to be able to generate charts for multiple days. Please file an RFE if you think this would be useful.
  • Question: How reliable are these numbers are in admin console....
    • Answer: I imagine they should be quite reliable; but HTTP (Web) is stateless, so you can't really determine whether a session is really active or not. I believe multiple sessions appearing for a single user would be the result of reloading or closing and then reopening the browser to log in again.
      • Perhaps it is best to ask the users in question what their usage is like? Is there any concern over the high number of sessions? I don't think it should affect server performance.
  • Question: Could you please explain the following:
    • Mailboxd Mailbox Add Rate (Delivery Rate)
      • Answer: The rate at which messages are being added to the mailbox server, e.g. 1 message being delivered per second is... 1 m/s
    • Mailboxd Mailbox Add Latency (Delivery Speed)
      • Answer: How long it takes on average to add a message to a mailbox (averaged over the period of a minute)
    • Mailboxd Active Connections by Client Protocol- This one does NOT give us counts for web client. Host zcs2.mail.XXXX.xxx: Mailboxd: Active Connections by Client Protocol avg(IMAP) = 169.86 avg(IMAP SSL) = 0.00 avg(POP) = 0.21 avg(POP SSL) = 0.00
      • Answer: It doesn't give counts for web client because the web client does not have persistent connections (being HTTP-based). SOAP requests (used by the Web client) use transient connections that often close after they are used; i.e. if you took the number of "SOAP" connections and compared it to the number of "active" sessions, it'd likely be something like 0-1% of the latter figure.
    • Mailboxd Mailbox Get Count
      • Answer: The number of mailboxes that got opened in the last minute (I don't recall if this counting cache hits or not?)
    • Mailboxd Mailbox Get Latency
      • Answer: How long it takes to open a mailbox, on average (over a minute)
    • Also, we don't get stats for any of the soap parameters:
      • SOAP Invocation Count Summary (Top 10 max)
      • SOAP Average Call Duration AuthRequest
        • Answer: I don't know why this could be; perhaps zmstat-chart-config.xml needs to be regenerated, is /opt/zimbra/zmstat/soap.csv available and does it contain data?

Running zmstat-chart

Confirm it's running:

zmprov gs [mailserver hostname] | grep -i stats
  zimbraServiceEnabled:  stats
  zimbraServiceinstalled: stats

Default location of stat files is:


Example command to run:

mkdir /tmp/stats
zmstat-chart -s /opt/zimbra/zmstat -d /tmp/stats/

Like To Have zmstat-chart Data Integrated With Zimbra

I've made an RFE for this integration:

With Zimbra Jetty
The default Jetty behavior will NOT display directory listing. You'll need a valid html type file in the directory target.
I would recommend the apache solution over this one as you can avoid hitting performance issues this might cause.

Dump some graphing directories in there:

zmstat-chart -s /opt/zimbra/zmstat -d /opt/zimbra/jetty/webapps/zimbra/downloads/zmstat-chart/`date +%F-%H-%M`

You'll see there's the directory and when you go into it - there's your charts.

You can now place this command in your crontab to run on a schedule basis.

Things you'll want to check before deploying:

  1. Place charting directory in a location where space is available and will not create a risk to the mail services if it's full.
  2. Look at the zmstat-chart options to see what other parameters you want to use - especially if it's going in your crontab.
  3. Make sure your following and security guidelines for your environment.

You'll be able to view the data with the following url:

With Zimbra Apache Or Non-Zimbra Server With Apache
Before You Proceed

Things to check or confirm first before deploying:

  • Place your directory root [/opt/zimbra/support in this example] in a location where space is available and will not create a risk to the mail services if it's full.
  • If you'll be using NFS to have a centralized storage point:
    • Your NFS mount point on the Zimbra servers would be /opt/zimbra/support in this example.
    • You'll be exporting /opt/zimbra/support in this example from the NFS server.
    • If this is a non-zimbra server, copy the zimbra entry from a zimbra server's /etc/passwd and /etc/group into the non-zimbra servers passwd and group file. This way, if NFS is also used the UID/GID matches.
  • Apache Directory variable will be /opt/zimbra/support/data in this example.
  • Apache .htpasswd location will be /opt/zimbra/support/.htpasswd in this example, putting it above of the apache Directory variable.
    • Make sure your following the security guidelines for your environment.
  • Look at the zmstat-chart options to see what other parameters you want to use - especially if it's going in your crontab.
Directory Layout

As root:

mdir -p /opt/zimbra/support/data
cd /opt/zimbra/support/data
for i in `/opt/zimbra/bin/zmprov gas`
 mkdir $i

If your not on a ZCS server, you'll be manually creating directories named after the output of zmhostname from each of your ZCS servers.

Now, create subdirectory paths under each zmhsotname directory.

cd /opt/zimbra/support/data/
for i in `ls`
  mkdir $i/debug $i/logs $i/zmstat $i/tops

Set permissions on the directories we made:

chown -R zimbra:zimbra /opt/zimbra/support
chmod -R 755 /opt/zimbra/support

With this structure and with NFS setup, you'll have a common repository that will have a standard path to use on a per server basis. Example :

script-command -PathOption /opt/zimbra/support/data/`zmhostname`/TYPE_OF_DATA/`date +%F-%H-%M`
Apache Configuration

Let's configure apache to show this directory.

  • For ZCS Apache Setup:
vi /opt/zimbra/conf/httpd.conf
** Towards the end, add the following**
# Include zmstat-chart directory
Include /opt/zimbra/httpd/conf/extra/zimbra-support.conf
  • Non-ZCS Server With Apache. Check that there's an existing Include directive that will see our zimbra-support.conf:
vi /etc/httpd/conf/httpd.conf
** Look for something that will allow the following**
** /etc/httpd/conf.d/zimbra-support.conf to be used**
** Your distro might differ on apache paths as well**
** as Include statement for other conf files**
Include conf.d/*.conf

Let's now make the apache conf file for zimbra-support.conf

  • For ZCS Apache Setup:
vi /opt/zimbra/httpd/conf/extra/zimbra-support.conf
Alias /support "/opt/zimbra/support/data"
<Directory "/opt/zimbra/support/data">
  AuthName "Secure Area For Zimbra Support"
  AuthType Basic
  AuthUserFile /opt/zimbra/support/.htpasswd
  require valid-user
  Options Indexes
  IndexOptions FancyIndexing VersionSort
  AllowOverride None
  Order allow,deny
  Allow from all
  • Non-ZCS Server With Apache:
vi /etc/httpd/conf.d/zimbra-support.conf
Alias /support "/opt/zimbra/support/data"
<Directory "/opt/zimbra/support/data">
  AuthName "Secure Area For Zimbra Support"
  AuthType Basic
  AuthUserFile /opt/zimbra/support/.htpasswd
  require valid-user
  Options Indexes
  IndexOptions FancyIndexing VersionSort
  AllowOverride None
  Order allow,deny
  Allow from all

Make sure permissions are set correctly on zimbra-support.conf so apache will use it.

Now let's setup a username and password to use with the .htpasswd file.

cd /opt/zimbra/support/
htpasswd -c .htpasswd zimbrasupport
chmod 644 .htpasswd

Restart apache so the changes take effect:

  • For ZCS Apache Setup:
zmapachectl stop
zmapachectl start
  • Non-ZCS Server With Apache:
httpd restart

Now, let's dump some graphing directories in there:

zmstat-chart -s /opt/zimbra/zmstat -d /opt/zimbra/support/data/`zmhostname`/zmstat/`date +%F-%H-%M`

To now view the charts. Adjust, SERVERHOSTNAME, for your servername.

  • For ZCS Apache Setup:


  • Non-ZCS Server With Apache:


You'll see there's the directory and when you go into it - there's your charts.

You can now place this command in your crontab to run on a schedule basis.

Tweaking zmstat-chart

zmstat-chart also has the option to use a configuration file. The default configuration file is:


Copy this to another location and edit away. Then add the -c /location/to/config/file to use your new configuration.

Default Items Charted

Here's a list of the default items that will be charted with zmstat-chart:

  • Postfix Queue Size
  • convertd CPU time used
  • convertd Resident Memory
  • convertd Processes and Threads
  • Total CPU
  • Process CPU
  • Process Total Memory
  • Process Resident Memory
  • Virtual Memory
  • Context Switches
  • Run/Blocked Process Queue Size
  • Disk Partition Throughput
  • Disk Utilization
  • Disk Throughput
  • Disk IOPs
  • Swap Activity
  • Total file descriptors open
  • SOAP Invocation Count Summary (Top 10 max)
  • SOAP Average Call Duration Summary (Top 10 avg)
  • SOAP Invocation Count GetServerRequest
  • SOAP Invocation Count BackupRequest
  • SOAP Invocation Count GetAllConfigRequest
  • SOAP Invocation Count GetDomainRequest
  • SOAP Invocation Count GetAllDomainsRequest
  • SOAP Invocation Count AuthRequest
  • SOAP Average Call Duration GetServerRequest
  • SOAP Average Call Duration BackupRequest
  • SOAP Average Call Duration GetAllConfigRequest
  • SOAP Average Call Duration GetDomainRequest
  • SOAP Average Call Duration GetAllDomainsRequest
  • SOAP Average Call Duration AuthRequest
  • MySQL Database Connections
  • MySQL InnoDB Buffer Pool Pages
  • MySQL InnoDB Buffer Pool Hit Rate
  • MySQL Tables Open/Opened
  • MySQL Total Slow Queries Count
  • Mailboxd Connection Pool Get Latency
  • Mailboxd Dirty Lucene Index Writers
  • Mailboxd Lucene IndexWriterCache Hitrate
  • Mailboxd Lucene IO
  • Mailboxd LMTP Delivery Throughput
  • Mailboxd LMTP Delivery Rate
  • Mailboxd Mailbox Add Rate (Delivery Rate)
  • Mailboxd Mailbox Add Latency (Delivery Speed)
  • Mailboxd Request Rate by Client Protocol
  • Mailboxd Response Time by Client Protocol
  • Mailboxd Active Connections by Client Protocol
  • Mailboxd Mailbox Get Count
  • Mailboxd Mailbox Get Latency
  • Mailboxd Mailbox Cache Hit Rate
  • Mailboxd Mailbox Item/Blob Cache Hit Rate
  • Mailboxd Garbage Collection Time
  • Mailboxd Garbage Collection Count
  • Mailboxd JVM Heap Used
  • Mailboxd JVM Heap Free
  • Mailboxd JVM Permanent Generation and Code Cache

Getting All User Quota Data With Zmsoap (not zmstat related really)

See the soap-admin.txt file in /opt/zimbra/docs/ and also Zmsoap for more zmsoap examples.

[zimbra@mail32 ~]$ zmsoap -z GetQuotaUsageRequest

<GetQuotaUsageResponse xmlns="urn:zimbraAdmin" more="0" searchTotal="6">
  <account limit="0" used="1775390" name="admin@mail32.zimbra.DOMAIN.com" id="fcdb6b46-f55a-4f60-8496-31e2e79f30d6"></account>
  <account used="9765" id="dc158043-4b02-4f85-9d8a-bf7446188117" limit="0" name="ajcody@mail32.zimbra.DOMAIN.com"></account>
  <account used="9146" name="wiki@mail32.zimbra.DOMAIN.com" id="ec49fa30-3ed9-4574-baf1-ad9efae23637" limit="0"></account>
  <account name="ham.kvttsx2i@mail32.zimbra.DOMAIN.com" id="9c2d21ef-57ea-412d-b848-3853b67df2d8" used="0" limit="0"></account>
  <account used="0" limit="0" id="70f29afa-2a5e-4bd1-922e-4df090a45348" name="spam.5jx1uzg_k@mail32.zimbra.DOMAIN.com"></account>
  <account id="a3d19006-44e0-4a9d-9ccd-297a7a70489c" limit="0" used="0" name="testlang@mail32.zimbra.DOMAIN.com"></account>

Getting All User Quota Data With Zmprov (not zmstat related really)

To get quota stats, run. The output is a little bit difficult to read since it's in bytes:

zmprov gqu `zmhostname`

This will display in bytes- first column is usage, second column is max quota (0=unlimited), third column will be the account :

zmprov gqu `zmhostname`|awk {'print " "$3" "$2" "$1'}

Here's a script to put into user readable format below [by Tony P.]. You'll need to modify the $hostname variable near the top:


my $hostname = localhost;

my @quotas = `zmprov gqu $hostname`;

foreach my $quotaline(@quotas)



my ($email, $quota, $usage) = split(' ', $quotaline);



print "$email - $usage\n";


sub utils_convert_bytes_to_optimal_unit{

my($bytes) = @_;

return '' if $bytes eq '';

my $size;

$size = $bytes . ' Bytes' if $bytes < 1024;

$size = sprintf("%.2f", $bytes/1024) . ' KB' if $bytes >= 1024 && $bytes < 1048576;

$size = sprintf("%.2f", $bytes/1048576) . ' MB' if $bytes >= 1048576 && $bytes < 1073741824;

$size = sprintf("%.2f", $bytes/1073741824) . ' GB' if $bytes >= 1073741824 && $bytes < 1099511627776;

$size = sprintf("%.2f", $bytes/1099511627776) . ' TB' if $bytes >= 1099511627776;

return $size;


Third Party Tools (Monitoring & Logging)

FYI - Support For Real Time Counters (snmp,etc.)

This is for those that need to go beyond what zmstat-chart is doing or need to intergrate within a third party monitoring systems.

Please see RFE:

Currently, this RFE has only resolved support for JMX, not SNMP. Customers who need SNMP can use a product like jManage to do the translation from JMX to SNMP.

SNMP And Zimbra

SNMP Related Bugs And RFEs

Please read the following below as they'll have little bits of information that you might need for your customizations / external setup for snmp use against Zimbra. :

SNMP Setup On Zimbra To Notify A Remote Host

Our SNMP support is pretty basic; currently, we only send traps when a service (mta, mailbox, ldap) changes state (stop/start).

First, you'll need net-snmp package install on the zimbra host for the notifications to be sent to a remote host.

  • When you install the net-snmp package, it creates /etc/snmp/snmpd.conf. This file needs to be edited with the correct community string to allow for snmp mibs to be read from remote machines The default value is "public" with the net-snmp package.
    • /opt/zimbra/conf/swatchrc.in is set to use [ perlcode 0 my $snmpargs="-v 2c -c zimbra localhost "; ] for the community string. Adjust this if needed for your corporate snmp environment.
    • Your security policy for your company might require you to review the other options there as well - i.e. limit to read-only.
    • Also, if there is a firewall between the zimbra server and the snmp server host you'll need to open up port 161/UDP.

Then your zimbra host with the zimbra snmp service installed, do the following for a basic default setup:

zmlocalconfig -e snmp_notify=1
zmlocalconfig -e snmp_trap_host=your.host.name
zmswatchctl stop
zmswatchctl start

We watch for something matching /err: Service status change/ and send the trap with:


See other topics below for customizations that might be needed for your snmp environment.

Other reference for Zimbra and SNMP:

Files To Review For SNMP

Look at the contents of the following files:

  • /opt/zimbra/libexec/zmsnmpinit
    • /opt/zimbra/conf/swatchrc.in
      • zmsnmpinit reads swatchrc.in and writes out the file swatchrc for the running configuration
      • /opt/zimbra/conf/swatchrc
    • /opt/zimbra/snmp/share/snmp/snmpd.conf.in which is the SOURCE file to
      • /opt/zimbra/conf/snmpd.conf [see /opt/zimbra/libexec/zmsnmpinit ]
        • The two above are used by zmsnmpinit to generate the /opt/zimbra/conf/swatchrc
  • /opt/zimbra/net-snmp/share/snmp/mibs/zimbra.mib
  • /opt/zimbra/net-snmp/share/snmp/mibs/zimbra_traps.mib
  • /opt/zimbra/log/zmswatch.out
    • Monitor this to see the services when they go up and down successfully send out the email notification for your snmp configuration
Zimbra MIBS

You'll find zimbra.mib and zimbra_traps.mib in the following directory. This listing is mine under 5.0.19 :

[root@mail3 ~]# cd /opt/zimbra/net-snmp/share/snmp/mibs/

[root@mail3 mibs]# ls
AGENTX-MIB.txt                       IPV6-TC.txt                SNMP-USER-BASED-SM-MIB.txt
DISMAN-EVENT-MIB.txt                 IPV6-UDP-MIB.txt           SNMP-USM-AES-MIB.txt
EtherLike-MIB.txt                    NET-SNMP-EXTEND-MIB.txt    SNMPv2-MIB.txt
HCNUM-TC.txt                         NET-SNMP-MIB.txt           SNMPv2-SMI.txt
HOST-RESOURCES-MIB.txt               NET-SNMP-TC.txt            SNMPv2-TC.txt
HOST-RESOURCES-TYPES.txt             NET-SNMP-VACM-MIB.txt      SNMPv2-TM.txt
IANAifType-MIB.txt                   RFC1155-SMI.txt            TCP-MIB.txt
IANA-LANGUAGE-MIB.txt                RFC1213-MIB.txt            TRANSPORT-ADDRESS-MIB.txt
IANA-RTPROTO-MIB.txt                 RFC-1215.txt               UCD-DEMO-MIB.txt
IF-INVERTED-STACK-MIB.txt            RMON-MIB.txt               UCD-DISKIO-MIB.txt
IF-MIB.txt                           SMUX-MIB.txt               UCD-DLMOD-MIB.txt
IP-FORWARD-MIB.txt                   SNMP-FRAMEWORK-MIB.txt     UCD-SNMP-MIB.txt
IP-MIB.txt                           SNMP-MPD-MIB.txt           UDP-MIB.txt
IPV6-ICMP-MIB.txt                    SNMP-NOTIFICATION-MIB.txt  zimbra.mib
IPV6-MIB.txt                         SNMP-PROXY-MIB.txt         zimbra_traps.mib
IPV6-TCP-MIB.txt                     SNMP-TARGET-MIB.txt
What Is Looked For

Take a look at your /opt/zimbra/conf/swatchrc - this is mine under 5.0.19

perlcode 0 my %notifications=();
perlcode 0 $notifications{smtp}="yes";
perlcode 0 $notifications{snmp}="yes";

perlcode 0 my $fr='admin@mail3.zimbra.REMOVED.com';
perlcode 0 my $pwc='admin@mail3.zimbra.REMOVED.com';

perlcode 0 my $snmpargs="-v 2c -c zimbra localhost ''";
perlcode 0 my $snmptrap="/opt/zimbra/snmp/bin/snmptrap $snmpargs";
perlcode 0 my $snmpsvctrap="ZIMBRA-TRAP-MIB::zmServiceStatusTrap";
perlcode 0 my $snmpsvcname="ZIMBRA-MIB::zmServiceName";
perlcode 0 my $snmpsvcstatus="ZIMBRA-MIB::zmServiceStatus";

perlcode 0 my %statuses=('started'=>1,'stopped'=>0);

perlcode 0 my $hostname="mail3.zimbra.homeunix.com";

perlcode 0 sub donotify {   my %args = (@_); if ($args{HOST} eq "localhost") {$args{HOST}=$hostname;}; 
 if ($notifications{smtp}) { dosmtp(%args) if $args{SERVICE}; dodisksmtp(%args) if $args{DISK};}; 
 if ($notifications{snmp}) {dosnmp(%args);};  }

perlcode 0 sub dosmtp {   my %args = (@_);  print "SMTP notification: $args{MESSAGE}\n"; 
 open (FOO, "|/opt/zimbra/postfix/sbin/sendmail -Am -t"); 
 print FOO "To: $pwc\nFrom: $fr\nSubject: Service $args{SERVICE} $args{STATUS} on $args{HOST}\n\n$args{MESSAGE}\n";
 close FOO; }

perlcode 0 sub dodisksmtp {   my %args = (@_);  print "SMTP notification: $args{MESSAGE}\n"; 
 open (FOO, "|/opt/zimbra/postfix/sbin/sendmail -Am -t"); 
 print FOO "To: $pwc\nFrom: $fr\nSubject: Disk $args{DISK} at $args{UTIL}\% on $args{HOST}\n\n$args{MESSAGE}\n"; 
 close FOO; } 

perlcode 0 sub dosnmp {   my %args = (@_); print "SNMP notification: $args{MESSAGE}\n"; 
 `$snmptrap $snmpsvctrap $snmpsvcname s $args{SERVICE} $snmpsvcstatus i $statuses{$args{STATUS}}`; }

ignore /DEBUG/

watchfor /err: Service status change: (\S+) (.*) changed from stopped to running/ 
	donotify SERVICE=$2,STATUS=started,HOST=$1
watchfor /err: Service status change: (\S+) (.*) changed from running to stopped/ 
	donotify SERVICE=$2,STATUS=stopped,HOST=$1

watchfor /err: Disk warning: (\S+) (\S+) at (\d+)/ 
        donotify DISK=$2,UTIL=$3,HOST=$1
watchfor /crit: Disk warning: (\S+) (\S+) at (\d+)/ 
        donotify DISK=$2,UTIL=$3,HOST=$1
Enhanced MIB Files For HP OpenView

I've created an RFE for this:

Zimbra does not provide "enhanced" mib files" at this time. Thresholds can be set by the customer within their individual monitoring system. Zimbra is alerting on is service up or service down, see the other information above in Ajcody-Logging#SNMP_And_Zimbra .

Some Choices

Charting & Graphing The Data
Montoring Software

Nagios On Zimbra

This is a really rough draft for ideas I have in background. Shouldn't be used by anyone.

Configure Nagios to run on single server Zimbra box - Centos 5.x

Configure yum with repo and install nagios

vi /etc/yum.repos.d/Dag.repo
yum update
yum install nagios nagios-plugins nagios-devel nagios-plugins-nrpe

Move nagios.conf http file into main zimbra directory.

cp /etc/httpd/conf.d/nagios.conf /opt/zimbra/httpd/conf/extra/

Setup nagios to run as zimbra

vi /etc/nagios/nagios.cfg
**Change nagios user to zimbra**

Change ownership of directories from nagios to zimbra.

chown -R 500:500 /var/log/nagios/
chown -R 500:500 /etc/nagios/
chown -R 500:500 /usr/share/nagios/

Configure authentication within Nagios

vi /etc/nagios/nagios.cfg

Set up httpasswd's for the accounts for Nagios

htpasswd -c /etc/nagios/htpasswd.users nagiosadmin
htpasswd /etc/nagios/htpasswd.users guest

Configure Zimbra's http/apache to use nagios http config file

vi /opt/zimbra/conf/httpd.conf
**Add the following towards bottom**
# Include Nagios
Include /opt/zimbra/httpd/conf/extra/nagios.conf

Starting nagios is done as root

/etc/init.d/nagios start

Restarting apache for nagios issues would be done with (as zimbra)

zmapachectl stop
zmapachectl start

The webpage address to view Nagios will be like this:


Use the rest of this how-to to configure it now: http://wiki.centos.org/HowTos/Nagios

MRTG - SNMP On Zimbra

This is a really rough draft for ideas I have in background. Shouldn't be used by anyone.

Configure yum with repo and install mrtg, net-snmp, net-snmp-utils

vi /etc/yum.repos.d/Dag.repo
yum update
yum instal mrtg net-snmp net-snmp-utils

Follow some how-to on setting up the basics.

Create a http config:

vi /opt/zimbra/httpd/conf/extra/mrtg.conf
Alias /mrtg "/opt/zimbra/mrtg"
<Directory "/opt/zimbra/mrtg">
#  SSLRequireSSL
  Options None
  AllowOverride None
  Order allow,deny
  Allow from all
#  Order deny,allow
#  Deny from all
#  Allow from

Add mrtg to http configuration within zimbra:

vi /opt/zimbra/conf/httpd.conf
# Include Mrtg
Include /opt/zimbra/httpd/conf/extra/mrtg.conf

Restart apache:

zmapachectl stop
zmapachectl start

Create directory to hold mrtg data:

mkdir /opt/zimbra/mrtg

Address will be something like:


Mailq Pointing To Right Binary

# ls -la /usr/bin/mailq
 lrwxrwxrwx 1 root root 27 Sep  3 17:00 /usr/bin/mailq -> /etc/alternatives/mta-mailq
# ls -la /etc/alternatives/mta-mailq
 lrwxrwxrwx 1 root root 23 Apr  1 10:17 /etc/alternatives/mta-mailq -> /usr/bin/mailq.sendmail
# rm /usr/bin/mailq
# ln -s /opt/zimbra/postfix/sbin/mailq /usr/bin/mailq
# mailq
 Mail queue is empty

Web Client Logging

Active Sessions

Please see Zmsoap#Active_Server_Sessions_With_DumpSessionsRequest

Debug (SOAP) via Browser

See http://wiki.zimbra.com/index.php?title=Web_Client_URL_Tricks&redirect=no

Admins To View Client Issues

Within the admin console, you can view users mail.

  • Goto accounts and highlight the user having the problem.
  • Click on the View Mail button above that frame.
  • Then goto the url field of that new window and modify it to look like this [replace mailserver with yours]:
  • Hit your return key to cause the browser to reload.
    • If you get warning about pop-up, accept it.
    • If the debug window doesn't show, just mouse in the url field and hit the return key again. It should now pop up.
Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

User Management Topics

Actual User Management Topics Homepage

Please see Ajcody-User-Management-Topics

Resetting A User's Account From CLI

Resetting A Password

Standard Method

SetPassword [sp] from zmprov:

zmprov sp joe@domain.com test321

Resetting Users Auth Session - Force Disconnect

Please See First - In Case Of Compromised Accounts / Spammers

Note - Restarting the mta services will be important once you reset the password/s or lock the account. It's required to ensure the active connections will be closed and any existing auth tokens no longer are valid. See:

Changing the Users Password To Expire Session

See Resetting A Password Via CLI or change it via the admin console.

Prior To 605 - Use CLI To Change zimbraAuthTokenValidityValue To Expire The Session

Change the zimbraAuthTokenValidityValue to a small time value:

su - zimbra
zmprov ma <accountname> zimbraAuthTokenValidityValue 1
zmprov fc account <accountname>

This value gets stored in the auth token and compared on every request. Changing it will invalidate all outstanding auth tokens.

6.0.5+ You Have Admin Console Option

In the admin console, under the Manage Accounts window you can right click on the user name and choose "Expire Sessions".

User , Mailbox ID's, And Who Is What

ZimbraID [UserID] is system wide.

MailboxID is per server store.

To get the ZimbraID:

$ zmprov ga user@domain.com | grep -i zimbraid
zimbraId: aeca260b-6faf-4cfe-b407-7673748aabf4
zimbraIdentityMaxNumEntries: 20

To get the MailboxID, get on the appropriate mailserver and:

zmprov gmi user@domain.com
mailboxId: 3
quotaUsed: 251512

or globally:

/opt/zimbra/bin/mysql -e "use zimbra; select id from mailbox where account_id = 'UserID HERE including the leading 0'"

Other details can be found here:


Account & Domain Summary

Run zmaccts

Here's what it would return:

su - zimbra
[zimbra@mail3 ~]$ zmaccts
           account                          status             created       last logon
------------------------------------   -----------     ---------------  ---------------
admin@mail3.internal.domain.com           active      05/06/08 18:46   07/08/08 09:56
ajcody@mail3.internal.domain.com          active      05/06/08 20:43   06/23/08 15:48
ajcody2@mail3.internal.domain.com         active      05/28/08 11:48   06/30/08 17:44
forward@mail3.internal.domain.com         active      05/06/08 21:06   05/29/08 17:24
ham.bidiob2mm@mail3.internal.domain.com   active      05/06/08 18:47            never
spam.rormmtcyy@mail3.internal.domain.com  active      05/06/08 18:47            never
wiki@mail3.internal.domain.com            active      05/06/08 18:46            never
           account                        status             created       last logon
------------------------------------   -----------     ---------------  ---------------
secondary@secondary.internal.domain.com   active      06/23/08 15:26   06/23/08 15:27
wiki@secondary.internal.domain.com        active      06/23/08 15:25            never
                                domain summary
    domain                  active    closed    locked    maintenance     total
-----------------------   --------  --------  --------  -------------  --------
mail3.internal.domain          7         0         0              0         7
secondary.internal.domain          2         0         0              0         2

Last Logon comes from the variable zimbraLastLogonTimestamp . This is used to update the "Last Login Time" column in the admin web console as well. It also shows up with [ zmprov ga user@domain ]. Login's based upon session type would only be found in either audit.log or the mailbox.log files. It should have a reference to the user id and the session type for the login [ pop, imap, etc. ].

RFE To Expand zmaccts Output And Options

Please see the following RFE I made:

Zmmailbox Stuff

Shares And Permissions

RFE's And Bugs To Review

Please see these RFE's first:

Some other's to look at:

To See All Folders For A User

Do the following for the user:

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@DOMAIN gaf
        Id  View      Unread   Msg Count  Path
----------  ----  ----------  ----------  ----------
         1  conv           0           0  /
        16  docu           0           2  /Briefcase
        10  appo           0           1  /Calendar
        14  mess           0           0  /Chats
         7  cont           0           0  /Contacts
         6  mess           0           0  /Drafts
        13  cont           0           9  /Emailed Contacts
         2  mess           0          11  /Inbox
         4  mess           0           0  /Junk
       344  mess           0           0  /Junk E-mail
        12  wiki           0           0  /Notebook
       302  appo           0           0  /Restored
         5  mess           0          15  /Sent
       420  mess           0           0  /Share
       421  mess           0           0  /Share/Share1
       422  mess           0           0  /Share/Share1/Share1-1
       423  mess           0           0  /Share/Share2
       424  mess           0           0  /Share/Share2/Share2-1
        15  task           0           2  /Tasks
         3  conv           0           0  /Trash

To See All Shares And Perms On A Users Folders

Do the following for the user [ I'm cutting some of the output to keep it short ]:

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@DOMAIN gaf -v
 "id": "1",
 "name": "USER_ROOT",
 "path": "/",
 "parentId": "11",
 "flags": null,
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "conversation",
 "url": null,
 "effectivePermissions": null,
 "children": [
 "id": "5",
 "name": "Sent",
 "path": "/Sent",
 "parentId": "1",
 "flags": null,
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 15,
 "view": "message",
 "url": null,
 "effectivePermissions": null
 "id": "420",
 "name": "Share",
 "path": "/Share",
 "parentId": "1",
 "flags": "i",
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "message",
 "url": null,
 "effectivePermissions": null,
 "grants": [
 "type": "usr",
 "name": "ajcody2@mail3.internal.domain.com",
 "id": "88fd808e-a526-419d-9eda-ad50100d23b6",
 "permissions": "rwidx",
 "args": null
 "type": "all",
 "name": null,
 "id": null,
 "permissions": "rwx",
 "args": null
 "children": [
 "id": "421",
 "name": "Share1",
 "path": "/Share/Share1",
 "parentId": "420",
 "flags": "i",
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "message",
 "url": null,
 "effectivePermissions": null,
 "grants": [
 "type": "usr",
 "name": "ajcody2@mail3.internal.domain.com",
 "id": "88fd808e-a526-419d-9eda-ad50100d23b6",
 "permissions": "rwidx",
 "args": null
 "type": "usr",
 "name": "admin@mail3.internal.domain.com",
 "id": "5ab13330-2e9b-4a45-9b30-de2c70858265",
 "permissions": "rwidx",
 "args": null
 "children": [
 "id": "422",
 "name": "Share1-1",
 "path": "/Share/Share1/Share1-1",
 "parentId": "421",
 "flags": null,
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "message",
 "url": null,
 "effectivePermissions": null
 "id": "423",
 "name": "Share2",
 "path": "/Share/Share2",
 "parentId": "420",
 "flags": null,
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "message",
 "url": null,
 "effectivePermissions": null,
 "children": [
 "id": "424",
 "name": "Share2-1",
 "path": "/Share/Share2/Share2-1",
 "parentId": "423",
 "flags": null,
 "color": "defaultColor",
 "unreadCount": 0,
 "messageCount": 0,
 "view": "message",
 "url": null,
 "effectivePermissions": null

Remove All Shares

RFE I filed for zmmailbox to have options for this and "recursive".

Script To Remove All Shares

Here's a script I wrote. Remove the echo statements to actually run the commands.

GETPERM="zmmailbox -z -m $USER gfg $SHARE"
MODPERM="zmmailbox -z -m $USER mfg $SHARE"

$GETPERM | egrep -i 'all|guest|public|accoun|domain|group' | gawk '{print $2 " " $3}' | while read SHAREPERM
TYPE=`echo $SHAREPERM|awk '{print $1}'`
DISPLAY=`echo $SHAREPERM|awk '{print $2}'`

case $TYPE in
        accoun) echo $MODPERM account $DISPLAY $NEWPERM
        all) echo $MODPERM $TYPE $NEWPERM

Ouput of an example:

[zimbra@mail3 ~]$  zmmailbox -z -m ajcody@mail3.internal.domain.com gfg /Shared
Permissions    Type  Display
-----------  ------  -------
          r     all
          r   guest  ajcody@domain.com
          r  accoun  admin@mail3.internal.domain.com
          r   group  mydl@mail3.internal.domain.com
          r  domain  mail3.internal.domain.com
[zimbra@mail3 ~]$ /tmp/remove-share.sh
zmmailbox -z -m ajcody@mail3.internal.domain.com mfg /Shared all none
zmmailbox -z -m ajcody@mail3.internal.domain.com mfg /Shared guest ajcody@domain.com none
zmmailbox -z -m ajcody@mail3.internal.domain.com mfg /Shared account admin@mail3.internal.domain.com none
zmmailbox -z -m ajcody@mail3.internal.domain.com mfg /Shared group mydl@mail3.internal.domain.com none
zmmailbox -z -m ajcody@mail3.internal.domain.com mfg /Shared domain mail3.internal.domain.com none

I then removed the echo statements:

[zimbra@mail3 ~]$ vi /tmp/remove-share.sh
[zimbra@mail3 ~]$ /tmp/remove-share.sh
[zimbra@mail3 ~]$  zmmailbox -z -m ajcody@mail3.internal.domain.com gfg /Shared
Permissions    Type  Display
-----------  ------  -------
[zimbra@mail3 ~]$
User Contributed Perl Script To Remove All Shares

Please TEST this on a test box or a test account before running against a production situation. ZCS version change and commands might act different. Also note, this is a user contributed script and not one from Zimbra developers or the support staff. Also - the wiki formatting might throw of the script and could require you to fix before it runs correctly.

Script is called - zmshares - and should be named such.

#!/usr/bin/env perl
# This program was written by Pablo Garaitonandia on Nov. 26 2012.
# This program is for viewing and deleting all the shares that a user 
# may have in the event that removing the many shares a user has is 
# time consuming.
# This was written on a system running Zimbra 7.2.0, RHEL 5.8, with perl v5.8.8

use strict;
use warnings;
use Getopt::Long;

my $id=getpwuid($<);
my $help=0;
my $user_id=0;
my $option=0;
my @shares;
sub view_share;
sub del_share;

chomp $id;
if ($id ne "zimbra") {
	print STDERR "Error: must be run as zimbra user\n";
	exit (1);

        'h|help' => \$help,
        'u|uid=s' => \$user_id,
	'o|option=s'=> \$option, ) or die "Incorrect usage!\n";

# Check for usage, definition, and correct argument types
if ((defined ($user_id) && ($user_id =~ /([a-z0-9]+@[a-z.]+\.[a-z.]+)/gi)) 
	&& (defined ($option) && (($option eq "delete") || ($option eq "view")))) {
		print "\n$option: shares for $user_id \n\n";
		} elsif ($help) {
		} else {

if ($option eq "view"){ view_share();}
if ($option eq "delete"){ del_share();}

sub view_share {
	open(VIEW, "/opt/zimbra/bin/zmprov getShareInfo $user_id |");	
	print <VIEW>;

sub del_share {
	open(SHARES, "zmprov getShareInfo $user_id |awk '{print substr(\$0,70,6) ,substr(\$0,131,36), substr(\$0,168,15)}' | awk 'NR>2' |");
	@shares = <SHARES>;
	if (!(@shares)){
		print "EXITING: User has no shares to delete.  \n\n";
		 exit (1);
	foreach my $share (@shares){
		my @line = split(/\s+/, $share);
		if (defined ($line[2])){
			print "zmmailbox -z -m $user_id  mfg $line[0] account $line[1] none\n";
			system("/opt/zimbra/bin/zmmailbox -z -m $user_id  mfg $line[0] account $line[1] none") == 0
				or die "Command Failed";
			} else {
			print "zmmailbox -z -m $user_id  mfg $line[0] account \"\" none\n";
			system("zmmailbox -z -m $user_id  mfg $line[0] account \"\" none") == 0
				or die "Command Failed";

sub usage {

        my ($msg) = (@_);

        $msg && print STDERR "\nINCORRECT USAGE: $msg\n";
        print STDERR <<USAGE;

  zmshares -u username\@domain -o (delete|view)

  -u: (user\@domain)  The full user id with domain for user. 
  -o: (delete|view) Delete or view ALL shares for the user

        exit (1);


Setting Up A Share - CLI

I've yet to test these against all items (resources) listed in bug 25740 and work as expected.

To see current perms

zmmailbox -z -m faxfinder@example.com gfg /Inbox

To modify perms:

  • r = read
  • w = write
  • i = insert
  • d = delete
  • x = accept/decline invites
  • a = administer
zmmailbox -z -m faxfinder@example.com mfg /Inbox account user@example.com rwidx

To confirm perms are set:

zmmailbox -z -m faxfinder@example.com gfg /Inbox

To mount "folder" into a user account that was given permission:

zmmailbox -z -m user@example.com cm --view message "/Incoming_Faxes" faxfinder@example.com /Inbox

To confirm folder is mounted:

zmmailbox -z -m user@example.com gaf

Additions notes/options see:

zmmailbox help folder 

For mfg it shows it can take the below as a target:

  • account {name}
  • group {name} *This could be a DL?*
  • domain {name}
  • all
  • public
  • guest

Scripting note to do this with multiple users:

  • zmmailbox cm could use the zmprov gaa to provide a list of all accounts, this would include system & archive (if exist) accounts though.

How To Turn Off Sharing

You can enable / disable sharing from admin console:

- Admin console --> class of service --> select the CoS (eg default) --> features --> general features --> check/uncheck 'Sharing' option

Alternatively, this can be achieved by having the following CoS attribute either 'TRUE' or 'FALSE', from command line: zimbraFeatureSharingEnabled

Searches With zmmailbox

Special Note If Your Search String Needs Spaces

Here is an example using the correct format to include required spaces to have your search do what you want. For instance, many shared folders will end up using, by default, spaces in the folder name.

$ zmmailbox -z -m ajcody@`zmhostname` gaf | grep appo
        10  appo           0           0  /Calendar
       263  appo           0           2  /Large Share's Calendar (large-share@mail71.DOMAIN.com:10)

$ zmmailbox -z -m ajcody@`zmhostname` s -t appo in:"\"Large Share's Calendar"\"
num: 2, more: false

                                         Id  Type   From        Subject               Date
   ----------------------------------------  ----   ----------  --------------------- ------
1. 799efb72-2e6b-400a-8881-c5f9d7c282b1:265  appo   <na>        Test On Thu           10/28/10 00:02
2. 799efb72-2e6b-400a-8881-c5f9d7c282b1:263  appo   <na>        test for friday       10/28/10 00:02

Note, the "\"Text1 Text2"\" is for a [s option] search string query, when querying for the folder name with other zmmailbox options - normal quoting works. For example:

$ zmmailbox -z -m ajcody@`zmhostname` gfg "Large Share's Calendar"  
Permissions      Type  Display
-----------  --------  -------
     rwidxa   account  ajcody@mail71.DOMAIN.com

Search For Messages And Then Delete Them

Here's some examples to grab the message id's from a search and then put them in a variable to use for the delete command.

Other reference: King0770-Notes#Removing_Messages_with_Zmmailbox_based_on_the_Subject

Note - Crossmailbox Search And Delete Is Currently An RFE

See the following :

First - Default Search Returns Only 25 Results

From zmmailbox [help search] & zmmailboxsearch

--limit (optional)
Sets the limit for the number of results returned. The default is 25.
Example Search With A From And To Date - Multiple Variable Search

This allows you to restrict your search in-between a date range.

zmmailbox -z -m user@domain.com s -t message -l 999 "before:6/15/2011 and after:6/9/2011"

Note - If your trying to do this for a tgz export, please see the following :

Example Search With To Field
[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "To: Adam"
num: 4, more: false

     Id  Type   From                  Subject                                             Date
   ----  ----   --------------------  --------------------------------------------------  --------------
1.  269  mess   Adam                  Re: 8-7-08 11:37 AM to both outside accounts        08/07/08 11:57
2.  268  mess   Adam                  Re: 8-7-08 11:37 AM to both outside accounts        08/07/08 11:39
3.  266  mess   Adam                  Re: 8-7-08 11:37 AM to both outside accounts        08/07/08 11:38
4.  263  mess   Adam                  Re: test on 8-7-08 to zimbra account                08/07/08 11:37

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "To: Adam" |awk '{ if (NR!=1) {print}}'| grep mess | awk '{ print $2 "," }' | tr -d '\n'


[zimbra@mail3 ~]$ message=`zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "To: Adam" |awk '{ if (NR!=1) {print}}'| grep mess | awk '{ print $2 "," }' | tr -d '\n'`

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com dm `echo $message`

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "To: Adam"
num: 0, more: false
Example Search With From Field
[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "From: Adam"
num: 8, more: false

     Id  Type   From                  Subject                                             Date
   ----  ----   --------------------  --------------------------------------------------  --------------
1.  464  mess   Adam                  test 3                                              10/02/08 11:43
2.  463  mess   Adam                  test  2                                             10/02/08 11:43
3.  462  mess   Adam                  test  1                                             10/02/08 11:43
4.  461  mess   Adam                  test                                                09/29/08 16:18
5.  460  mess   Adam                  test for mailbox log                                09/29/08 16:17
6.  265  mess   Adam                  8-7-08 11:37 AM to both outside accounts            08/07/08 11:38
7.  261  mess   Adam                  test on 8-7-08 to zimbra account                    08/07/08 11:36
8.  257  mess   Adam                  test from zimbra on 8-7-08                          08/07/08 11:27

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "From: Adam" |awk '{ if (NR!=1) {print}}'| grep mess | awk '{ print $2 "," }' | tr -d '\n'


[zimbra@mail3 ~]$ message=`zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "From: Adam" |awk '{ if (NR!=1) {print}}'| grep mess | awk '{ print $2 "," }' | tr -d '\n'`

[zimbra@mail3 ~]$ echo $message


[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com dm `echo $message`

[zimbra@mail3 ~]$ zmmailbox -z -m ajcody@mail3.internal.DOMAIN.com s -t message "From: Adam"
num: 0, more: false

[zimbra@mail3 ~]$

More Search Possibilities

Please see [Search Tips]

Export & Import Of Users Data In TGZ Format

Please see Ajcody-Migration-Notes#ZCS_User_to_Another_ZCS_Server_-_With_Rest_.26_TGZ

Seeing What & Where Of A Message ID

If your need to figure out what the actual email/message is from a logging event.

For example, log shows:

 2009-03-03 22:04:58,969 INFO [btpool0-5532] [name=USER@DOMAIN.com;mid=8;ip=;ua=ZimbraWebClient - IE6
(Win)/5.0.11_GA_2695.UBUNTU8_64;] mailop - moving Message (id=10955) to Folder Trash (id=3) 

To see the details of the message, do the following:

zmmailbox -z -m USER@DOMAIN gm 10955
Id: 10955
Conversation-Id: 11155
Folder: /Trash
Subject: FW: How are you doing?
From: User External <USER@DOMAIN.com>

Message Count Mismatches

Message Count Via zmprov

To see a listing of message count in folders, replace USER@DOMAIN w/ user:

zmmailbox -z -m USER@DOMAIN gaf

You can also do something like this:

zmmailbox -z -m USER@DOMAIN s -t mess in:"FOLDER_IN_QUESTION"

If the folder has spaces, use the following format : "\"Large Share's Calendar"\"

zmprov rmc RecalculateMailboxCounts

From the zmprov help for rmc:

RecalculateMailboxCounts  rmc  {name@domain|id}
  When unread message count and quota usage are out of sync with the data 
  in the mailbox, use this command to immediately recalculate the mailbox 
  quota usage and unread messages count.

  Important: Recalculating mailbox quota usage and message count should be 
  schedule to run in off peak hours and used on one mailbox at a time. 

  $zmprov rmc user@domain

Users should log into a new ZWC session after this was done.

If User Is Using IMAP Client

We have some bugs/rfe's in regards to how various IMAP clients operate with their delete/purge and it's impact on the our message counting.

Here's a recent one:

One work around was by configuring the IMAP client to move messages to a Trash/Deleted Items folder [if available] and to delete/purge messages immediately or upon sign off.

Check The Message Blobs On The File System

This is more of a sanity check, confirming the user does have what you would estimate for message blobs on the file system under their message store path.

See: Ajcody-Mysql-Topics#How_To_Locate_Users_Mailstore_and_Message_Store_Directory

You might also see "No Such Blob" messages in the ZWC client and the mailbox.log file.

See: Ajcody-Notes-No-Such-Blob

Make Sure Your Not Auto-purging Messages

These are set at the global or server level.

zmprov gacf | egrep "zimbraMailPurgeSleepInterval|zimbraMailTrashLifetime|\

zmprov gs server.domain.com | egrep "zimbraMailPurgeSleepInterval|\

These at the user level:

zmprov ga user@domain | egrep "zimbraPrefInboxReadLifetime|zimbraPrefInboxUnreadLifetime|\


Managing Legal Requests for Information


The ZCS legal intercept feature is used to obtain copies of email messages that are sent, received, or saved as drafts from targeted accounts and send these message to a designated “shadow” email address. Legal Intercept can be configured to send the complete content of the message or to send only the header information. When a targeted account sends, receives, or saves a draft message, an intercept message is automatically created to forward copies of the messages as attachments to the specified email address.

Please see:

Persona, Identities, Send As, Send On Behalf Of Issues

For ZCS 8 And Above You Must Grant ACL Rights For sendAs and sendAsDistList for internal users

This section below only applies to versions ZCS 6 and ZCS 7. For ZCS 8 and above, the zimbraAllowFromAddress variable only is valid for external accounts and can NOT be used for internal users or ZCS distribution lists [DL's]. Please see the following for ZCS 8+

CLI Commands To Manage Persona, Identities, External Account

The following should provide you with the necessary commands to manage these user configurations:

zmprov help command| egrep -i 'data|identity'
 createDataSource(cds) {name@domain} {ds-type} {ds-name} [attr1 value1 [attr2 value2...]]
 createIdentity(cid) {name@domain} {identity-name} [attr1 value1 [attr2 value2...]]
 deleteDataSource(dds) {name@domain|id} {ds-name|ds-id}
 deleteIdentity(did) {name@domain|id} {identity-name}
 getDataSources(gds) {name@domain|id} [arg1 [arg2...]]
 modifyDataSource(mds) {name@domain|id} {ds-name|ds-id} [attr1 value1 [attr2 value2...]]
 modifyIdentity(mid) {name@domain|id} {identity-name} [attr1 value1 [attr2 value2...]]

Bugs And RFE's To Look At

Send As Issues

On Behalf Of Issues

Persona Setup With Send As [zimbraAllowFromAddress] Rights Rather Than On Behalf Of

This section below only applies to versions ZCS 6 and ZCS 7. For ZCS 8 and above, the zimbraAllowFromAddress variable only is valid for external accounts and can NOT be used for internal users or ZCS distribution lists [DL's]. Please see the following for ZCS 8+

Using A DL - Mailing List - As Your Shared Email Address

This was tested against ZCS 6.0.8p1 .

Attribute descriptions - 608 :

zimbra-attrs.xml:<attr id="427" name="zimbraAllowAnyFromAddress" type="boolean" 
   cardinality="single" optionalIn="account,cos" flags="accountInfo,accountInherited">

zimbra-attrs.xml:<attr id="428" name="zimbraAllowFromAddress" type="email" max="256" 
   cardinality="multi" optionalIn="account" flags="accountInfo,domainAdminModifiable">
  • First, created a test user account:
    • ajcody@rr608.zimbra.DOMAIN.com
      • In the admin web console, under the users preferences tab :
        • Sending Mail > checked  : "Allow sending email from any address"
          • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowAnyFromAddress TRUE
          • Note, this could be setup in a COS as well and then assign the users you want to that COS
          • If this is to permissive, because it does allow the user to send as anybody, then you'll want to do this instead:
            • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowAnyFromAddress FALSE
            • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowFromAddress personal-dl@rr608.zimbra.DOMAIN.com
              • Note - bug alert.
                • Testing shown that you could still have a persona setup for a particular address that wasn't set for the zimbraAllowFromAddress variable and zimbraAllowAnyFromAddress is set as FALSE. You'll be able to select it when composing a message and the message is sent with no error. But, what happens is the email is delivered to the recipient with your primary account details rather than the persona's.
  • If your only using a DL for the mail traffic, you would:
    • Create a new DL :
      • persona-dl@rr608.zimbra.DOMAIN.com
        • checked "Can receive email"
        • Added a user/s to the DL:
          • ajcody@rr608.zimbra.DOMAIN.com
  • Now, once that is done we can setup the persona for our "test user" - ajcody. Login as testuser
    • Create a Folder called "Persona DL" and then a filter rule to move all emails with persona-dl@rr608.zimbra.DOMAIN.com to the "Persona DL" folder.
      • Under the users perferences, Mail > Accounts > Add Persona button:
        • Persona Name : Persona DL
          • From : Persona DL # personal-dl@rr608.zimbra.DOMAIN.com
          • Reply-To : Persona DL # personal-dl@rr608.zimbra.DOMAIN.com
          • Use this persona:
          • check "when replying or forwarding messages sent to: Persona DL # personal-dl@rr608.zimbra.DOMAIN.com
          • check "when replying or forwarding messages in folder(s) : Personal DL
  • Things to note when using persona
    • A new message in the "From" section will give a drop down for your persona choice.
    • It's best to create a mail filter rule to put related messages for the persona account into a folder and then in the persona choose the option about using the persona as the default when replying to messages in that folder.

Using A Shared Mailbox As Your Shared Email Address

This section below only applies to versions ZCS 6 and ZCS 7. For ZCS 8 and above, the zimbraAllowFromAddress variable only is valid for external accounts and can NOT be used for internal users or ZCS distribution lists [DL's]. Please see the following for ZCS 8+

The below how-to was tested against ZCS 6.0.8p1 .
  • First, created a test user account:
    • ajcody@rr608.zimbra.DOMAIN.com
      • In the admin web console, under the users preferences tab :
        • Sending Mail > checked  : "Allow sending email from any address"
          • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowAnyFromAddress TRUE
          • Note, this could be setup in a COS as well and then assign the users you want to that COS
          • If this is to permissive, because it does allow the user to send as anybody, then you'll want to do this instead:
            • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowAnyFromAddress FALSE
            • zmprov ma ajcody@rr608.zimbra.DOMAIN.com zimbraAllowFromAddress personal-source@rr608.zimbra.DOMAIN.com
              • Note - bug alert.
                • Testing shown that you could still have a persona setup for a particular address that wasn't set for the zimbraAllowFromAddress variable and zimbraAllowAnyFromAddress is set as FALSE. You'll be able to select it when composing a message and the message is sent with no error. But, what happens is the email is delivered to the recipient with your primary account details rather than the persona's.
  • If I was only using a "shared mailbox" for the mail traffic, I would:
    • First create a DL that will have the user accounts you want to share this 'new' mailbox [Inbox]:
      • Create a new DL:
        • persona-share@rr608.zimbra.DOMAIN.com
          • checked "Can receive email"
          • Added a user to the DL:
            • ajcody@rr608.zimbra.DOMAIN.com
  • The create a new account/mailbox that others will share:
    • persona-source@rr608.zimbra.DOMAIN.com
      • From the 'admin console', do "View Mail" on the new account
        • Share the Inbox to the DL : persona-share@rr608.zimbra.DOMAIN.com w/ Manager or Admin Rights
  • Log back into the 'test user' acocunt - ajcody@rr608.zimbra.DOMAIN.com
    • Accept the share and confirm you see the "Inbox" from the "persona-source" account.
      • Then, under the users perferences, Mail > Accounts > Add Persona button::
        • Persona Name : Persona Source
          • From : Persona Source # persona-source@rr608.zimbra.DOMAIN.com
          • Reply-To : Persona Source # persona-source@rr608.zimbra.DOMAIN.com
          • Use this persona:
          • check "when replying or forwarding messages sent to: persona-source@rr608.zimbra.DOMAIN.com
          • check "when replying or forwarding messages in folder(s) : Persona Source's Inbox
  • Things to note when using persona
    • A new message in the "From" section will give a drop down for your persona choice.
    • It's best to create a mail filter rule to put related messages for the persona account into a folder and then in the persona choose the option about using the persona as the default when replying to messages in that folder.
    • Need An RFE/BUG Report? - When you have a shared mailbox folder, the 'normal' operation when replying to messages from that folder is to send them "on behalf of". You don't want this option, since your wanting to use the persona rules. You might need to "uncheck" the box under the new message that says:
      • uncheck box for "Send this message on behalf of: persona-source@rr608.zimbra.DOMAIN.com"
      • I couldn't find a way to have this "unchecked" as the default.

Sieve Rules

Administrating Rules For Users - CLI

Please see King0770-Notes-Sieve_Rules_By_Proxy

Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

Client Topics

Actual Client Topics Homepage

Please see Ajcody-Client-Topics

Official End User Guides And How-To's

Please see the following:



Small Screen Resolution Issues - 800x600

Please see the following:

Section 508 , VPAT, ADA, And Accessibility


About section 508 and Accessibility:

Various Zimbra RFE's related to topic:

Zimbra Web Client

Setting ZWC As Default Mail Client - Mailto

Seeing What Is Currently Set For Mailto Handler In Various Browsers

  • Firefox: Seeing what mailto is currently configured as:
    • In url field , about:config and hit enter.
      • Search for mailto
  • Chrome: Seeing what mailto is currently configured as:
    • In url field , chrome://settings/handlers and hit enter.
    • Will pop up a box, if empty, then nothing is set.

ZCS 8 And RFE To Set ZWC As Default Mail Client

Per the following RFE, with ZCS 8 a user should be prompted upon first login if they want to set ZWC as their default mail client.

Most Complete Solution For Windows - Full Mailto & MAPI Calls Mapping via Zimbra Notifier

First, though it's unsupported directly by the Zimbra Support team, most users will prefer to use this because of its full functionality:

The other option is setting up a registry key within windows.

Windows Mailto To Use ZWC Advance Ajax Client or Basic HTML Client Interface

Note, the Windows examples below use the url string to use the ZWC Advanced Ajax client, if you want to use the ZWC Basic HTML one you'll use a string like the following instead :

  • https://mail.server.com/h/search?action=compose&to=%1

Windows 7 Mailto Registry Key

Save the following to a file ending with a name of .reg, and modify the following items below to suit the user. Save the file after you made the changes. Run the registry editor [Start > Run > regedit ] and do a File > Import - selecting the file you had saved.

Windows Registry Editor Version 5.00


"URL Protocol"=""



@="C:\\Path\\to\\Program.exe https://mail.server.com?username=user@example.com&view=compose&to=%1"

  • Change the C:\\Path\\to\\Program.exe to the full path of browser executable to be used or to "rundll32.exe url.dll,FileProtocolHandler" [This will use the default registered browser of the user] .
    • Note - When importing a reg key, you have to use \\ in the path rather than just one\ . Once imported, the key value will only show one \ per directory.
    • Firefox example
      • @="C:\\Program Files (x86)\\Mozilla Firefox\\firefox.exe https://mail.domain.com?username=user@domain.com&view=compose&to=%1"
    • Chrome example
      • @="C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe https://mail.domain.com?username=user@domain.com&view=compose&to=%1"
    • IE example
      • @="C:\\Program Files (x86)\\Internet Explorer\\iexplore.exe https://mail.domain.com?username=user@domain.com&view=compose&to=%1"
  • Change the mail server name and the user name :
    • mail.server.com?username=user@example.com
    • for example mycompany.com?username=john@mycompany.com

Windows Xp And Windows 98 MailTo Setup

See the following Microsoft KB :

You'll need to adjust the "Application used to perform action:" to be like one of the examples below:

Conversation Views

Here's an RFE I made you might want to check out:

Read & Delivery Confirmation Receipt

Please see RFE:

Web Client Search

The webclient offers a powerful search tool, the problem is knowing how to use it.

Please see this to learn the proper syntax's to get your searches right:

[Web Client Search - Power tip]

[Search Tips]

Is some particular state [ unread, read, flagged, unflagged, sent, draft, received, replied, unreplied, forwarded, unforwarded, anywhere [show messages anywhere], local, sent, solo [haven't replied, without a conversation] ]:


In A Folder (Inbox):


Unread and in Inbox:

In:Inbox is:uread

To someone:


From someone:


CC'd reference:


Subject reference:


Has something [attachment , phone , url]


A particular 'something':


Size of mesage [{larger,smaller} : ## "b","kb","mb"]


By tag:


Email To Attachment Or Saved To Desktop

Send Email As Attachment

You can do a "forward" on an email and then in the new window, select "Options". This drop down will give you the options to "Include Orginal As Attachment".

Attachments Saved To Desktop And Other Options

Some RFE's are more expansive functionality:

A non-support zimlet that could be used:

Date Format date_zimlet Issues

Most likely, your issues are addressed in the following:

General CALDAV Issues

Only Seeing 1 Month Back and 1 Year Ahead In CalDAV

Please see this bug:


Lightning & Thunderbird

News Bugs/RFE's To Track That Might Update Situation As Described Below

Lightning does not support Caldav + Free/Busy

Free/Busy support is only available for the Sun Cal Server.

Maybe we could "fake" this out within our Ldap configuration. Like RFE for Apple OD:


Address/username lookup doesn't occur within a new appointment

Unfortunately, I've not figured a way around this at this time.

Zimbra CalDav doesn't allow user to dismiss alarms from lightning

Please see bug from Mozilla:


Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

Apple/Mac Issues

Actual Apple/Mac Issues Homepage

Please see Ajcody-Apple-Mac-Issues

App To Help Enable Debugging Options

You might want to check out this app:

Outlook 2011 For Mac And EWS Setup

Follow these steps to set up Outlook to sync using Exchange Web Services:

  • Open Outlook.
  • Open the Outlook menu and select Preferences.
  • Click the Accounts icon under the Person Settings section.
  • Click the Exchange icon which will open a new window.
  • Enter your email address in the E-mail address field.
  • Set the Method to "User Name and Password."
  • Enter your full email address (e.g. user@example.com) as the username.
  • Enter your password in the password field.
  • Uncheck the "Configure automatically" check-box.
  • In the Server field, enter Zimbra Collaboration Server's hostname - (e.g. mail.example.com)
  • Click Add Account.

Note, if you end up customizing the other elements be aware of the following:

  • ZimbraEWS uses BASIC Auth for validating the user request.

With Screenshots

Please see Ajcody-Outlook_2011_For_Mac_And_EWS_Setup#Outlook_2011_For_Mac_And_EWS_Setup_With_Screenshots

Contact Related Items

EWS Configuration And ZCS 8.5+

Example is from OS X 10.9.5 . The ZCS server must be licensed for EWS and your account needs to have the EWS feature enabled. This can be enabled in the admin console either checking the box for EWS under Features in the COS that is set for the account or under the individuals user configuration for Features. It can also be set on the CLI - zimbraFeatureEwsEnabled TRUE [COS or user].

Note - ZCS 8.5 targeted EWS support ONLY with Outlook for Mac's. There was no testing or expectation that the native mac apps would work with the EWS configuration type.

  • Launch Contacts.app
  • Click on "Contacts" from the menu screen at the top of your screen.
  • Select "Add Account.."
  • Select "Exchange" and then "Continue"
  • Name : your full name
  • Email Address : user@domain
  • Password : your password
  • Once filled out, click "Continue" . You'll need move onto another configuration screen.
  • Description : I would recommend filling this out to avoid any confusion from other accounts you might setup.
  • Server Address : the FQDN/hostname of your ZCS server. You can also use an ip address here.
  • Once filled out, click "Continue" .
  • You should now see a summary of your configuration, click "Continue".
  • You'll now be asked to select what apps to use, your choices will be:
    • Mail
    • Contacts
    • Calendar
    • Notes
    • Reminders
  • Once you've checked the ones you want, click "Done".

This will create two resources within Contacts.app. You'll see a header called "Exchange" with your account contact folders under it [ZCS defaults will be - Contacts, Emailed Contacts] and also a line that says "All Exchange". There will also be a section now called "Directories", listed under it will be "All Directories" and "Exchange Global Address List".

Verify Certificate Prompts

If the ZCS server isn't using commericial certificates, you'll end up getting a pop up window on your Mac called "Verify Certificate". To get rid of this pop up window, you'll want to do the following.

Click on the "Show Certificate" button. You'll then have an option to check a box for "Always trust ....". Then click on the "Continue" button.

Log Event Showing EWS

Possible log files to check for in /opt/zimbra/log/ are below with some examples from my logging into Contacts.App and creating a new contact. You can increase the logging details if needed , please see Using_log4j_to_Configure_mailboxd_Logging#Predefined_log4j_Categories_in_ZCS  :

  • access_log.[date] -  -  [10/Oct/2014:16:01:30 +0000] "POST /EWS/Exchange.asmx HTTP/1.1" 200 907 "-" "Mac OS X/10.9.5 (13F34); 
  ExchangeWebServices/4.0 (193); Contacts/8.0 (1371.2)" 16 -  -  [10/Oct/2014:16:05:55 +0000] "GET /home/user1@mail2.zimbra.DOMAIN.com/Contacts?fmt=cf&t=2&all=all 
  HTTP/1.1" 200 - "" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) 
  Chrome/37.0.2062.124 Safari/537.36" 42 -  -  [10/Oct/2014:16:28:11 +0000] "POST /EWS/Exchange.asmx HTTP/1.1" 401 0 "-" "Mac OS X/10.9.5 (13F34); 
  ExchangeWebServices/4.0 (193); Contacts/8.0 (1371.2)" 7
  • audit.log
2014-10-10 12:01:28,976 INFO  [qtp509886383-107:] [] security - cmd=Auth; 
  account=user1@mail2.zimbra.DOMAIN.com; protocol=zsync;
2014-10-10 12:05:50,227 INFO  [qtp509886383-113:] 
  [name=user1@mail2.zimbra.DOMAIN.com;oip=;ua=zclient/8.5.0_GA_3042;] security - cmd=Auth; 
  account=user1@mail2.zimbra.DOMAIN.com; protocol=soap;
  • ews.log
2014-10-10 12:28:11,361 INFO  [qtp509886383-117:]
   [] ews - Start syncFolderHierarchy
2014-10-10 12:28:11,371 INFO  [qtp509886383-117:] 
  [] ews - User: user1 has been successfully authorized.
2014-10-10 12:28:11,371 INFO  [qtp509886383-117:]
  ews - The account: 7277b33a-c7ee-4b03-bb4b-f24814c7cea3is true
2014-10-10 12:28:11,371 INFO  [qtp509886383-117:] 
  ews - Folder Id was not provided with request, defaulting to 1
2014-10-10 12:28:11,427 INFO  [qtp509886383-117:] 
  ews - End syncFolderHierarchy
2014-10-10 12:28:11,449 INFO  [qtp509886383-118:] [] 
  ews - Start createItem version 1.0.01
2014-10-10 12:28:11,450 INFO  [qtp509886383-118:] [] 
  ews - Start: createItem
2014-10-10 12:28:11,457 INFO  [qtp509886383-118:] [] 
  ews - User: user1 has been successfully authorized.
2014-10-10 12:28:11,457 INFO  [qtp509886383-118:] 
  ews - The account: 7277b33a-c7ee-4b03-bb4b-f24814c7cea3is true
2014-10-10 12:28:11,580 INFO  [qtp509886383-118:] 
  ews - End:  createItem
2014-10-10 12:28:11,580 INFO  [qtp509886383-118:] 
  ews - End createItem
  • mailbox.log
2014-10-10 12:28:11,522 INFO  [qtp509886383-118:] 
  [name=user1@mail2.zimbra.DOMAIN.com;ip=;ua=MacOSX/(F)ExchangeWebServices/()Contacts/();] mailop - 
  adding contact test2@domain.com: id=269, folderId=7, folderName=Contacts.
  • trace_log.[date]
12:28:11.323:qtp509886383-117: REQUEST POST null; 
  Mac OS X/10.9.5 (13F34); ExchangeWebServices/4.0 (193); Contacts/8.0 (1371.2)
12:28:11.330:qtp509886383-117: RESPONSE 401 text/xml; charset=UTF-8
12:28:11.354:qtp509886383-117: REQUEST POST null; 
  Mac OS X/10.9.5 (13F34); ExchangeWebServices/4.0 (193); Contacts/8.0 (1371.2)
12:28:11.429:qtp509886383-117: RESPONSE 200 text/xml; charset=UTF-8
12:28:11.446:qtp509886383-118: REQUEST POST null; 
  Mac OS X/10.9.5 (13F34); ExchangeWebServices/4.0 (193); Contacts/8.0 (1371.2)
12:28:11.581:qtp509886383-118: RESPONSE 200 text/xml; charset=UTF-8


Logging-Debug for Addressbook

First shutdown Addressbook app.

Launch terminal app.

defaults write com.apple.addressbook ABShowDebugMenu -bool true

Turn it off by just reversing it:

defaults write com.apple.addressbook ABShowDebugMenu -bool false


Contact Groups
10.6 - Snow Leopard Notes
Basic Setup Notes

Some notes I have against testing CardDAV I shared on a case. The following was done with CardDAV [OSX 10.6.4] & Addressbook [Version 5.0.2 (870)] .

Primary references I found related to :

To setup, launch Addressbook.

  • Addressbook > Preferences
    • Accounts > click on + sign to add new account
      • Account type = CardDav
      • User Name = user
        • bug/rfe's mentions the use of user@domain vs. just user will most likely cause Addressbook to attempt a DNS SRV record lookup.
      • Password = accounts password
      • Server Address = http://servername:80 or https://servername:443
        • might need to adjust that for proxy setup or if you have load balancers/F5's/etc..
Additional Details And Troubleshooting Steps - Proxy Issues Most Likely

I was able to get my carddav account to work using my virtual hostname that points to my two servers that run ldap/proxy/mta . I have them setup in DNS as well.

$ host rr608.zimbra.DOMAIN.com
rr608.zimbra.DOMAIN.com has address
rr608.zimbra.DOMAIN.com has address
rr608.zimbra.DOMAIN.com mail is handled by 10 rr608.zimbra.DOMAIN.com.

One thing I did hit though, was the way OSX handles it's odd resolution stuff. For example, initially it failed when I had just modified the /etc/resolv.conf to use my internal DNS. Doing :

host rr608.zimbra.DOMAIN.com

resolved properly but doing:

ping rr608.zimbra.DOMAIN.com

was resolved to the external ip and was being hampered by my firewall. Once host and ping were resolving correctly, the carddav account work.

The whole reason I mention this is that I think we should walk our way back from the mailstore hostname in the configuration.

First, setup a carddav account using the mailstore name and confirm it works and then close/exit the Address Book. Then do the following. In a terminal, be in the users home directory and cd to this subdirectory - for example:

$ pwd
/Users/[username]/Library/Application Support/AddressBook/Sources/

Do a ls there and find the most recent directory that was made and cd into it, for example:

$ ls -latr
total 0
drwx------  7 ajcody  staff  238 Nov 17 06:50 000C3E7F-3DE5-40C8-8820-AF96214D6AF0
drwx------  4 ajcody  staff  136 Nov 17 06:58 .
drwx------  6 ajcody  staff  204 Nov 17 07:07 56892F5B-9F55-437E-9890-A8489A63EDAA
drwx------@ 8 ajcody  staff  272 Nov 17 07:07 ..
Adams-MacBook-Pro:Sources username$ cd 56892F5B-9F55-437E-9890-A8489A63EDAA/
Adams-MacBook-Pro:56892F5B-9F55-437E-9890-A8489A63EDAA username$ ls
AddressBook-v22.abcddb        Configuration.plist        Metadata                SyncLockFile

We can now manually edit the Configuration.plist file with various test hostnames/ip addresses.

The two keys we're interested in will be like this:



What I'd like you to attempt is adjusting the line for the servername using a hostname/ip address that will bypass the F5 if possible. You'll modify the file and save it. Launch Address Book and confirm/deny if the new hostname/ip address works.

  1. Use a static ip address of one of the zcs proxy servers. Please confirm it is pingable from the machine first.
  2. Use the hostname of the actual host of the same proxy server.

I'm assuming you can't use [your mailstore hostname] without going first to the F5, if the test above work you might want to setup a test BIND server you could use with the mac machine to resolve the [your mailstore hostname] using the various hostnames/ip's of the zcs proxy servers.

Use LDAP directory from ZCS for Mac Addressbook / Mail.App / iCal for Mac 10.4

Setting Up LDAP With Authentication - ZCS 8+

As an example, you would fill out the setup fields in the client to be like :

Username: uid=joe,ou=people,dc=abccompany,dc=com password: _zimbra_password_ Authentication Type: simple

Changing uid=joe to match the users email address [joe@abccompany] . You would also adjust the dc=abccompany above to match the users domain name in their email address.

To see and test what type of returns this setup will give, you can do the following from the ZCS server's CLI:

ldapsearch -x -H ldap://ldap.abccompany.com:389 -D uid=joe,ou=people,dc=abccompany,dc=com -w supp0rt -LLL -b 'ou=people,dc=abccompany,dc=com'

You would adjust the uid= , dc= , strings to match the user@domain for the user and also adjust "-w supp0rt" to be the user's password.

Older Reference Prior To ZCS 8

This is generally for those that aren't using Z-iSync.

First, test on shell that you have ldap connectivity.

ldapsearch -x -H ldap://ZCSserver-name:389 "uid=ajcody"

That returned successfully.

Then Addressbook Preferences

LDAP  + (for new)
Name: anything really
Server: ip/hostname that was used successfully in the ldapsearch string
Search Base:  [leave blank]
Port: 389
Scope: Subtree
No auth needed
* Save

I have no idea what the "Auto Update LDAP Cards" does.

Then setup Mail.App for IMAP to the Zimbra server. Check preferences to use LDAP - it will use the Address Book configuration that you did prior and it should auto-resolve to a username when you do a new message.

iCal will only use address that are in the LOCAL addressbook when you use the attendee field for a new event.

One way around this is to do a wildcard search in the Addressbook and drag those items to the local addressbook.

Goto to Address Book, selected Directories my ldap server and put in the below for the search field:


This search result can then be dragged to the "All" folder in the Group column. It creates a "Last Import" item in the Group column now - it might warn about updating entries that all ready match.

Entourage And Calendars

Can't Sync Calendars Between Entourage and Zimbra

Bug/RFE filed to correct current public documents on issue:

Bug/RFE filed to include comment in Release Notes:

Summary of the situation:

Update [05/2010] : Many of the bugs/rfe's filed against iSync will now reference this:

We are EOL'ing support for iSync in ZCS 7.0. See bug 42448 for more details,
but support of CalDav and CardDav with MacOSX 1.6+ for ZSC 6.0.x+ will be the
solution going forward.

  • MacOS 10.4
    • MacOS 10.4 still has the iSync/Entourage integration. Entourage integration worked via iSync rather than CalDAV (10.4 can't use CalDAV, only iSync). It would create a local calendar called Entourage within iCal and then the iSync service (via Zimbra Connector) would post updates to the users Zimbra calendar called Calendar (the default). I believe it would also check the box in Entourage under Preferences > Sync Services > Synchronize events and tasks with iCal and .Mac
  • MacOS 10.5
  • Forum thread
For The Stubborn - Getting Old Z-iSync Connector

Please don't kill the messenger, I'm putting this up here for those that are desperate and would rather deal with the iSync bugs on their own versus moving to the iCal + CalDAV supported option. Don't expect support for this configuration. There's an internal discussion about making the latest connector available directly - I'll update this page depending on the outcome. Until that discussion is resolved, I don't feel comfortable posting the individual connector by itself.

Grab the 5.0.5 tar ball from here:


The connectors are in the zimbra-store*.rpm , you'll find it in the packages directory once you untar the zimbra tarball.

Copy this over to temp. Find the path of the file. Extract it.

mkdir /tmp/isync
cp packages/zimbra-store*.rpm /tmp/isync/
cd /tmp/isync
rpm2cpio zimbra-store*.rpm | cpio -iv --make-directories `rpm2cpio zimbra-store*.rpm | cpio -t | grep -i zimbra-isync`

You'll see the new directories and within them you'll see the dmg file for the connector.

iCal General Issues

Clearing iCal cache

Make and run script:

rm -rf ~/Library/Application\ Support/SyncServices/Local/clientdata/com.apple.iCal
rm -rf ~/Library/Calendars
rm -rf ~/Library/Preferences/com.apple.iCal.plist
rm -rf ~/Library/Preferences/IcalExternalSync.plist
rm -rf ~/Library/Preferences/ByHost/com.apple.iCal.helper.*
rm -rf ~/Library/Caches/com.apple.iCal
rm -rf ~/Library/Caches/Metadata/iCal
Clearing ALL of iCal

Careful, This Will Remove All Calendar Data. Have all iSync related programs shutdown [addressbook, ical, iMail]

You will also need to redo your CalDAV account setup for the Zimbra iSync Connector. It might also be necessary to uninstall and reinstall the Zimbra Connector. Make and run script:

rm -rf ~/Library/Application\ Support/SyncServices/Local
rm -rf ~/Library/Application\ Support/SyncLocalCopy
rm -rf ~/Library/Application\ Support/iSync/SyncLocalCopy
rm -rf ~/Library/Application\ Support/iCal
rm -rf ~/Library/Calendars
rm -rf ~/Library/Preferences/com.apple.iCal.*
rm -rf ~/Library/Preferences/IcalExternalSync.plist
rm -rf ~/Library/Preferences/ByHost/com.apple.iCal.helper.*
rm -rf ~/Library/Caches/com.apple.iCal
rm -rf ~/Library/Caches/Metadata/iCal

Can't see items in shared Calendar

You might be seeing this:


Comment #30 give some instructions on a case they can reproduce.

zmprov gd <your domain name> zimbraPublicServiceHostname
zmprov gs <your server name> zimbraServiceHostname

If zimbraPublicServiceHostname is not set, or set to a different name (such as an alias of the machine or a load balancer), you are hitting this issue.

Calendar events are displaying the wrong time

Apple expects the year of 1971 for the DTSTART variable within an ICS file. There is no standard that dictates this.

Zimbra (prior to version 5.0.5) was using 1601, this is in /opt/zimbra/conf/timezones.ics .

Please see bug for more details (resolved 5.0.5):


Alarm & Calendar Notification Issues with iCal

These issues are getting worked out for the 5.0.7 release.

Please review:


Some more details:



iCal calendar color changing modifies calendar name and/or doesn't retain color

Fixed in 5.0.5 . See bugs for details:



Colors for Calendar & Appointments (Non-client specific)

Here's some RFE's/Bugs you might be interested in:

Calendar Ordering Issues

Please see RFE I made.

Directory Access configuration on Macs

File that configures [system wide] for Address Book resolution


Calendar Invites can't be imported into iCal

If you look at the ics file, you might see an extra return character at the end.

You'll see this if an Outlook client send an invite to a user using a Mac with a thick client [Mail.app/Entourage].

This was resolved in the 5.0.5 release. Please see bug for more details:


Mac clients cause spamming of invitation events when they adjust calendar events

This, at it's root, is caused by other bugs listed here. Usually this will get resolved with the proper upgrades that the bugs require (ZCS 5.0.5+)

There is a RFE/Bug though that will also resolve this, by allowing the "action" of an appointment to be set.

Please see bug for details [scheduled for 5.0.7]:


Calendar.app 10.9.5 With ZCS 8.5+

EWS - Exchange Account Topics

Configuring EWS And Calendar.app

Note - currently, with ZCS 8.5 it is not working with calendars. See the following bug:

Configuring an EWS account on a Mac gives you the option to enabled multiple services. See EWS Configuration And ZCS 8.5 on setting this up.

CalDAV Account Topics

Delegate Issues

iCal 10.5 - CalDAV Issues

Logging-Debug for CalDAV+iCAL

If you are using CalDAV account with ZCS, please help us investigating this problem. On your Mac please do the following and gather some data.

First shutdown iCal app.

Launch terminal app.

You can turn on the debug options in iCal by:

defaults write com.apple.iCal IncludeDebugMenu 1

Turn them off by just reversing it:

defaults write com.apple.iCal IncludeDebugMenu 0

Furthermore, you can log all of the HTTP transaction to the console via:

defaults write com.apple.iCal LogHTTPActivity yes

Turn them off by just reversing it:

defaults write com.apple.iCal LogHTTPActivity no

Logging will show up in /var/log/system.log

Launch iCal app.

Select the shared folder, right click, refresh.

Only Seeing 1 Month Back and 1 Year Ahead In CalDAV

Please see this bug: http://bugzilla.zimbra.com/show_bug.cgi?id=28713

Set to be resolved in 5.0.9

Not seeing Calendar's In iCAL/CALDAV

Space In Calendar Name's And Other "Special Characters"

For space's in Calendar names, this is resolved for the 5.0.7 release. (Need bug # for this)

There have also been reports in the forums that "special characters" can cause an issue where Calendars aren't displayed - even those without the special character name. Note, in one case, the "special character" where Norwegian character.

See: http://www.zimbra.com/forums/isync-caldav/20076-isync-calendars-not-working-after-upgrade-5-0-7-a.html

Server's With Multiple Domains - Effect Users Are In Default Domain

Bug filed:


  • Conditions:
    • On ZCS 5.0.7
    • Mac Clients using Zimbra Connector (provided from ZCS 5.0.7) and setting up iCal/CalDAV via the Connector.
    • ZCS has multiple domains
  • Error:
    • Default domain accounts can't see calendars
  • Reproduce:
    • Clear iCal with no Accounts configured (CALDAV)
    • Setup Accounts via Zimbra Connector
    • User username@defaultdomain.com as format for the User Name Field
  • Work Around:
    • Clear iCal with no Accounts configured (CALDAV)
    • Setup Accounts via Zimbra Connector
    • User username as format for the User Name field
  • Non-Default Domains - Works As:
    • Clear iCal with no Accounts configured (CALDAV)
    • Setup Accounts via Zimbra Connector
    • User username@domain.com as format for the User Name Field
      • Note, these accounts need @domain, will not work with just username.

iCal And Entourage Use for Calendars - Leopard/10.5 users

Update The 5.0.6+ Connectors will no longer work with Entourage. Your only option for Calendars will be using CalDAV with iCal.App. You still will see an option about Entourage in the Connector but it will be grayed out.

Because of some core issues with Apples SyncServices, we recommend that Entourage and iCal users use iCALv3 (Mac 10.5) configured for CALDAV. Please use the Zimbra Connector instructions to setup iCal for CALDAV.

For Entourage, this recommendation stems from the fact that Microsoft decided to use WebDAV rather than CALDAV. If MS decides later to include CALDAV support for Entourage, we'll have another option.

Please see bug for details:

Snow Leopard , Outlook/Entourage , Exchange Web Services

There is no target milestone for it as of today [2010/02/23]. This topic applies to the following references or terms: Exchange auto discovery feature, Exchange Autodiscover service or anything else that relies on Exchange Web Services [ EWS ] on the Mac. Another Apple reference on the topic [pdf warning] : Mac OS X Snow Leopard: Integrating the Mac into an Exchange 2007 Environment .

Please see the following in regards to Zimbra's work and stance on the issue:

Can't see Calendars after configuring Z-iSync for CALDAV - 10.5 users

You didn't follow the directions most likely. Goto iCal Preferences Accounts.

There should be NO configured accounts prior to configuring Z-iSync for CALDAV.

Remove the current Account listed in iCal and redo configuration for CALDAV with Z-iSync.

Trick to work around address lookup for the Attendee field in iCal Events

Configure the Addressbook using one of the other recommendations on this page.

You can now drag entries from your Addressbook into the Attendee field of iCal.

Attendee Lookups for iCALv3/MacOS10.5

iCal3 [webdav] needs to use the Apple Directory Access utility for attendees (It's on 10.5). It will only work against Apple OD/CAL servers.

RFE filed to include necessary LDAP attributes to provide ical oattendee lookups

See bug [scheduled for 5.0.7]:


Free/Busy Lookup not working as expected

The Free/Busy lookup requires auto-attendee lookup to be working.

This requires bug 26619 [ http://bugzilla.zimbra.com/show_bug.cgi?id=26619 ] to be resolved for iCalv3/Mac 10.5.

iCal-CalDAV - server doesn't retain color information from iCal

Summary of issue: Zimbra only supports the preset colors on iCal, which are blue, green, red, orange, pink, and purple.

Please see the following:

  • "CalDAV: server does not retain color information from iCal"
    • http://bugzilla.zimbra.com/show_bug.cgi?id=26627
    • I've added a private comment to this to see if another RFE is needed to expand this and if there's any show stopper reasoning with why it can't be done. I'll update this here when I hear back on it.

New Calendars Made With iCal-CalDAV Are Being Shared Out

I created a bug for this issue, please see:

Can't Select Which Calendars To Sync - I Could With 10.4 Though

This is because of the change from iSync to CalDAV. iCal always syncs all the calendars in a given CalDAV account together. The CalDAV spec allows syncing each Calendar, but iCal chooses to sync them all.

There is no known work around at this time. Nor is there an RFE made because the dev's have stated it's an iCal issue. If this changes, I'll update this entry.

iTunes & iPhone configuration for CALDAV

Please see main wiki page on iPhone http://wiki.zimbra.com/index.php?title=IPhone

If you follow the instructions about configuring the Zimbra iSync Connector for CALDAV use, there should be no issues about sync'ing with your iPhone.

At this time, new events created on a iPhone/CALDAV setup will write the event to a local calendar in iCal.app . There's no way around this yet. It's a limitation at this time with Apple's software. You can change the events calendar assignment though later via iCal.app.

Please see Screenshot of iTunes & iPhone

iPhone 3.0 will use port 8443 as default when setting up Caldav, you most likely need to change this to 443.

iCal 10.4 - iSync Issues

Attendee Lookup for iCal/Mac 10.4

iCal.app on Mac 10.4 only uses local entries in Apples Addressbook for address/username lookup for new appointments.

Addressbook+LDAP configuration requires a copy of an "all/*" search in ldap into the local addressbook. Sync doesn't seem to work.

Please see this bug comment and the 10.4 section for more details:


New Calendars don't sync unless you select "all". Mac 10.4/Z-isync

Please see bug for details:


Sync To Do/Tasks Items in Leopard

RFE filed, please see http://bugzilla.zimbra.com/show_bug.cgi?id=12917

No target date, please vote for this RFE.


General Outlook Issues

Getting Older ZCO Versions

First check to see if the release version you want is available on the support portal, you'll need to login to the support portal.

You can download all previous releases from here:

The connectors are in the zimbra-store package. For example:

[root@mail59 zimbra]# find . -name *.msi -print

[root@mail59 zimbra]# rpm -qf ./jetty-6.1.22.z6/webapps/zimbra/downloads/ZimbraOlkConnector-6.0.6_GA_2324_6.0.5902.6.msi

With a rpm based distro, you'll do something like the following reference shows to extract the files from the rpm using rpm2cpio & cpio vs. needing to "install" the rpm:

Basic gist:

[root@mail59 zimbra]# pwd
[root@mail59 zimbra]# cp /path/to-untar-zcstarball/packages/zimbra-store* /tmp/zco-rpm/
[root@mail59 zimbra]# rpm2cpio zimbra-store*.rpm | cpio -iv --make-directories `rpm2cpio zimbra-store*.rpm | cpio -t | grep -i zimbraolkconnector`

Import & Export Of Outlook Categories As Zimbra Tags

Under ZCO

Older versions of ZCO documentation had:

  • "If categories have been assigned to messages and contacts, these are converted to tags in the user’s Zimbra mailbox."

Newer ZCO releases and documentation now state:

  • "Zimbra Tags are synchronized with Outlook Categories"

Import & Export Notes & Journal

Notes & Journal Via PST

In order to keep their Notes and Journal entries, users should save these Outlook items in pst format before syncing and then import the pst file after the initial sync is performed. This would need to be done prior to installing and configuring the Zimbra Outlook Connector. Also, this "import" is via the normal Outlook pst process - NOT via the Zimbra pst import tool.

Related Bugs And Resources

Into Zimbra Documents

Notes can be exported from Outlook to a CSV file. You can the manipulate this with Excel/Word to a format that would work for you within Zimbra Documents.

In Excel - Add borders to the cells, Adjust fonts, Adjust text spacing and then highlight the data. Ctrl+C .

In Zimbra web client - Goto Documents > New .

Click in body of New Document and Ctrl+V . You should see your Notes now in a Table.

Upload HTML


Following above example except you format your old Notes to become a HTML file. You could export/save-as using whatever application you like.

Then, in Zimbra web client - Goto Documents > New Drop Down Arrow and select Upload File

This, unfortunately, will get saved under "Briefcase"

Upload File Type For Conversion To Zimbra Documents

Update - This Will Be True For Upcoming Releases

See (Zimbra Employees) - On DF

  • "import/export word/excel to documents"
    • Internal (Private) RFE - 10124

Notes can be exported from Outlook to a CSV file. Open this file with Excel and make any adjustments you would like and then save as an Excel file.

From the Zimbra webclient, log in with your account details.

Goto the Documents tab.

Click on Import. You'll be able to select Excel files as an import option.

Into Zimbra Tasks?

Initial thoughts.

If one does something like this : http://ZIMBRASERVER/home/ajcody/Tasks

It will give you your tasks in an ics format (iCal). Here's what one tasks would look like:

TZID:(GMT-05.00) Eastern Time (US & Canada)
SUMMARY:Tasks Exporting
DESCRIPTION:These are my notes I'm putting in for my task. \n
ORGANIZER;CN=Adam J. Cody:mailto:ajcody@mail3.internal.homeunix.com

As you can see, it would be a difficult task [no pun intended] to convert the data from Outlook Notes into ics format to allow importing to Zimbra Tasks.

If you do find a way, the import process from CLI would be:

curl -u USERNAME:password --data-binary @/tmp/Tasks.ics http://server/service/home/USERNAME/Tasks?fmt=ics

See User_Migration for more details.

ZCO Zimbra Outlook Connector

Supported Versions Of Windows, Outlook, ZCO

I created the following RFE:

Current document for this would be:

ZCO 5.0.10 Release

Local Failure Notice In My Inbox

This is new with this release of the ZCO.

  • "Better error reporting for sync issues. A copy of local failures/server failure error messages will be delivered to the inbox."
What To Do When You Get This If You Want To Contact Support

Add these details/steps to the creation of your support case.

  1. Send us the failure messages.
    • Easiest way is to create a temp folder on your desktop, drag all these messages to the folder. (This will create .msg files inside the folder.) Then zip up the folder and send the zip file to us through a support case.
  2. For each type of errors with an id, get the "Show Original" of one of the failures.
If You Want To Turn This Feature Off

Just create a DWORD value in the registry of HKEY_LOCAL_MACHINE\SOFTWARE\Zimbra\turnOffInboxFailures and set it to 1. Then the local failures won't go to the Inbox. They'll just go to the local failures folder, as before.

ZCO 5.0.7+

ZCO 5.0.7 and higher have new features and also should only be used with ZCS server 5.0.7 or higher.

Check The ZCO 5.0.6 Bug Backport Binary

Login to the support portal and check Zimbra Utility and Beta Downloads.

Or try this direct url:


It will list out the bugs that were back ported.

The complete troubling-shooting guide (dev info requests)

  1. Reproduce
  2. ZCO install logs
    • msiexec /i zco-installer.msi /lv 00022083-zco-install.log
  3. Get zco logs
  4. Check for core dumps - mandatory for all crashes
  5. Winhttp trace (issues where they can&amp;amp;amp;amp;amp;#39;t connect - check zco logs first). Run this on the machine with Outlook.
  6. Are there any local failures/server failures?
  7. Winmsd (dump of the local environment configuration)
    • Start Run winmsd
      • This might take awhile to bring up the application
      • From app [System Information titled] , File Export
    • What about msinfo32.exe ?
  8. External factors (add-ins, other mapi clients)
  9. Network topology (firewall, proxy, etc)
  10. Server topology (single/multi-node, clustering, nginx, 3rd party lb)
  11. Search bugzilla
  12. Search old support cases
  13. Can we get remote access?
  14. Can we get an account on the server?
  15. Can we access the account in question?
  16. Get the id of the item
    • get the original of the item from the server (mime representation)
    • get the .msg of the item from outlook
  17. Quick analysis of zco logs
    • sync - change record creation - CHANGE RECORD
    • follow soap requests, look for soap faults
    • look for the word - exception
    • follow soap traces
    • ignore MAPI_E_NOT_FOUND

Performance Issues






The skinny is this, [per Microsoft]

  • ...recommended max OST size (2GB)
  • ...we strongly recommend storing no more than 5,000 items in core folders, such as the Inbox and Sent Items folders. Creating more top-level folders, or subfolders underneath the Inbox and Sent Items folders, greatly reduces the costs associated with this index creation, so long as the number of items in any one folder does not exceed 5,000.

Can't Send Via Send To -> Mail Recipient

Please see this bug:


You shouldn't have this problem with connectors from 5.0.6+

Saving Current Profile Out To Then Re-Import

With Outlook closed/shutdown, you can then copy/rename the *.zdb file under your profile to a .pst file.

Then you can later run the PST Import Wizard to import the file into a new Zimbra profile you setup. One of the options on the Import Wizard let's you import only mail after a specified date - to avoid duplications.

Thunderbird , Lightning, Firefox

Debug Logging For Thunderbird

To create a log file with all POP, SMTP, or IMAP traffic in Mozilla Thunderbird:

For Windows

  • Make sure Mozilla Thunderbird is not running.
    • Select All Programs | Accessories | Command Prompt from the Start menu.
    • Type "set NSPR_LOG_MODULES=" followed immediately by
      • "POP3:4" for POP,
      • "IMAP:4" for IMAP and
      • "SMTP:4" for SMTP
  • Press Enter.
    • You can enable logging for multiple protocols by separating them with commas (',').
      • To log both POP and SMTP traffic, for example, type "set NSPR_LOG_MODULES=POP3:4,SMTP:4" (excluding the quotation marks).
      • To log only IMAP traffic, type "set NSPR_LOG_MODULES=IMAP:4", for instance.
  • Type "set NSPR_LOG_FILE=%HOMEDRIVE%%HOMEPATH%\Desktop\tbird_log.txt".
  • Press Enter.
  • Type "start thunderbird".
  • Press Enter again.
  • Perform the desired email actions in Mozilla Thunderbird.
  • Quit Mozilla Thunderbird and take a look at "tbird_log.txt" on your Desktop.

For Mac OS X

  • Open a Terminal window.
  • Type "set NSPR_LOG_MODULES=" followed immediately by
    • "POP3:4" for POP,
    • "IMAP:4" for IMAP and
    • "SMTP:4" for SMTP
  • Press Enter.
    • You can enable logging for multiple protocols by separating them with commas (',').
    • To log both POP and SMTP traffic, for example, type "set NSPR_LOG_MODULES=POP3:4,SMTP:4" (excluding the quotation marks).
    • To log only IMAP traffic, type "set NSPR_LOG_MODULES=IMAP:4", for instance.
  • Type "set NSPR_LOG_FILE=~/Desktop/tbird.log".
  • Press Enter.
  • Now type "/Applications/Thunderbird.app/Contents/MacOS/thunderbird-bin".
  • Press Enter again.
  • Perform the desired email actions in Mozilla Thunderbird.
  • Quit Mozilla Thunderbird and take a look at "tbird.log" on your Desktop.

For Linux

  • Open a Terminal window.
  • Type "set NSPR_LOG_MODULES=" followed immediately by
    • "POP3:4" for POP,
    • "IMAP:4" for IMAP and
    • "SMTP:4" for SMTP
  • Press Enter.
    • You can enable logging for multiple protocols by separating them with commas (',').
    • To log both POP and SMTP traffic, for example, type "set NSPR_LOG_MODULES=POP3:4,SMTP:4" (excluding the quotation marks).
    • To log only IMAP traffic, type "set NSPR_LOG_MODULES=IMAP:4", for instance.
  • Type "set NSPR_LOG_FILE=~/tbird.log.txt".
  • Press Enter.
  • Type "thunderbird".
  • Press Enter again.
  • Perform the desired email actions in Mozilla Thunderbird.
  • Quit Mozilla Thunderbird and take a look at "tbird.log.txt" in your Home directory.

Thunderbird Contact Sync for Zimbra

Please see the following as a possible solution:


Gnome Evolution And KDE Kontact

Some RFE's I've made:

Zimbra Desktop [ZD]

ZD References

Using ZD To Import Zimbra TGZ Export User Data

See :

IM - Instant Messaging Clients


Please see:


Don't believe this will currently work. I'm still investigating it though.

RFE I made in the meantime:

Please see:

Setting Up Apache For The crossdomain.xml File

Ok, this is just down and dirty. You'll need to handle security issues yourself.

mkdir /opt/zimbra/spark-web
vi /opt/zimbra/spark-web/crossdomain.xml

Putting in this,

<?xml version="1.0"?>
<!DOCTYPE cross-domain-policy SYSTEM

<allow-access-from domain="*" to-ports="5222" />

Set permissions:

chown -R zimbra:zimbra /opt/zimbra/spark-web

Let's configure apache to server this file out and listen on port 5229.

Note, you could also set this up within a Virtual Hosts.

vi /opt/zimbra/conf/httpd.conf Towards the start of the file, add another Listen line for port 5229 under the Listen 80

Listen 5229

Towards the end, add the following to include spark-web directory

Include /opt/zimbra/httpd/conf/extra/spark-web.conf

Let's now make the apache conf file for zmstat-chart.conf

vi /opt/zimbra/httpd/conf/extra/spark-web.conf

Alias /zmstat-chart "/opt/zimbra/spark-web"
<Directory "/opt/zimbra/spark-web">
  Options Indexes
  IndexOptions FancyIndexing VersionSort
  AllowOverride None
  Order allow,deny
  Allow from all

Restart apache so the changes take effect:

zmapachectl stop
zmapachectl start

To test your changes, with a web browser goto:


You should see the xml file you made.

Now setup the spark-web software on the same box. SparkWeb HOW-TO will guide you but use the /opt/zimbra/spark-web directory you already setup. I'll leave the particulars to this to the HOW-TO referenced. Just remember that when you setup the spark-web client you'll modify it's config file like below.Don't forget to put in your IM servers hostname for "youropenfireserver":

<script type="text/javascript">
function jive_sparkweb_getConfig()
     return {
          server: "youropenfireserver",
          connectionType: "socket",
          port: "5222",
          autoLogin: "false",
              policyFileURL: "xmlsocket://youropenfireserver:5229"

Pidgin - Formally GAIM

Please see Pidgin_and_Zimbra

Pidgin Groupchat

Configure For Chat Room:

  • Buddies
  • Join A Chat
  • Account = Zimbra IM Account
  • Room
    • Either A New One - which will prompt you for setup. Check persistent if you want it to be.
    • Enter An Existing Conference Room Name
  • Server
    • Enter conference.SERVERNAME , Example: conference.example.com
      • conference is a default variable that will be added to the primary zimbra hostname/domainname.

See Public Chat Rooms Listed:

  • Buddies
  • Join A Chat
  • Account = Zimbra IM Account
  • Server
    • Enter conference.SERVERNAME , Example: conference.example.com
      • conference is a default variable that will be added to the primary zimbra hostname/domainname.
  • Click On The "Room List" button


Please see Adium_and_Zimbra

Adium Groupchat

Configure For Chat Room:

  • File
  • Join Group Chat
  • Set Account To Your Zimbra XMPP/Jabber Account
  • Chat Room Name
    • Either A New One - which will prompt you for setup. Check persistent if you want it to be.
    • Enter An Existing Conference Room Name
  • Server
    • Enter conference.SERVERNAME , Example: conference.example.com
      • conference is a default variable that will be added to the primary zimbra hostname/domainname.

See Public Chat Rooms Listed:

  • File
  • Highlight Your Zimbra Account until the options show on the right.
  • Discovery Browser


Just discovered this project, though I haven't used it much. Might be worth checking out. It's available for Windows [Beta] and coming "soon" for Mac and Linux. Does IM, Email notification, and Social Networking stuff.

  • Digsby Home Page
    • http://www.digsby.com/
      • Features:
        • digsby is a multiprotocol IM client that lets you chat with all your friends on AIM, MSN, Yahoo, ICQ, Google Talk, and Jabber with one simple to manage buddy list.
        • digsby is an email notification tool that alerts you of new email and lets you perform actions such as 'Delete' or 'Report Spam' with just one click.
        • digsby is a social networking tool that alerts you of events like new messages and gives you a live Newsfeed of what your friends are up to.
    • Items to Notes:
      • Where is group chat?
        • We had some bugs with group chat so we launched Digsby beta without it. However, we will bring it back in the near future.
      • Requires account setup with Digsby. This might not be acceptable for some customers for security reasons.


Please see Empathy_and_Zimbra

Other Topics

PGP , GPG , Domain Keys, Encryption

Just references as I find them:

Third Party Option:

   Article-alert.png  - This article is a community contribution and may include unsupported customizations for network edition customers.

Calendar Issues

Calendar Issues Homepage

Please see Ajcody-Calendar-Issues

Specific Client Application Issues

Please see this page instead, this page will try to deal with server internals or "calendar" issues as within the ics itself.

Can't See User's Freebusy

A user can turn off on a per calendar basis the feature of broadcasting their F/B status of that calendar. In ZWC, right click on folder and look at the properties. To change/view this from the commandline:

To see what folders a user has:

zmmailbox -z -m user@domain.com gaf

Calendar ones will be appo under the View column.

The below will let you see if the calendar is doing F/B or not :

zmmailbox -z -m user@domain.com gf /Calendar

  Help: getFolder(gf)                [opts] {folder-path}
        -v/--verbose                 verbose output

It'll give a bunch of data, including:

    "isExcludedFromFreeBusy": false,

To turn it off [0] or on [1],

zmmailbox -z -m user@domain.com mfefb /Calendar 0

  Help: modifyFolderExcludeFreeBusy(mfefb) {folder-path} [0|1*]

 Ref: http://wiki.zimbra.com/wiki/Zmmailbox

Free Busy F/B Lookup Via URL Strings

The url sting to see another persons free/busy if they have it open for permission [in the users preferences] is:


Some other methods or options are. To download the ics file:

http[s]://SERVER/zimbra/home/USER@DOMAIN/.ics or http[s]://SERVER/zimbra/home/USER/.ics

To show a weeks worth of F/B data:


To get iCalendar format of the calendar, replace the fmt=freebusy with ifb


With ZCS8, we also have these options now - VEVENT [fbfmt=event]


or VFREEBUSY [fbfmt=freebusy] format


Some Helpful Scripts To Run Against ICS File


Will determine if an event has attendees but is missing an organizer. Normally, customers will delete the event and just recreate it with the information that is present from the output.

usage : ./parseics.pl filename.ics


$file = $ARGV[0];

if (!$file)
	print "Must specify filename.\n";
elsif (!-e $file)
	print "File does not exist!\n";
	#print "File exists. Continuing...\n";
	open(ICS, "<$file");
	@ics = <ICS>;
	for ($i=0;$i<=$#ics;$i++)
		if ($ics[$i] =~ "BEGIN:VEVENT")
			#print "vevent start\n";
			while ($ics[$i+1] !~ "END:VEVENT")
				$event .= $ics[$i];
				if ($ics[$i] =~ "ORGANIZER")
				if ($ics[$i] =~ "ATTENDEE")
			#print "vevent end\n";
			if ($attendee && !$organizer)
				$event .= $ics[$i];
				$event .= $ics[$i+1];
				print "Invalid event.  Attendee but no organizer present!\n";
				print $event;
	print "$errors error(s) out of a total of $events events present.\n";


Will break up an ics dump into one file per vevent.

# ical-parse.pl
# b 2008 03 12
#insist on an input file
if ( scalar(@ARGV) < 1 ) { print "Please specify a filename.\n" and usage() and exit; }
my $infile = shift @ARGV;
$numevents = qx/grep BEGIN:VEVENT $infile | wc -l/;
chomp $numevents;
$numevents =~ s/[^0-9]//g;

$inVEVENT = $FALSE; # track whether we are in the middle of a vevent
@currentVEVENT=(''); # hold the lines of the current vevent in this array (this will hog memory :()

open( INFILE, $infile ) or die "Could not open $infile for read: $!";
while ($line = <INFILE> ) {
	chomp $line;
	if ( $line =~ m/^BEGIN:VEVENT$/ ) { # case I.
		($inVEVENT) and die "Error: found new BEGIN:VEVENT without END:VEVENT\n";
		$inVEVENT = $TRUE;
	elsif ( $line =~ m/^END:VEVENT$/ ) { # case II.
		(!$inVEVENT) and die "Error: found END:VEVENT without BEGIN:VEVENT\n";
		push(@currentVEVENT, $line);
		$size = $#currentVEVENT;
		$zeros = zeropad($eventcount, $numevents); #eh ever heard of sprintf
		$outfile = "${zeros}${eventcount}-${summary}-${size}.ics";
		open( OUTFILE, ">>", $outfile ) or die "Could not open $outfile for write: $!";
		foreach $l (@currentVEVENT) {
			print OUTFILE "$l\n";
		close OUTFILE;
		$inVEVENT=$FALSE; $summary=''; $size=0; @currentVEVENT=('');
	elsif ( ($temp) = ( $line =~ m/^SUMMARY:(.*)$/ ) ) { # case III.A.
		$summary = $temp; #forget why temp
		$summary =~ s/[^-a-zA-Z0-9.]/_/g;
		push(@currentVEVENT, $line);
	elsif ($inVEVENT) { # case III.
		push(@currentVEVENT, $line);


 A. (inVEVENT) and error: previous event not closed
 B. (else) set inVEVENT, start array, push line
 A. (inVEVENT) push line, write array, unset inVEVENT, unset summary, empty array
 B. (else) error: no event started
III. <event line>
 A (matches ^SUMMARY:) and set summary, push line
IV. <non event line>


sub usage {
    print "Usage: $0 <ical file>\nWrites a new file for each VEVENT\n";
sub zeropad() { #num-to-pad, total-with-max-digits, return 0...
	for ($x=0; $x < ($max-$curr); $x++) {
		$pad .= '0';
	return "$pad";

ZCS CLI Utilities


This command checks the consistency of appointments on the Zimbra calendar and sends an email notification regarding inconsistencies. For example, it checks if all attendees and organizers of an event on the calendar agree on start/stop times and occurrences of a meeting.

Help output from ZCS 5.0.23

Usage: zmcalchk [-d] [-n <type>] <user> <start-time-spec> <end-time-spec>

   See the output of 'zmmailbox help appointment' for details on time-specs.

   -d        DEBUG: extremely verbose details
   -m        Max attendees to check, (default 50)
   -n        <none|user|organizer|attendee|all> whom to notify (default none)


Other wiki reference: Time_Zone_Changes_for_2007_and_ZCS

Help output from ZCS 5.0.23

$ zmfixtz -h
usage: zmfixtz -a <account(s)> [options]
 -a,--account <arg>         account email addresses seperated by white
                            space or "all" for all accounts
    --after <arg>           fixup calendar items after this time; defaults
                            to beginning of 2007
    --country <arg>         two-letter country code if running
                            country-specific fixup
 -h,--help                  Displays this help message.
 -s,--server <arg>          Mail server hostname. Default is localhost.
    --sync                  run synchronously; default is asynchronous
 -Y,--authtokenfile <arg>   use auth token string(has to be in JSON
                            format) from command line
 -y,--authtoken <arg>       use auth token string(has to be in JSON
                            format) from command line


This command is used to update time zone changes in existing appointments for specific users or all users. A .ics rule file should first be created to run with this command. A rule file lists a series of rules to match a time zone and the replacement time zone definitions. More information about this command can be found at Changing_ZCS_Time_Zones .

Syntax :

zmtzupdate --rulefile <rule file> -a <“all” or list of specific email addresses> [--sync] [--after <date/time stamp>]

Help output from ZCS 5.0.23

usage: zmtzupdate --rulefile <rule file> -a <account(s)> [options]
 -a,--account <arg>         account email addresses seperated by white
                            space or "all" for all accounts
    --after <arg>           fixup calendar items after this time; defaults
                            to beginning of 2007
 -h,--help                  Displays this help message.
    --rulefile <arg>        xml file containing fixup rules
 -s,--server <arg>          Mail server hostname. Default is localhost.
    --sync                  run synchronously; default is asynchronous
 -Y,--authtokenfile <arg>   use auth token string(has to be in JSON
                            format) from command line
 -y,--authtoken <arg>       use auth token string(has to be in JSON
                            format) from command line

ZCS CLI zmprov - appointment related

zmprov calendar help description

Help output from ZCS 5.0.23

$ zmprov help calendar

  createCalendarResource(ccr) {name@domain} {password} [attr1 value1 [attr2 value2...]]

  deleteCalendarResource(dcr) {name@domain|id}

  getAllCalendarResources(gacr) [-v] [-e] [-s server] [{domain}]

  getCalendarResource(gcr) {name@domain|id} [attr1 [attr2...]]

  modifyCalendarResource(mcr) {name@domain|id} [attr1 value1 [attr2 value2...]]

  purgeAccountCalendarCache(pacc) {name@domain|id} [...]

  renameCalendarResource(rcr) {name@domain|id} {newName@domain}

    op = eq, has, startswith, endswith, ge, le, gt, lt

zmprov freebusy help description

Help output from ZCS 5.0.23

$ zmprov help freebusy

  getAllFbp(gafbp) [-v]

  getFreebusyQueueInfo(gfbqi) [{provider-name}]

  pushFreebusy(pfb) {domain|account-id} [account-id ...]

ZCS CLI zmmailbox - appointment related

zmmailbox appointment help description

Help output from ZCS 5.0.23

$ zmmailbox help appointment

  getAppointmentSummaries(gaps) [opts] {start-date-spec} {end-date-spec} {folder-path}
    -v/--verbose                 verbose output

 absolute date-specs:

  mm/dd/yyyy (i.e., 12/25/1998)
  yyyy/dd/mm (i.e., 1989/12/25)
  \d+       (num milliseconds, i.e., 1132276598000)

  relative date-specs:

   +/{not-specified}   current time plus an offset
   -                   current time minus an offset
   (0-9)+    value

   ([mhdwy][a-z]*)  units, everything after the first character is ignored (except for "mi" case):
     1day     1 day from now
    +1day     1 day from now 
    p1day     1 day from now
    +60mi     60 minutes from now
    +1week    1 week from now
    +6mon     6 months from now 
    1year     1 year from now

zmmailbox search help description

You can use this to search appointments with :

-t appointment

Help output from ZCS 5.0.23

$ zmmailbox help search

  search(s)                    [opts] {query}
    -c/--current                 current page of search results
    -t/--types <arg>             list of types to search for (message,conversation,contact,appointment,document,task,wiki)
    -p/--previous                previous page of search results
    -n/--next                    next page of search results
    -l/--limit <arg>             max number of results to return
    -s/--sort <arg>              sort order TODO
    -v/--verbose                 verbose output

  searchConv(sc)               [opts] {conv-id} {query}
    -c/--current                 current page of search results
    -t/--types <arg>             list of types to search for (message,conversation,contact,appointment,document,task,wiki)
    -p/--previous                previous page of search results
    -n/--next                    next page of search results
    -l/--limit <arg>             max number of results to return
    -s/--sort <arg>              sort order TODO
    -v/--verbose                 verbose output

Appointment Items Within Mysql

DESCRIBE mboxgroup[#].appointment Database Table

See :

The Query For ALL Appointments For A Particular User

See :

   Article-alert.png  - This article is a community contribution and may include unsupported customizations for network edition customers.

Mobile & Phone Issues

Actual Mobile & Phone Topics Homepage

Please see Ajcody-Mobile-Topics

Help Me Understand the Mobility Options

Let's break it down to three forms of access for mobile devices.

Mobile Web Client - http://www.zimbra.com/products/mobile_web_browser.html

A. Setups the web access to the Zimbra server to be viewable from a mobile device. This is accessing mail over the "web browser" on the mobile phone.

A1. http://servername.com/zimbra/m/

B. Built in - no license or additional software needed.

Zimbra Mobile - http://www.zimbra.com/products/mobile_smartphone.html

A. This allows two-way, over-the-air synchronization between the mobile device and Zimbra server.

A1. Think of this as "fat client" mail sync'ing on a mobile device

B. This page will describe that process in better detail - http://wiki.zimbra.com/index.php?title=Mobile_Device_Setup

C. License required

Blackberry - http://www.zimbra.com/products/mobile_blackberry.html

A. Blackberry "two-way, over-the-air synchronization" requires the use of a Blackberry server. We use a "connector" on the Blackberry server that allows BES device to use their "fat client" for mail sync'ing.

B. This option requires a separate server, a Windows box that will run the Blackberry server software.

C. Zimbra Mobile license required. Windows Blackberry server require with appropriate Blackberry licenses. Installation of Zimbra BlackberryConnector on the Blackberry server.

Zimbra Mobile/Blackberry requires the license file to enable it. This cost can be discussed with your sales contact. It's only the Blackberry configuration that requires a "software" installation - so to speak. Enabling "Zimbra Mobility/option 2 above" is a license requirement - not a software installation one - and then configuration for the user. "You enable Zimbra Mobile in the ZCS COS or for individual Accounts."

Forum Support For Mobile Options

The Mobility Forum has three sections.

Blackberry (Now GA)


J2ME Client (Beta Product) - Project Stopped

General Mobile Issues

What Devices Are Supported And How-To

I've made the following RFE's recently. I'm hoping we continue doing this going forward as well.

Requests For Support - Assorted

  • Official Support for Palm Pre Phone
    • http://bugzilla.zimbra.com/show_bug.cgi?id=43989
    • Certs and Palm
      • Installing self-signed and privately issued certificates - Palm
      • Steps to setup import of certificate on Palm. You can also use this url to "download" the file to a machine - http://YOURZIMBRAHOSTNAME.com:7071/ca.der - after you setup the ca.der file following these steps.
        * Log into server as root
        cd /opt/zimbra/ssl/zimbra/ca
        openssl x509 -in ca.pem -out ca.der -outform DER
        cp /opt/zimbra/ssl/zimbra/ca/ca.der /opt/zimbra/httpd/htdocs/
        grep x509 /opt/zimbra/httpd/conf/mime.types
        * if it returns:
        application/x-x509-ca-cert der crt
        ** or
        application/x-x509-ca-cert der
        * Then you can STOP here, if not, then do the following:
        vi /opt/zimbra/httpd/conf/mime.types
        * And then at the end of the file, or in alphabetical order (since the list in the file is in alphabetical order),
        * add the following line:
        application/x-x509-ca-cert der crt
        * If you had to add the line to mime.types , you'll need to restart zimbra at some point before you can continue
        * with the tests below.
        * To test, in a web browser:
        * You should be prompted about accepting cert, you can cancel out of this.
        * To Transfer Zimbra server CA to your mobile device:
        * On the mobile device, browse to
        ** (you should be prompted to install the CA certificate)
        * Ensure you check both check-boxes for the trust settings for Internet and Online Certificate Check

Special Note About Android Phone's

Special Note About Nokia's

From Nokia's Website :

  • Supported devices:
    • Nokia devices with ActiveSync built into the email client:
      • Nokia E75, Nokia E72, Nokia E55, Nokia E52, Nokia N86 8MP, Nokia 6710 Navigator and Nokia 6730 classic
  • Nokia devices with Mail for Exchange email client:
    • Certified devices:
      • Nokia Eseries: Nokia E51, Nokia E63, Nokia E66, Nokia E71, Nokia E90
      • Nokia Nseries: Nokia N76, Nokia N81, Nokia N81 8GB, Nokia N82, Nokia N95, Nokia N95 8GB
      • Other Nokia S60 3rd Edition devices: Nokia 6120
    • Enabled devices:
      • Nokia 5700 Xpress Music, Nokia 6110 Navigator, Nokia 6121, Nokia 6210 Classic, Nokia 6290
    • Certified devices are devices on which the functionality of the Mail for Exchange software client has been validated.
    • Enabled devices are devices on which the functionality of the Mail for Exchange software client has not been validated individually, but where the functionality of the Mail for Exchange software client on a certified device has been validated in the same software branch.

Some Issues Addressed On Nokia'S Support Forum:

Mobiles And GAL Searches

Some RFE's to watch:

Bugs To Be Aware Of

Logs To Review For Mobile Issues

From Ajcody-Logging#What.27s_up_with_all_the_logs.3F

  • /opt/zimbra/log/sync.log - zimbra mobile and activesync
    • Your mobile devices will basically log here.
  • /opt/zimbra/log/mailbox.log - where most of your mailbox store activity is logged
    • This log is the mailboxd log4j server log containing the logs from the mailbox server. This includes activity from the mailbox store, LMTP server, IMAP and POP servers, and Index server.
  • Other Possible Logs To Review:
    • /opt/zimbra/log/synctrace.log - zimbra mobile and activesync
      • Still looking for description that describes difference with sync.log
    • /opt/zimbra/log/syncstate.log - no description found
      • No description found.

Zimbra Mobile And ActiveSync Technology

Zimbra Mobile on Windows Mobile Smartphones, Nokia Business Series Smartphones, Apple iPhones, Palm Treo or any other Smartphones that natively uses the ActiveSync Technology

Understanding how Direct Push works:

Understanding Direct Push, From MS Exchange Server 2010 Help

Make sure you review the other pages for this subject that will show on the left hand side.

Mobile Management Features

Remote Wipe

For wipe to be an available option, the device must show "status = ok" and "provisionable = yes" in the Mobile Devices preferences panel. A "status = needs provisioning" means the device isn't under the "Mobile Policy" yet.

Some references:

Windows Mobile Emulator For Testing

You can use the following to setup a Window Mobile emulator for testing.

Android Emulator For Testing

Please see:

Android Email Clients

Just a list of clients I've encounter, some will cost money though. Useful to test 'issues' you might be having with your current email client on your android.

Android And Multiple Calendars

My General Write Up On The Issue

The fundamental issue is ActiveSync does not support multiple calendars or shared calendars [as of Mar. 11, 2013]. It only displays the single default calendar. Also, on top of that, the Android code itself is restricted to this limitation, in regards to the OS and it's basic apps. The iPhone did their own 'hack' to get around it.

You'll also see there a reference to a third party Android app that might offer this 'hack'. See section below.

We actually have a number of RFE's on this topic also:

Other possible options:

  • caldav/ical android app. I have not heard of any recommended applications for this in regards to having multiple calendars etc.
  • use the webbrowser on the phone and login to zimbra.

Last note, some of these Corporate email apps that come with the phones do offer hacks for multiple calendars. I believe my Motorola Photon did this, my memory is a little foggy though on it. Sometimes they'll reference it as being a "Calendar Folder". For that, it might allow you to manually view/edit the calendars but the native android notification stuff might only react to events on the default calendar.

Third Party Application That Might Work

ICSSync - View Only Work Around

As reported by a customer [Mar. 11, 2013]

I found an application that worked just fine: ICSSync (By: NightLabsConsulting).  
It costs $3.78 to use it past 20 days, but, from what I can tell, it is 
certainly worth it.

You install the app, load it up, and add a calendar.  It asks you for the
URL and credentials.  You then insert all that info and check the ignore
certificate (if applicable).  

I selected "View Only" and that worked just fine.  I could not get the view and 
write option to work.  

From that application you can set the sync frequency and the Calendar shows up 
under the default Calendar.

Try http://www.moxier.com . This might do what you want. I had that on my first android and thought it was an excellent program. Reviewing the guide they have, it shows subfolder calendar sync.


Another people mention is Touchdown for Android - http://www.nitrodesk.com/ . I visited their website last night and I didn't see a clear indication that it does offer multiple calendar support. You can download a demo though if you want to test it out.

iPhone General Topics

iPhone And Caldav

See Ajcody-Apple-Mac-Issues#iTunes_.26_iPhone_configuration_for_CALDAV

iPhone And SSL Certs

Send CRT File To iPhone By Email

For a self-signed certificate file on the ZCS server, path is /opt/zimbra/ssl/zimbra/server/server.crt

If you email yourself the crt file and read the message from the iTouch/iPhone device, you'll get a "install" button to push.

Setup Webserver To Server Out CRT

For a self-signed certificate file on the ZCS server, path is /opt/zimbra/ssl/zimbra/server/server.crt

Please see the following:

iPhone 2+ Topics

iPhone 2+ Support & Features With Zimbra

Here's three nice references to review:

iPhone 2+ Bugs

BES Connector Issues

Bugs & RFE's

Import Ones To Note First

  • "Supported & RFE Prerequisites For ZCB matrix in ZCB doc & web/wiki pages"
  • "ZCB PDF needs to include information on server sizing and ZDBs"
  • "BB: ZCB/BES Sizing Data Needed"
    • http://bugzilla.zimbra.com/show_bug.cgi?id=22415
      • Recommended Maximum Number Of Users Per BES Server - 50
        • The recommended max is 50 users. After recommended max. is reached you may receive error message in BES MAGT log file indicating that user was not added successfully.
  • "BES/ZCB doc's for restore and server move's"
  • "BES and Proxy" [GunsNRoses]
    • http://bugzilla.zimbra.com/show_bug.cgi?id=33179
      • Description: Per the ZCB documentation, the BES server needs to talk to a single Zimbra mailbox server over 443 and 7071. The problem is that the mailbox servers are behind the Zimbra Proxy and are running in reverse-proxy mode - meaning, they only serve over basic http (port 80) and NOT over 443. The proxy servers serve over 443 - but do not do the 7071. So, we can't point the BES server at a Zimbra mailbox server because the Zimbra mailbox server is not listening over 443 due to being accessed through the proxy. We can't point the BES at a Zimbra proxy server because they do not handle 7071.
BES With Multiple Domains

For the BES Admin account to see users from all your email domains [domains the BES admin isn't a part of] you'll need to set the GAL variables to ROOT. Please review the bug/rfe's above though, as you might not want to do this because of its impact.

To see your current settings:

 zmprov gd <domainname besadmin is in> zimbraGalInternalSearchBase
 zmprov gd <domainname besadmin is in> zimbraGalSyncInternalSearchBase
 zmprov gacf zimbraGalInternalSearchBase

To change your settings (for example, to use ROOT):

 zmprov md <domainname besadmin is in> zimbraGalInternalSearchBase ROOT
 zmprov md <domainname besadmin is in> zimbraGalSyncInternalSearchBase ROOT

Status Of Unconfirmed, New, Assigned, Reopened As Of April 27, 2009

Release Target Version Was Based Upon April 27, 2009. Please goto bug/rfe link for status changes.

BES Wiki Pages

See Wiki Category ZCB.

Split-DNS Issue

If your running split-dns for zimbra, make sure your BES box is configured to use the right DNS servers because it will pull the zmhostname variable and you don't want it resolving to the external ip address.

Duplicate Calendars

One customer reported that "updating the firmware to (as I'm at now) fixed the issue with the duplicate calendar".

Upgrade Steps For ZCB

The Basics

The normal upgrade process is to

From Beta2 To BES SMB - Outlook 2003 To Outlook 2007 Requirement

Here is the list of steps on how to upgrade from BETA2 to BES SMB:

  • Stop BB controller [ see Correct_order_to_stop_and_start_BES_services ]
  • Completely remove Outlook 2003
    • (First, go to Add/Remove programs and uninstall Office 2003. And then run the following utility to cleanup stuff left behind. The utility is called ‘Office Removal Wizard’ and located in the \FILES\PFILES\MSOFFICE\OFFICE11 folder on the install CD. OFFCLN.EXE)
  • Install Outlook 2007
  • Open BES SMB msi to start installation wizard. Accept license agreement and continue following the steps in installation wizard
  • Start BB controller [ see Correct_order_to_stop_and_start_BES_services ]
Attention.png - This article is NOT official Zimbra documentation. It is a user contribution and may include unsupported customizations, references, suggestions, or information.

Testing & Debugging Tools

Actual Testing & Debugging Homepage

Please see Ajcody-Testing-Debugging

Other Debug References

When Was A ZCS Service Enabled Or Disabled=

See Ajcody-Notes-Archive-Discovery#When_Was_A_ZCS_Service_Enabled_Or_Disabled

Ajcody Logging Wiki

See Ajcody-Logging

Other Zimbra Wiki Pages

RFE's Related To Better Logging And Historical Data Of Systems

  • Bug 93954 : RFE: admin console services status page and service enable/disable page improvements
  • Bug 93950 : RFE: History files written when changes to individual ZCS services have taken place
  • Bug 93784 : Proxy check script
  • Bug 93656 : zmdiaglog to collect history or diffs of server variables changes via backups
  • Bug 90598 : RFE: Add option to let the MTA log a mail's subject
  • Bug 90400 : Provide User's Mailbox Summary/Reporting for the end user in ZWC/email report
  • Bug 90032 : zmdiaglog: don't attempt to process mailboxd collection activities on non-mailbox nodes
  • Bug 89860 : gather additional system information in zmdiaglog
  • Bug 89700 : proxy logs goto logger host
  • Bug 89450 : Include postfix-logwatch and amavis-logwatch
  • Bug 89008 : Source Port Logging in Jetty For EU Legal Requirements
    • This bug was initially created as a clone of Bug #85073, include client (source) ports for all mail related connections, in addition to client IP. Need this done for Jetty, nginx and postfix already complete.
  • Bug 88414 : expand 3rd party performance and diagnostic software support
  • Bug 88412 : virtualization env. specific checks and diagnostic scripts
  • Bug 88410 : zmdiaglog gets moved to it's own package, zimbra-diagnostics and we include public package repro to update
  • Bug 88408 : expand zmrcd commands and/or zmdiaglog to do more specific level of log collection
  • Bug 88406 : proxy diagnostic script
  • Bug 88404 : post-installer check script
  • Bug 85523 : Individual logs for zmlocalconfig edits and all services start, stop, restarts
  • Bug 85520 : All backups should include the localconfig.xml
  • Bug 85073 : Source Port Logging For EU Legal Requirements
  • Bug 84313 : zmcontrol should give more details when a service isn't in a running state
  • Bug 84273 : Expand zmdiaglog to better fit as a support case creation tool
    • I have a lot of other bugs/rfe's references in this one also.
    • Private Bug
  • Bug 84272 : Host our own ZCS instance for customers support accounts
    • Private Bug
  • Bug 84271 : Integration of account logins for ftp for support cases
    • Private Bug
  • Bug 84142 : Add script for detecting compromised accounts
  • Bug 83779 : zmdiaglog: include all ZCS configs which are different from the default value
  • Bug 83227 : *.trace.log - what's it for, how to control growth, better retention policy
  • Bug 81201 : zmcontrol start --debug offer verbose logging for all services and notes logs
  • Bug 79883 : Expand Monitor > MobileSync Statistics reporting
  • Bug 78251 : RFE: Display Date And Time for each command
  • Bug 77076 : All Ext. Auth options should have documentation about limitations and expectations
  • Bug 77075 : Flowchart of ext. auth and where log events occur
  • Bug 76540 : RFE: Priovide ability to view major logs, edit configs and terminal login within admin console
  • Bug 75502 : Logging should state if any stop/start/restart of service is manual or automated
  • Bug 62315 : RFE: integrate log analysis project - AWstats or Analog, Webalizer, etc.
  • Bug 62095 : Incorrect graphs in Administration Monitoring Server Statistics message count, message volume
  • Bug 57871 : RFE: replace the current syslog + flash based log system to a Hyperic HQ + HTML5 based log solution
  • Bug 54034 : RFE: zimbra-attrs.xml & zmprov desc state if immediate, zmprov fc , or service restart needed
  • Bug 51100 : RFE: zmprov variable edits should output if a service restart is need or flush cache
  • Bug 49557 : RFE: Login Format Option other than user@domain ,ex. user+domain
  • Bug 45383 : RFE: Enhance documentation as to where connection logging should be expected - esp Active Sync
  • Bug 28934 : More logging options via admin console
  • Bug 12196 : support for real time counters (snmp, jmx, etc)

Various Errors And Log Items One Might See


See Ajcody-Logging for more complete logging information.

mailbox.log and zimbra.log

Zimbra Support will likely need to see the /opt/zimbra/log/mailbox.log file and possibly /var/log/zimbra.log from the system. These files contain the basic operation data from the system, and can tell us if the server has something seriously wrong with it. They can also be correlated against other collected data to give a complete picture of the workings of the system.

mysql_error.log and myslow.log

These files are both located in /opt/zimbra/log/ on the mail store server. They contain information about the health of the mysql database. If there is data corruption or another problem causing direct mysql errors, events will be logged in mysql_error.log. If certain search requests are taking longer to complete than others, they will be logged in myslow.log.


This file contains startup information for mailboxd and thread dumps created whenever mailboxd is shut down. If a server goes completely nonresponsive and is restarted, the thread dump captured here will tell us if there are certain threads blocking other threads' access to critical data elements. Frequently, slow behavior can be caused by these thread locks.
In some cases, it may be necessary to monitor garbage collection and other operations at the Java VM level. To enable this logging, add the following to mailboxd_java_options.
To get current options:
zmlocalconfig mailboxd_java_options
Then appended the following to your current set of options - "-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCApplicationStoppedTime". PLEASE NOTE FOR BELOW, "YOUR EXISTING OPTIONS" should be replaced with the output above.
zmlocalconfig -e mailboxd_java_options="YOUR EXISTING OPTIONS -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCApplicationStoppedTime"

Connections And Or Threads Mentioned In mailbox.log

Tuning Variables Related To Threads And Connections

Resources to "tune" the below variables:

  • ZCS 5.0 has a single thread pool for both HTTP and HTTPS
    • To see current setting
      • zmprov gs `zmhostname` zimbraHttpNumThreads
    • To modify setting
      • zmprov ms `zmhostname` zimbraHttpNumThreads 500
  • This setting of 300 is able to support a few 10s of thousands of users checking mailing every 8 minutes.
    • To see current setting
      • zmprov gs `zmhostname` zimbraPop3NumThreads
    • To modify setting
      • zmprov ms `zmhostname` zimbraPop3NumThreads 300
  • IMAP thread settings.
    • To see current setting
      • zmprov gs `zmhostname` zimbraImapNumThreads
    • To modify setting
      • zmprov ms `zmhostname` zimbraImapNumThreads 500
  • LMTP thread settings.
    • To see current setting
      • zmprov gs `zmhostname` zimbraLmtpNumThreads
    • To modify setting
      • zmprov ms `zmhostname` zimbraLmtpNumThreads 40
  • JVM (java Virtual Machine options) ZCS 5.0 and later
    • To see current setting
      • zmlocalconfig mailboxd_java_options
    • To modify setting
      • zmlocalconfig mailboxd_java_options="-client -XX:NewRatio=2 -Djava.awt.headless=true -XX:MaxPermSize=128m -XX:SoftRefLRUPolicyMSPerMB=1"
        • The above is using the "default" options as an example to modify.
    • Other various configurations for mailboxd_java_options. See sections related to heap and thread dumps below for more details.
      • mailboxd_java_options="-client -XX:NewRatio=2 -XX:MaxPermSize=128m -Djava.awt.headless=true -XX:SoftRefLRUPolicyMSPerMB=1 -XX:+UseParallelGC"
      • mailboxd_java_options="-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/some/directory/that/exists/and/is/zimbra/writable"
  • JVM Cache setting
    • To see current setting
      • zmlocalconfig mailboxd_java_heap_memory_percent
    • To modify setting
      • zmlocalconfig -e mailboxd_java_heap_memory_percent=40
  • Mailbox message cache. The mailbox server maintains a cache of message bodies (blobs on disk from /opt/zimbra/store). This cache speeds up retrieval of message content for mailapps such as mail.app
    • To see current setting
      • zmprov gs `zmhostname` zimbraMessageCacheSize
    • To modify setting
      • zmprov ms `zmhostname` zimbraMessageCacheSize 104857600
  • zimbra_mysql_connector_maxActive
    • To see current setting
      • zmlocalconfig zimbra_mysql_connector_maxActive
    • To modify setting
      • zmlocalconfig -e zimbra_mysql_connector_maxActive=100

Example Of mailbox.log event:

dbconn - Connection pool is 75% utilized (88 connections out of a maximum of 100 in use).  
   Turn on debug logging for zimbra.dbconn to see stack traces of connections not returned to the pool.

There is a potential problem with XMPP [Instant Messaging]. XMPP is a beta feature and is not supported. If you're not using XMPP anyways, disabling it is strongly recommended, and XMPP is a beta feature and not supported in a production environment today.

  • Confirm if variable is set to False or True
    • zmprov gacf zimbraXMPPEnabled
  • Set to FALSE to turn off
    • zmprov mcf zimbraXMPPEnabled FALSE
  • Then at some point restart the mailstores.

Bug reference:

Zimbra Tools And Commands

zmstat and zmstat-chart


Down And Dirty Example zmstat

Zmstats runs constantly on all current Zimbra systems. It monitors various Zimbra components as well as the whole system to give a good picture of how the system is performing over time. Stats charts are extremely useful for troubleshooting performance issues and can often point to a bottleneck on the system itself or to specific problems in the mailboxd Java VM.

To generate a stat chart, run the following:

zmstat-chart -d <output directory> -s /opt/zimbra/zmstat/<date> --title "<server> <date>"

The date is in the format 'YYYY-MM-DD'. Generally when troubleshooting a performance problem, Zimbra Support will need to see several days' worth of statistics data, as well as the log files and possibly thread dumps from the same time period.


See also : Zmdiaglog

Running a full zmdiaglog would take many stats such as zmstats, thread dump, lsof, core dump, and heap dump. The heap dump portion could take longer than the other steps and is invasive on the system. If possible, it should only be ran if it is late in the evening or if the server is not responding anyway. Prior to 5.0.16, this tool may run a heap dump, which would be interruptive on a running server. From 5.0.16, a heap dump requires "zmdiaglog -a". Also, you can CTRL-C to exit out of the zmdiaglog during the heap dump process without affecting the rest of the dump. You will just need to compress the files manually.

As root:


This will create a zip file with allot of relevant data for troubleshooting issues.

zimdialog To Get Full Heap Dump

In order to get a full heap dump, one has to make sure that HeapDumps have been enabled in the JVM options. In order to do this, please first check your mailboxd_java_options on that server:

# su - zimbra
$ zmlocalconfig mailboxd_java_options

Then, append these additional arguments:

-verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/some/directory/that/exists/and/is/zimbra/writable

It is very important that the HeapDumpPath chosen is large enough to dump a multi-GB core file and heap dump. It is also very important to make sure that these options are appended to your existing options.

Example [You might need to adjust based upon your existing mailboxd_java_options]:

$ zmlocalconfig mailboxd_java_options
mailboxd_java_options = -client -XX:NewRatio=2 -Djava.awt.headless=true -XX:MaxPermSize=128m -XX:SoftRefLRUPolicyMSPerMB=1
$ zmlocalconfig -e mailboxd_java_options="-client -XX:NewRatio=2 -Djava.awt.headless=true -XX:MaxPermSize=128m -XX:SoftRefLRUPolicyMSPerMB=1 -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/tmp"

Then restart ZCS on that mailstore.

Caution: If /var/tmp does not enough space, it could fill the filesystem/server and cause very bad problems!

Then, if any problem with performance occurs again, run the zmdiaglog as root:

[Prior to 5.0.16]


[For 5.0.16 and forward]

/opt/zimbra/libexec/zmdiaglog -a

Note: there are optional options to zmdiaglog that allows it to write to locations other than /tmp, again very important not to fill up the filesystem. Run zmdiaglog -h to get the list of options:

# /opt/zimbra/libexec/zmdiaglog -h
Usage: zmdiaglog [-dth]
   -d    - Log destination (Default /tmp/zmdiaglog.PID)
   -t    - Timeout in seconds for hanging commands (Default 120)
   -h    - This help message

This may take a few minutes to complete, as it is writing a multiple GB file. Once complete, then restart mailboxd:

# su - zimbra
$ zmmailboxdctl restart

You will then provide to Zimbra, via FTP, the zmdiaglog information that is written to /tmp. Our developers will most likely need to debug the information provided rather than support staff. Please be patient, support will provide feedback as they hear the conclusions that the developers provide.

There are lots of steps requested here, but this information is critical if we are to diagnose this reported problem. The data provided by zmdiaglog is very important.

Using JDK 1.6 For zmdiaglog

See Ajcody-Testing-Debugging#jmap_And_JDK_1.6

Note About Memory And Linux

In general, memory used by the JVM can occasionally spike above the maximum heap size under normal usage, but we would expect that it would go back down again eventually. Also, please note that all Linux systems will utilize all memory available on the system - this is because the kernel will cache any data it can in order for possible reuse; this is perfectly normal, and in the case that memory is needed, older cache will be deleted from memory and memory freed for other use. No Linux system will show much memory as "free" after being up for some period of time, for example when using top or vmstat. All memory will get utilized by the system, and this is a good thing for performance - you paid for the memory, might as well use it. Where it could be a problem is if one process grows uncontrolled, or if swapping is occurring.

Thread Dumps And Specific Commands To Use

A thread dump is a printout of the status of all the running threads in the mailboxd process at a specific point in time. A thread dump allows Zimbra engineers to see how the system is operating, what each thread is doing, and what data elements are being accessed by individual threads. If a performance bottleneck is not identifiable from the stat charts alone, it may be necessary to generate a periodic thread dump.

zmthrdump - ZCS 5.0.10+

The thread dump from zmthrdump will show which threads are currently in process within the jvm. zmthrdump is useful when you want to grab several thread dumps in short intervals in order to track and look for locked threads. Typically, the thread dumps are useful for tracking what is waiting on what in the thread stack. If the server is also experiencing GC [garbage collection] issue, it is generally better to just have a full zmdiaglog (with valid java memory heap dump) along with the rest of the data it collects.


  • zmthrdump help
    • zmthrdump [-h] [-i] [-t <timeout seconds>] [-p <pid file>] [-f <file>] [-o <out-file>]

zmmailboxdmgr And Threaddump - Prior to 5.0.10

Run this command as root

for i in 1 2 3; do /opt/zimbra/libexec/zmmailboxdmgr threaddump; sleep 30; done

/opt/zimbra/log/zmmailboxd.out will reflect the thread dumps.

Thread Dump Script Example 1

Usage of the below script:

$0 FILENAME -dl [-frames #_ stack_frames] [-id REGEXP] [-all]
$0 FILENAME -dt [-frames #_ stack_frames] [-sort id|state] [-stack REGEXP] [-id REGEXP] [-state REGEXP] [-waiting NUMBER]
frames: controls the # lines of stack trace included in the output
id: only include where the id matches REGEXP
all: include ALL locks (not just ones that other threads are blocked-on)
sort: controls the order threads are printed out (locks always printed in lock ID order)
stack: only include threads where the thread's stack output matches REGEXP
state: only include threads where the thread state (e.g. RUNNABLE) matches REGEXP
waiting: only inclure threads are blocking other threads


$0 threads.txt -dt -stack MailboxIndex.java -state RUNNABLE -f 20
-- dumps all RUNNABLE threads with MailboxIndex.java on the stack (1st 20 lines of the stack)
$0 threads.txt -dl -f 0
-- dumps the list of locks in the system that are blocking at least one thread
$0 threads.txt -dt -f 0 -sort state
-- dumps a list of all the threads in the system and tells you their run state
$0 threads.txt -dt -f 20 -w 1
-- dumps a list of all the threads in the system that are blocking other threads (quick way to hunt for contention)

Working Example:

threadDumpAnalyzer.pl zmmailboxd.out -dl -f 100 ~/Desktop
threadDumpAnalyzer.pl Script
#!/usr/bin/perl -w
# Zimbra Collaboration Suite Server
# Copyright (C) 2004, 2005, 2006, 2007 Zimbra, Inc.
# The contents of this file are subject to the Yahoo! Public License
# Version 1.0 ("License"); you may not use this file except in
# compliance with the License.  You may obtain a copy of the License at
# http://www.zimbra.com/license.
# Software distributed under the License is distributed on an "AS IS"
# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
# ***** END LICENSE BLOCK *****
use strict;
use warnings;
use Getopt::Long;

my %locks;                      # by LockID - hash w/ 'owner','type'
my %threads;           # by threadId - hash w/ 'state' 'waitingOnLock'

my $filename = $ARGV[0];
my ($dumpLocks, $dumpThreads, $searchThreadStack, $searchThreadId, $stackFrames, $sort, $filterByState, $allLocks);
my ($waiting);

$stackFrames = 10;
$sort = "state";

           "dl" => \$dumpLocks,
           "dt" => \$dumpThreads,
           "frames=s" => \$stackFrames,
           "sort=s" => \$sort,
           "id=s" => \$searchThreadId,
           "state=s" => \$filterByState,
           "stack=s" => \$searchThreadStack,
           "waiting=s" => \$waiting,
           "all" => \$allLocks,

sub dumpLocks();
sub handleThread();
sub dumpThreads();
sub usage();
sub readFile($);
sub getBlockedThreads($);

if (!defined $filename) {


if (defined $dumpLocks) {
} elsif (defined $dumpThreads) {
} else {


sub usage() {
  my $usage = <<END_OF_USAGE;
    $0 FILENAME -dl [-frames #_ stack_frames] [-id REGEXP] [-all]
    $0 FILENAME -dt [-frames #_ stack_frames] [-sort id|state] [-stack REGEXP] [-id REGEXP] [-state REGEXP] [-waiting NUMBER]

    frames:  controls the # lines of stack trace included in the output
    id:      only include where the id matches REGEXP

    all:     include ALL locks (not just ones that other threads are blocked-on)

    sort:    controls the order threads are printed out (locks always printed in lock ID order)
    stack:   only include threads where the thread's stack output matches REGEXP
    state:   only include threads where the thread state (e.g. RUNNABLE) matches REGEXP
    waiting: only inclure threads are blocking other threads


    $0 threads.txt -dt -stack MailboxIndex.java -state RUNNABLE -f 20
        -- dumps all RUNNABLE threads with MailboxIndex.java on the stack (1st 20 lines of the stack)

    $0 threads.txt -dl -f 0
        -- dumps the list of locks in the system that are blocking at least one thread

    $0 threads.txt -dt -f 0 -sort state
        -- dumps a list of all the threads in the system and tells you their run state

    $0 threads.txt -dt -f 20 -w 1
        -- dumps a list of all the threads in the system that are blocking other threads (quick way to hunt for contention)

  die $usage;

sub mySort($$) {
  my ($a, $b) = @_;
  if ($sort eq "state") {
    my $state1 = $threads{$a}{state};
    my $state2 = $threads{$b}{state};
    if (!defined $state1) {
      return 1;
    } elsif (!defined $state2) {
      return -1;
    return $state1 cmp $state2;
  } else {
    return $a cmp $b;

sub padToWidth($$) {
  my ($str, $width) = @_;
  if (!defined($str)) {
    $str = "";
  return sprintf "%-*s", $width, $str;

sub formatStackTrace($$) {
  my ($stack, $indent) = @_;
  my $ret;
  if ($stackFrames == 0) { return ""; }
  my $num = $stackFrames;
  foreach my $line (split /\n/, $stack) {
    if ($num <= 0) {
      return $ret;
    $ret .= $indent.$line."\n";
  return $ret;

sub formatLock($) {
  my $lockId = shift;
  my $output = "$lockId - ";
  my $numData = 0;
  while (my ($k,$v) = each %{ $locks{$lockId}}) {
    $output .= " $k=$v";
  if ($numData == 0) { $output .= " UNKNOWN"; }
  return $output;

sub formatThread($) {
  my $threadId = shift;
  if (!defined $threadId) { return ""; }
  my $foo = padToWidth($threadId, 50);
  if (!defined($foo) || $foo eq "") {
    $foo = "ASDF";
  my $bar = $threads{$threadId}{state};
  if (!defined($bar) || $bar eq "") {
    $bar = "HJKL";
  my $ret = $foo.$bar."\n";
  if (defined $threads{$threadId}{waitingOnLock}) {
    $ret .= "\tWaiting for: ".formatLock($threads{$threadId}{waitingOnLock})."\n";

  my @blockedThreads = getBlockedThreads($threadId);
  for my $blockedThread (sort @blockedThreads) {
    $ret .= "\t$blockedThread is waiting on this thread\n";
  $ret .= formatStackTrace($threads{$threadId}{stack}, "\t  ");
  if ($stackFrames > 0) {
    $ret .= "\n";
  return $ret;

# given a lockId, return a list of the threads that are blocked on it
sub getLockWaiters($) {
  my $lockId = shift;
  my @ret;

  while (my ($threadId,$thread) = each %threads ) {
    if (defined $thread->{waitingOnLock} &&
        $thread->{waitingOnLock} eq $lockId) {
      push @ret, $threadId;
  return @ret;

sub getLockOwner($) {
  my $lockId = shift;
  if (defined $locks{$lockId} &&
      defined $locks{$lockId}{owner}) {
    return $locks{$lockId}{owner};
  } else {
    return "";

# given a threadId, get a list of all other threads that are blocked
# on locks it is holding
sub getBlockedThreads($) {
  my $threadId = shift;
  my @ret;
  foreach my $lockId ( sort keys %locks ) {
    if (getLockOwner($lockId) eq $threadId) { # a lock we own
      my @blockedThreads = getLockWaiters($lockId); 
      foreach my $blockedThread (@blockedThreads) {
        push @ret, $blockedThread;
        push @ret, getBlockedThreads($blockedThread); #recurse!
  return @ret;

sub dumpLocks() {
  foreach my $lockId ( sort keys %locks ) {
    my $ret = "";
    my $numWaiters = 0;
    $ret .=  "LOCK: $lockId   ";
    while (my ($k,$v) = each %{ $locks{$lockId}}) {
      $ret .=  "$k=$v, ";
    $ret .= "\n";
    while (my ($threadId,$thread) = each %threads ) {
      if (defined $thread->{waitingOnLock} &&
          $thread->{waitingOnLock} eq $lockId) {
        $ret .= "\tThread $threadId is waiting for this lock\n";
    $ret .= formatStackTrace($threads{getLockOwner($lockId)}{stack}, "\t");

    if (!defined $searchThreadId || $lockId =~ /$searchThreadId/) {
      if ($numWaiters > 0 || defined $allLocks) {
        if ($stackFrames > 0) {
          $ret .= "\n";
        print $ret;

sub dumpThreads() {
  foreach my $threadId ( sort { mySort($a, $b) } keys %threads ) {
    if (!defined $threadId) {
      # continue
    } elsif (defined $searchThreadStack && $threads{$threadId}{stack} !~ /$searchThreadStack/) {
      # continue
    } elsif (defined $searchThreadId && $threadId !~ /$searchThreadId/) {
      # continue
    } elsif (defined $filterByState && $threads{$threadId}{state} !~ /$filterByState/) {
      # continue
    } elsif (defined $waiting && getBlockedThreads($threadId) < $waiting) {
      # continue
    } else {
      print formatThread($threadId);

sub readFile($) {
  my $filename = shift;
  open IN, '<', $filename or die "couldn't open $filename";
  my @curThread;

  while (<>) {
    if ($_ eq "") {
      if (@curThread) {
        my $threadId;
        my @locksHeld;
        my $waitingOnLock;
        my $threadState;
        my $output;
        my $firstLineState;
        # 1stline
        my $line = shift @curThread;
        $output .= "$line\n";
        if ($line =~ /"(.*)"/) {
          $threadId = $1;
          if ($line =~/nid=0x[0-9a-f]+\s([a-zA-Z\s\.()]+)/) {
            $threads{$threadId}{state} = $1;

        } else {
          $threadId = $line;
        if ($threadId eq "") { $threadId = "none"; }
        # 2nd line
        $line = shift @curThread;
        if (defined $line) {
          $output .= "$line\n";
          if ($line =~ /State: ([A-Z_]+)/) {
            $threadState = $1;
            $threads{$threadId}{state} = $1;
          foreach $line (@curThread) {
            $output .= "$line\n";
            if ($line =~ /locked <(0x[0-9a-f]+)>\s?(.*)?/) {
              push @locksHeld, $1;
              $locks{$1}{owner} = $threadId;
              $locks{$1}{type} = $2;
            } elsif ($line =~ /- waiting to lock <(0x[0-9a-f]+)>/) {
              $waitingOnLock = $1;
              $threads{$threadId}{waitingOnLock} = $1;
            } elsif ($line =~ /- waiting to lock <(0x[0-9a-f]+)>/) {
              $waitingOnLock = $1;
              $threads{$threadId}{waitingOnLock} = $1;              
        } else {
          $threads{$threadId}{state} = "unknown";
        $threads{$threadId}{stack} = $output;
        @curThread = ();
    } else {
      push @curThread, $_;
  close IN;
Thread Dump Script Example 2

The following script generates five thread dumps within one minute:

# Dump 5 threads and proc stats for mailboxd Java PID in one minute.
# Daily output written to /tmp/zmperiodic-YYYYMMDD
# Execute the script with cron
# crontab: * * * * * /tmp/zmperiodic.sh

DUMPDIR="/tmp/zmperiodic-$(date '+%Y%m%d')"

if [ ! -d $DUMPDIR ]
mkdir $DUMPDIR

for ((i=0; i<5; i++))
echo "" > /opt/zimbra/log/zmmailboxd.out
STAMP=$(date '+%Y%m%d.%H%M%S')
JPID=$(cat /opt/zimbra/log/zmmailboxd_java.pid)
kill -3 $JPID
sleep 1

cp /opt/zimbra/log/zmmailboxd.out $DUMPDIR/zmmailboxd.out-$STAMP
cat /proc/$JPID/task/*/stat > $DUMPDIR/proc-stats-$STAMP

if [ $i -ne 4 ]
sleep 11

It should be placed in cron so that it runs every minute. The output data will be placed in a directory named /tmp/zmperiodic-YYYYMMDD. This data will consist of thread dumps along with thread data from /proc.

Heap Dump Specific Commands

jmap And JDK 1.6

Go here:



  • Java SE Development Kit (JDK)
  • JDK 6 Update 13

Choose Example Is Using x64 Binary - Adjust If Using x32:

  • Linux x64
  • jdk-6u13-linux-x64.bin *DO NOT choose RPM download*

Place jdk-6u13-linux-x64.bin in /tmp on the ZCS server.

Install JDK 1.6 as root. Executing the bin file prompt you to agree to a license agreement. The installer will create a directory named jdk1.6.0_13 and extract contents to that directory. This process does not interfere with ZCS.

cd /opt/zimbra
chown -R zimbra:zimbra jdk1.6.0_13

Next, stop ZCS services with zmcontrol, destroy the java symlink and symlink JDK 1.6 to java.

su - zimbra
zmcontrol stop
rm -rf java
ln -s jdk1.6.0_13 java
zmcontrol start

You can now run your zmdiaglog with greater efficiency. Alternatively, you can generate heap dumps manually with jmap (as zimbra this time).

su - zimbra -c '/opt/zimbra/java/bin/jmap -dump:live,file=/tmp/heapdump.live $(cat /opt/zimbra/log/zmmailboxd_java.pid)'

Rollback at any time by shutting down services with zmcontrol and pointing the java symlink back to jdk1.5.



Trouble Shooting Memory Issues

Basic Commands To Gather Data


Try adjusting the ps output:

  • ps -eo pid,ppid,rss,vsize,pcpu,pmem,cmd -ww --sort=pid
    • RSS (Resident Set Size) - The portion of a process that exists in physical memory (RAM). The rest of the program exists in swap. If the computer has not used swap, this number will be equal to VSIZE. RSS per unit time will show how much RAM the process is using over time.
    • VSIZE (Virtual memory SIZE) - The amount of memory the process is currently using. This includes the amount in RAM and the amount in swap. VSIZE per unit time will show how large the process is over time.


Using Free:

  • free -o
    • [ -o ] Disables the display of a "buffer adjusted" line. If the -o option is not specified, free subtracts buffer memory from the used memory and adds it to the free memory reported.
    • "Memory Used" per unit time will show the "Memory Used" asymptotically approach the total amount of memory in the system under heavy use. This is normal, as RAM unused is RAM wasted.
    • "Memory Used - Memory Buffered - Memory Cached" per unit time will give a good sense of the memory use of your applications minus the effects of your operating system. As you start new applications, this value should go up. As you quit applications, this value should go down. If an application has a severe memory leak, this line will have a positive slope.
    • "Swap Used" per unit time will display the swap usage. When the system is low on RAM, a program called kswapd will swap parts of process if they haven't been used for some time. If the amount of swap continues to climb at a steady rate, you may have a memory leak or you might need more RAM.

You could also use watch with free to poll it:

  • watch free
    • or
  • watch -n 1 -d free


Top is nice, put you want to save output. Do the [-b batch] and [-n number of iterations] variables:

top -b -n1 > /tmp/top-output.txt

One could add into cron if you want to get top output every 5 minutes like this for example [Would would need to confirm the directory structure and perms to write in it our correct]:

crontab -e
 ** add the following line
*/5 * * * * top -b -n1 > /opt/zimbra/support/data/tops/top-`date +\%F-\%H-\%M`.txt

This is a nice addition to include in the Ajcody-Logging#Like_To_Have_zmstat-chart_Data_Integrated_With_Zimbra setup. Where you would place the data underneath the root http directory.


Gives a good overview as well:

  • The process-related fields are:
    • r — The number of runnable processes waiting for access to the CPU
    • b — The number of processes in an uninterruptible sleep state
    • w — The number of processes swapped out, but runnable
  • The memory-related fields are:
    • swpd — The amount of virtual memory used
    • free — The amount of free memory
    • buff — The amount of memory used for buffers
    • cache — The amount of memory used as page cache
  • The swap-related fields are:
    • si — The amount of memory swapped in from disk
    • so — The amount of memory swapped out to disk
  • The I/O-related fields are:
    • bi — Blocks sent to a block device
    • bo— Blocks received from a block device
  • The system-related fields are:
    • in — The number of interrupts per second
    • cs — The number of context switches per second
  • The CPU-related fields are:
    • us — The percentage of the time the CPU ran user-level code
    • sy — The percentage of the time the CPU ran system-level code
    • id — The percentage of the time the CPU was idle

Polling data with vmstat:

  • vmstat 1 10
    • Displays one new line per second, but only for the next ten seconds


See below for description of the output for meminfo:

Featured Article: /proc/meminfo Explained

Do the following:

cat /proc/meminfo

Non-Zimbra Tools

Caution : None of this is supported by the Zimbra Support team. However it might prove useful, and depending on how much I can document these tools - who knows, maybe we can start using them more directly in the support process.

Debugging Tools

  • Opensourcetesting.org - General Site with News and Tools
  • MAT - Memory Analyzer Tool
    • MAT w/ Eclipse
      • http://www.eclipse.org/mat/
        • Adding this to the startup settings of zimbra
          • -XX:+HeapDumpOnOutOfMemoryError
          • -XX:HeapDumpPath=/opt/zimbra/log/dumps/
        • dumps out of mem heap. That file you can then load into MAT.
  • Linux /proc/sys/kernel/core_pattern
    • By setting /proc/sys/kernel/core_pattern, one can run a user-level program before a process dies to gather additional debugging information.
    • A pipe is opened and attached to your script. The kernel writes the coredump to the pipe. Your script can read it and write it to storage.
    • Your script can attach GDB, get a backtrace, run pstack, dump open file descriptors, etc.
    • For detailed explanation + script: http://timetobleed.com/an-obscure-kernel-feature-to-get-more-info-about-dying-processes/

Automate Testing / Load Testing

Personal tools