Zimbra OS Admin Guide 8.5.0
Zimbra OS Admin Guide 8.5.0
Zimbra OS Admin Guide 8.5.0
Administrator Guide
Zimbra Collaboration 8.5
Open Source Edition
August 2014
Legal Notices
Copyright 2005-2014 Zimbra, Inc. All rights reserved. This product is protected by U.S. and
international copyright and intellectual property laws. "Zimbra" is a registered trademark of Zimbra, Inc.
in the United States and other jurisdictions.You may not alter or remove any trademark, copyright, or
other notice from copies of the content. All other marks and names mentioned herein may be trademarks
of their respective companies.
Zimbra, Inc.
3000 Internet Blvd., Suite 200
Frisco, Texas 75034
www.zimbra.com
Zimbra Collaboration 8.5, Rev 1
August 2014
Zimbra Collaboration 8.5 Open Source Edition iii
Tabl e of Cont ents
1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Third-Party Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Support and Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2 Product Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Architectural Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Core Email, Calendar and Collaboration Functionality . . . . . . . . . . . . . . . . 12
Zimbra Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Zimbra Application Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Zimbra System Directory Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Web Client Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
3 Zimbra Mailbox Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Mailbox Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Message Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Data Store. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Index Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Web Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Mailstore Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
User Interface Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Web Application Server Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Installation and Configuration of the Web Application Server Split. . . . . 20
Mailbox Server Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4 Zimbra LDAP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
LDAP Traffic Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
LDAP Directory Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Zimbra Collaboration LDAP Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Zimbra Collaboration Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Account Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Internal Authentication Mechanism. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
External LDAP and External AD Authentication Mechanism . . . . . . . . . 28
Custom Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Kerberos5 Authentication Mechanism . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Global Address List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Flushing LDAP Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Flush the Cache for Themes and Locales . . . . . . . . . . . . . . . . . . . . . . . 33
Flush Accounts, Groups, COS, Domains, and Servers . . . . . . . . . . . . . 33
5 Zimbra Mail Transfer Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Incoming Mail Routing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Zimbra MTA Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Postfix Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
SMTP Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
iv Open Source Edition Zimbra Collaboration 8.5
Administrators Guide
SMTP Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Sending Non Local Mail to a Different Server. . . . . . . . . . . . . . . . . . . . . 37
Anti-Virus and Anti-Spam Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Anti-Virus Protection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Anti-Spam Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Receiving and Sending Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Message Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6 Zimbra Proxy Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Proxy Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Proxy Architecture and Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Change the Zimbra Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Zimbra Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Zimbra Proxy Ports for POP and IMAP . . . . . . . . . . . . . . . . . . . . . . . . . 45
Setting Up IMAP and POP Proxy After HTTP Proxy Installation . . . . . . 45
Configure Zimbra HTTP Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Setting Up HTTP Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Set Proxy Trusted IP Addresses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configure Zimbra Proxy for Kerberos Authentication . . . . . . . . . . . . . . . . . 51
7 Using the Administration Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Administrator Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Change Administrator Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Log in to the Administration Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Managing Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Message of the Day for Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Create a Message of the Day. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Remove a Message of the Day . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Zimbra Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
8 Managing Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Global Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
General Global Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Setting Up Email Attachment Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Blocking Email Attachments by File Type. . . . . . . . . . . . . . . . . . . . . . . . 59
Global MTA Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Global IMAP and POP Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Working With Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Domain General Information Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Global Address List (GAL) Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Using GAL sync accounts for faster access to GAL. . . . . . . . . . . . . . . . 64
Authentication Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Virtual Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Renaming a Domain. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Adding a Domain Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Enabling Support for Domain Disclaimers . . . . . . . . . . . . . . . . . . . . . . . 67
Disable Disclaimers for Intra-domain Emails . . . . . . . . . . . . . . . . . . . . . 69
Disable the Disclaimer Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Zimlets on the Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Managing Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
General Server Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Change MTA Server Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
v Open Source Edition Zimbra Collaboration 8.5
Administrators Guide
Setting Up IP Address Binding. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Managing SSL Certificates for ZCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Installing Certificates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Viewing Installed Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Maintaining Valid Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Install a SSL Certificate for a Domain. . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Using DKIM to Authenticate Email Message . . . . . . . . . . . . . . . . . . . . . . . . 74
Configure ZCS for DKIM Signing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Update DKIM Data for a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Remove DKIM Signing from ZCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Retrieve DKIM Data for a Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Anti-spam Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Anti-virus Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Zimbra Free/Busy Calendar Scheduling . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Storage Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Email Retention Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Configure Email Lifetime Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Configure Message Retention and Deletion Policies . . . . . . . . . . . . . . . 84
Managing the Dumpster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Configure Legal Hold on an Account . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Customized Admin Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Backing Up the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
9 Managing User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Change Status of Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Delete an Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
View an Accounts Mailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Use an Email Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Work with Distribution Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Setting Subscription Policies for Distribution Lists . . . . . . . . . . . . . . . . . 91
Management Options for Owners of Distribution Lists . . . . . . . . . . . . . . 91
Creating a Distribution List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Enable Viewing of Distribution List Members for AD Accounts . . . . . . . 93
Using Dynamic Distribution Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Create Dynamic Distribution Lists from the Administration Console . . . 94
Using CLI to Manage Dynamic Distribution Lists . . . . . . . . . . . . . . . . . . 96
10Customizing Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Messaging and Collaboration Applications . . . . . . . . . . . . . . . . . . . . . . . . . 97
Email Messaging Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Set Up Address Book Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Set Up Calendar Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Set Up Zimbra Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Setting Zimbra Web Client User Interface Themes . . . . . . . . . . . . . . . . . . 107
Other Configuration Settings for Accounts . . . . . . . . . . . . . . . . . . . . . . . . 107
Enable Sharing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Configure SMS Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Display a Warning When Users Try to Navigate Away. . . . . . . . . . . . . 108
Enabling the Check Box for the Web Client . . . . . . . . . . . . . . . . . . . . . 108
Preferences Import/Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Add Words to Spell Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
vi Open Source Edition Zimbra Collaboration 8.5
Administrators Guide
11Zimlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Manage Zimlets from the Administration Console . . . . . . . . . . . . . . . . . . . 111
Deploy Custom Zimlets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Enable, Disable, or Make Zimlets Mandatory. . . . . . . . . . . . . . . . . . . . 112
Undeploy a Zimlet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Add Proxy-Allowed Domains to a Zimlet . . . . . . . . . . . . . . . . . . . . . . . 113
Upgrading a Zimlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Managing Zimlets from the Command Line Interface . . . . . . . . . . . . . . . . 113
Deploying Zimlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Add Proxy Allowed Domains to a Zimlet. . . . . . . . . . . . . . . . . . . . . . . . 114
Deploying a Zimlet and Granting Access to a COS . . . . . . . . . . . . . . . 114
Viewing Zimlet List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Changing Zimlet Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Upgrading a Zimlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Zimbra Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Customized Zimlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12Monitoring ZCS Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Zimbra Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Enable Server Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Review Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Enable or Disable Server Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Server Performance Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Configure Logger Mail Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Configuring Disk Space Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Monitoring Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Configuring Denial of Service Filter Parameters . . . . . . . . . . . . . . . . . . . . 121
Identifying False Positives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Customizing DoSFilter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Tuning Considerations for ZCS 8.0.3 and later . . . . . . . . . . . . . . . . . . 123
Working with Mail Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
View Mail Queues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Flush Message Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Monitoring Mailbox Quotas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
View Quota. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Increase or Decrease Quota. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Viewing MobileSync Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Monitoring Authentication Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Viewing Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Syslog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Use log4j to Configure Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Logging Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Protocol Trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Review mailbox.log Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Reading a Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Fixing Corrupted Mailbox Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Check if an Index is Corrupt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Repair and Reindex a Corrupt Index . . . . . . . . . . . . . . . . . . . . . . . . . . 136
SNMP Monitoring and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
SNMP Monitoring Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
SNMP Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Errors Generating SNMP Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Checking MariaDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Zimbra Collaboration 8.5 Open Source Edition vii
Checking for Zimbra Collaboration Software Updates . . . . . . . . . . . . . . . . 137
Updating Zimbra Connector for Microsoft Outlook . . . . . . . . . . . . . . . . . . 138
Types of Notifications and Alerts Sent by Zimbra Collaboration . . . . . . . . 138
Service status change notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Disk usage notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Duplicate mysqld processes running notification . . . . . . . . . . . . . . . . . 139
SSL certificates expiration notification . . . . . . . . . . . . . . . . . . . . . . . . . 139
Daily report notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Database integrity check notification . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Backup completion notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Appendix A Command Line Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
General Tool Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Zimbra CLI Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Using non-ASCII Characters in CLIs . . . . . . . . . . . . . . . . . . . . . . . . . . 146
zmprov (Provisioning) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Configure Auto-Grouped Backup from the CLI . . . . . . . . . . . . . . . . . . 158
Changing Conversations Thread Default . . . . . . . . . . . . . . . . . . . . . . . 159
Detect Corrupted Indexes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
zmaccts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
zmcalchk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
zmcontrol (Start/Stop/Restart Service) . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
zmgsautil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
zmldappasswd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
zmlocalconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
zmmailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
zmtlsctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
zmmetadump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
zmmypasswd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
zmproxyconfgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
zmproxypurge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
zmskindeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
zmsoap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
zmstat-chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
zmstat-chart-config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
zmstatctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
zmthrdump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
zmtrainsa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
zmtzupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
zmvolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
zmzimletctl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
zmproxyconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
zmsyncreverseproxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Appendix B Configuring SPNEGO Single Sign-On . . . . . . . . . . . . . . . . . . . . . 183
Configuration Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Create the Kerberos Keytab File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Configure ZCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Configure Your Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Test your setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Troubleshooting setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Configure Kerberos Auth with SPNEGO Auth . . . . . . . . . . . . . . . . . . . . . . 191
viii Open Source Edition Zimbra Collaboration 8.5
Administrators Guide
Appendix C ZCS Crontab J obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
How to read the crontab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
ZCS Cron J obs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
J obs for crontab.store. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
J obs for crontab.logger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
J obs for crontab.mta. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Single Server Crontab -l Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Appendix D Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Zimbra Collaboration 8.5 Open Source Edition 9
1 Introduction
Zimbra Collaboration is a full-featured messaging and collaboration solution
that includes email, address book, calendaring, tasks, and Web document
authoring.
Topics in this chapter include:
Audience
Third-Party Components
Support and Contact Information
Audience
This guide is intended for system administrators responsible for installing,
maintaining, and supporting the server deployment of Zimbra Collaboration.
Readers of this guide should have the following recommended knowledge and
skill sets:
Familiarity with the associated technologies and standards Linux operating
system, and open source concepts
Industry practices for mail system management
Third-Party Components
Where possible, Zimbra Collaboration adheres to existing industry standards
and open source implementations for backup management, user
authentications, operating platform, and database management. However,
Zimbra only supports the specific implementations described in the Zimbra
Collaboration architecture overview in the Product Overview chapter as
officially tested and certified for the Zimbra Collaboration. This document
might occasionally note when other tools are available in the marketplace, but
such mention does not constitute an endorsement or certification.
Support and Contact Information
Visit www.zimbra.com to join the community and to be a part of building the
best open source messaging solution. We appreciate your feedback and
suggestions.
Contact [email protected] to purchase Zimbra Collaboration
10 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Explore the Zimbra Forums for answers to installation or configurations
problems
J oin the Zimbra Forums, to participate and learn more about the Zimbra
Collaboration
Let us know what you like about the product and what you would like to see in
the product. Post your ideas to the Zimbra Forum.
If you encounter problems with this software, go to http://bugzilla.zimbra.com
to submit a bug report. Make sure to provide enough detail so that the bug can
be easily duplicated.
Zimbra Collaboration 8.5 Open Source Edition 11
2 Product Overview
This chapter gives an overview of Zimbra components, architecture, and
application packages. An overview is also provided of available web client
versions, or using web services, desktop email clients, or the offline mode.
Architectural Overview
Core Email, Calendar and Collaboration Functionality
Zimbra Components
Zimbra Application Packages
Zimbra System Directory Tree
Web Client Versions
Architectural Overview
The Zimbra Collaboration architecture is built with well-known open source
technologies and standards based protocols. The architecture consists of
client interfaces and server components that can be ran in a single node
configuration or deployed across multiple servers for high availability and
increased scalability.
The architecture includes the following core advantages:
Open source integrations. Linux
.
Uses industry standard open protocols. SMTP, LMTP, SOAP, XML,
IMAP, POP.
Modern technology design. HTML5, J avascript, XML, and J ava.
Horizontal scalability. Each Zimbra mailbox server includes its own
mailbox accounts and associated message store and indexes. Zimbra has
the flexibility to scale both vertically by adding more system resources or
horizontally by adding more servers.
Browser based client interface. Zimbra Web Client gives users easy
access to all the Zimbra Collaboration features.
Browser based administration console.
12 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Core Email, Calendar and Collaboration Functionality
Zimbra Collaboration is an innovative messaging and collaboration application
that offers the following state-of-the-art solutions that are accessed through a
browser based web client.
Intuitive message management, search, tagging, and sharing.
Personal, external, and shared calendar
Personal and shared Address Books and Distribution Lists.
Personal and Shared Task lists.
Zimbra Components
Zimbra architecture includes open-source integrations using industry standard
protocols. The third-party software listed below is bundled with Zimbra
software and installed as part of the installation process. These components
have been tested and configured to work with the software.
J etty, the web application server that Zimbra software runs in.
Postfix, an open source mail transfer agent (MTA) that routes mail
messages to the appropriate Zimbra server
OpenLDAP software, an open source implementation of the Lightweight
Directory Access Protocol (LDAP) that stores Zimbra system
configuration, the Zimbra Global Address List, and provides user
authentication. Zimbra can also work with GAL and authentication services
provided by external LDAP directories such as Active Directory
MariaDB database software
Lucene, an open source full-featured text and search engine
Anti-virus and anti-spam open source components including:
ClamAV, an anti-virus scanner that protects against malicious files
SpamAssassin, a mail filter that attempts to identify spam
Amavisd-new interfaces between the MTA and one or more content
checkers
J ames/Sieve filtering, used to create filters for email
LibreOffice for high-fidelity document preview
Zimbra Collaboration 8.5 Open Source Edition 13
Product Overview
Zimbra Application Packages
Zimbra Collaboration includes the following application packages.
Zimbra Core Includes the libraries, utilities, monitoring tools, and basic
configuration files.
zmconfigd is part of zimbra-core and is automatically
enabled and runs on all systems.
Zimbra LDAP Zimbra Collaboration uses the OpenLDAP software, an
open source LDAP directory server. User authentication,
the Zimbra Global Address List, and configuration
attributes are services provided through OpenLDAP. Note
that the Zimbra GAL and authentication services can be
provided by an external LDAP Directory such as Active
Directory.
Zimbra MTA Postfix is the open source mail transfer agent (MTA) that
receives email via SMTP and routes each message to the
appropriate Zimbra mailbox server using Local Mail
Transfer Protocol (LMTP).
The Zimbra MTA also includes the anti-virus and anti-
spam components.
Zimbra store
(mailbox server)
For a description of the Zimbra store, see the Zimbra
Mailbox Serverchapter.
Zimbra-SNMP Zimbra uses swatch to watch the syslog output to
generate SNMP traps.
Zimbra-Logger The Zimbra logger installs tools for syslog aggregation,
reporting. If the Logger is not installed, the server statistics
section of the administration console is not displayed.
Zimbra-Spell Aspell is the open source spell checker used on the
Zimbra Web Client. When zimbra-spell is installed, the
Zimbra-Apache package is also installed.
Zimbra-Proxy Zimbra Proxy is a high-performance reverse proxy
service for passing IMAP[S]/POP[S]/HTTP[S] client
requests to other internal ZCS services.
1 Inbound Internet mail goes through a firewall and load balancing to the
edge MTA for spam filtering.
2 The filtered mail then goes through a second load balancer.
3 An external user connecting to the messaging server also goes through a
firewall to the second load balancer.
4 The inbound Internet mail goes to any of the Zimbra MTA servers and goes
through spam and virus filtering.
5 The designated Zimbra MTA server looks up the addressees directory
information from the Zimbra LDAP replica server.
14 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra System Directory Tree
The following table lists the main directories created by the Zimbra installation
packages.
The directory organization is the same for any server in the Zimbra
Collaboration, installing under /opt/zimbra.
Note: The directories not listed in this table are libraries used for building the
core Zimbra software or miscellaneous third-party tools.
6 After obtaining the users information from the Zimbra LDAP server, the
MTA server sends the mail to the appropriate Zimbra mailbox server.
7 Internal end-user connections are made directly to any Zimbra mailbox
server, which then obtains the users directory information from Zimbra
LDAP and redirects the user as needed.
8 Server backup can be processed to a mounted disk.
Parent Directory Description
/opt/
zimbra/
Created by all Zimbra Collaboration installation
packages
bin/ Zimbra Collaboration application files, including the
utilities described in Appendix A, Command -Line
Utilities
cdpolicyd Policy functions, throttling
clamav/ Clam AV application files for virus and spam controls
conf/ Configuration information
contrib/ Third-party scripts for conveyance
convertd/ Convert service
cyrus-sasl/ SASL AUTH daemon
data/ Includes data directories for LDAP, mailboxd, postfix,
amavisd, clamav
db/ Data Store
docs/ SOAP txt files and technical txt files
dspam/ DSPAM antivirus
extensions-
extra/
Server extensions for different authentication types
extensions-
network-
extra/
Server extensions for different network version
authentication types
Zimbra Collaboration 8.5 Open Source Edition 15
Product Overview
Web Client Versions
Zimbra offers a standard HTML, advanced J avascript, a mobile client, or touch
client that users can log into to use Zimbra. The web clients include mail,
calendar, address book, and task functionality. Users can select the client to
use when they log in.
httpd/ Contains the Apache Web server. Used for both aspell
and convertd as separate processes
index/ Index store
java/ Contains J ava application files
jetty/ mailboxd application server instance. In this directory,
the webapps/zimbra/skins directory includes the
Zimbra UI theme files
lib/ Libraries
libexec/ Internally used executables
log/ Local logs for Zimbra Collaboration server application
logger/ RRD and SQLite data files for logger services
mariadb/ MariaDB database files
net-snmp/ Used for collecting statistics
openldap/ OpenLDAP server installation, pre-configured to work
with Zimbra Collaboration
postfix/ Postfix server installation, pre-configured to work with
Zimbra Collaboration
redolog/ Contains current transaction logs for the Zimbra
Collaboration server
snmp/ SNMP monitoring files
ssl/ Certificates
store/ Message store
zimbramon/ Contains control scripts and Perl modules
zimlets/ Contains Zimlet zip files that are installed with Zimbra
zimlets-
deployed/
Contains Zimlets that are available with the Zimbra
Web Client
zmstat/ mailboxd statistics are saved as .csv files
Parent Directory Description
16 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Advanced Web Client includes Ajax capability and offers a full set of web
collaboration features. This web client works best with newer browsers
and fast Internet connections.
Standard Web Client is a good option when Internet connections are slow
or users prefer HTML-based messaging for navigating within their mailbox.
Mobile Client (Native Mail Client) is used to configure and sync the Zimbra
mailbox server with the native mail client on a mobile device.
Mobile HTML Client provides mobile access to Zimbra when using the
Standard Web Client version.
When users sign in, they view the advanced Zimbra Web Client, unless they
use the menu on the login screen to change to the standard version. If ZWC
detects the screen resolution to be 800 x 600, users are automatically
redirected to the standard Zimbra Web Client. Users can still choose the
advanced ZWC but see a warning message suggesting the use of the
standard ZWC for better screen view.
When connecting to Zimbra using a mobile web browser, Zimbra automatically
detects and defaults to the Touch Client. To use the Mobile Client, you must
configure your mobile device to sync with the Zimbra server.
Zimbra Collaboration 8.5 Open Source Edition 17
3 Zimbra Mailbox Server
The Zimbra mailbox server is a dedicated server that manages all the mailbox
content, including messages, contacts, calendar, and attachments.
Each Zimbra mailbox server can see only its own storage volumes. Zimbra
mailbox servers cannot see, read, or write to another server.
This chapter includes:
Mailbox Server on page 17
Web Application Server on page 20
Web Application Server Split on page 20
Mailbox Server Logs on page 21
Mailbox Server
Each account is configured on one mailbox server, and this account is
associated with a mailbox that contains email messages, attachments,
calendar, contacts and collaboration files for that account.
Each mailbox server has its own standalone message store, data store, and
index store for the mailboxes on that server. The following is an overview of
each store and their directory location.
Message Store
All email messages are stored in MIME format in the Message Store, including
the message body and file attachments.
The message store is located on each mailbox server under /opt/zimbra/
store by defaut. Each mailbox has its own directory named after its internal
mailbox ID. Mailbox IDs are unique per server, not system-wide.
Messages with multiple recipients are stored as a single-copy on the message
store. On UNIX systems, the mailbox directory for each user contains a hard
link to the actual file.
When Zimbra Collaboration is installed, one index volume and one message
volume are configured on each mailbox server. Each mailbox is assigned to a
permanent directory on the current index volume. When a new message is
delivered or created, the message is saved in the current message volume.
18 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Data Store
The Data Store is a MariaDB database where internal mailbox IDs are linked
with user accounts. All the message metadata including tags, conversations,
and pointers indicate where the messages are stored in the file system. The
MariaDB database files are in /opt/zimbra/db.
Each account (mailbox) resides only on one server. Each server has its own
standalone data store containing data for the mailboxes on that server.
The data store maps the mailbox IDs to the users OpenLDAP
accounts.The primary identifier within the Zimbra Collaboration database
is the mailbox ID, rather than a user name or account name. The mailbox
ID is only unique within a single mailbox server.
Metadata including users set of tag definitions, folders, contacts, calendar
appointments, tasks, Briefcase folders, and filter rules are in the data store
database.
Information about each mail message, including whether it is read or
unread, and which tags are associated is stored in the data store
database.
Index Store
The index and search technology is provided through Apache Lucene. Each
email message and attachment is automatically indexed when the message
arrives. An index file is associated with each account. Index files are in
/opt/zimbra/index.
The tokenizing and indexing process is not configurable by administrators or
users.
Zimbra Collaboration 8.5 Open Source Edition 19
Zimbra Mailbox Server
Message Tokenization
The process is as follows:
1. The Zimbra MTA routes the incoming email to the mailbox server that
contains the accounts mailbox.
2. The mailbox server parses the message, including the header, the body,
and all readable file attachments such as PDF files or Microsoft Word
documents, in order to tokenize the words.
3. The mailbox server passes the tokenized information to Lucene to create
the index files.
Note: Tokenization is the method for indexing by each word. Certain
common patterns, such as phone numbers, email addresses, and
domain names are tokenized as shown in the Message
Tokenization figure.
stanford.edu
stanford.edu
stanford
edu
Word List
documents
words
containing word
word
1
2
3 4
Lucene
Jo Brown <[email protected]>
Brown
[email protected]
@zimbra.com
zimbra
Jo
jb
20 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Web Application Server
The J etty web application server runs web applications (webapps) on any
store server. It provides one or more web application services.
Mailstore Services
Mailstore services provides the back-end access to mailbox/account data.
Webapps for the mailstore include:
Mailstore (mail server) =/opt/zimbra/jetty/webapps/service
Zimlets =/opt/zimbra/jetty/webapps/zimlet
User Interface Services
User Interface services provide front-end user interface access to the mailbox
account data and administration console, including:
Zimbra Web Client =/opt/zimbra/jetty/webapps/zimbra
Zimbra administrator console =/opt/zimbra/jetty/webapps/zimbraAdmin
Zimlets =/opt/zimbra/jetty/webapps/zimlet
Web Application Server Split
The Web Application Server Split functionality provides an option to separate
the mailstore services (mail server) and the user interface services (web client
server).
For example, a web client server running zimbra,zimbraAdmin webapps
serving the static UI content like html/css pages, and mail server running
service webapp serving all the SOAP requests. These servers are running in
split mode.
The Web Application Server Split benefits include:
Splitting the web client server from the mail server makes the
customization process more agile, allowing the roll out of new or updated
web UI customization without having to restart the mail servers. This
means zero down time.
If you want to customize the Zimbra web client or Zimbra administration
console, you can take the web client server offline and run customization
or maintenance, while not having to take down the mail server.
The web client server is completely decoupled from mailbox accounts.
This means any web client server can service any account request.
Installation and Configuration of the Web Application Server Split
For installation and configuration of the Web Application Server Split, see the
Zimbra Collaboration Multi-Server Installation Guide.
Zimbra Collaboration 8.5 Open Source Edition 21
Zimbra Mailbox Server
Mailbox Server Logs
A Zimbra Collaboration deployment consists of various third-party
components with one or more mailbox servers. Each of the components may
generate its own logging output. Local logs are in /opt/zimbra/log.
Selected Zimbra Collaboration log messages generate SNMP traps, which
you can capture using any SNMP monitoring software. See Chapter 12,
Monitoring ZCS Servers.
22 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration 8.5 Open Source Edition #
4 Zimbra LDAP Service
LDAP directory services provide a centralized repository for information about
users and devices that are authorized to use your Zimbra service. The central
repository used for Zimbras LDAP data is the OpenLDAP directory server.
Topics in this chapter include:
LDAP Traffic Flow
Zimbra Collaboration LDAP Schema
Account Authentication
Zimbra Collaboration Objects
Global Address List
Flushing LDAP Cache
The LDAP server is installed when ZCS is installed. Each server has its own
LDAP entry that includes attributes specifying operating parameters. In
addition, a global configuration object sets defaults for any server whose entry
does not specify every attribute.
A subset of these attributes can be modified through the Zimbra administration
console and others through the zmprov CLI utility.
LDAP Traffic Flow
The LDAP Directory Traffic figure shows traffic between the Zimbra-LDAP
directory server and the other servers in the Zimbra Collaboration system. The
Zimbra MTA and the Zimbra Collaboration mailbox server read from, or write
to, the LDAP database on the directory server.
The Zimbra clients connect through the Zimbra server, which connects to
LDAP.
24 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
LDAP Directory Traffic
LDAP Directory Hierarchy
LDAP directories are arranged in an hierarchal tree-like structure with two
types of branches, the mail branches and the config branch. Mail branches are
organized by domain. Entries belong to a domain, such as accounts, groups,
aliases, are provisioned under the domain DN in the directory. The config
branch contains admin system entries that are not part of a domain. Config
branch entries include system admin accounts, global config, global grants,
COS, servers, mime types, and zimlets.
The Zimbra LDAP Hierarchy figure shows the Zimbra LDAP hierarchy. Each
type of entry (object) has certain associated object classes.
Zimbra LDAP Hierarchy
directory server
Zimbra mailbox Zimbra LDAP
Zimbra MTA
edge MTA
DNS
server
Zimbra Command
Line Tools
Zimbra
Clients
cn=zimbra
cn=admins cn=confg cn=servers
dc=com
dc=zimbra
ou=people
uid=jane
Domain Branch
Config Branch
cn=groups
cn=serverteam
cn=global
grants
cn=zimlets
cn=cos
mime
Zimbra Collaboration 8.5 Open Source Edition 25
Zimbra LDAP Service
An LDAP directory entry consists of a collection of attributes and has a
globally unique distinguished name (dn). The attributes allowed for an entry
are determined by the object classes associated with that entry. The values of
the object class attributes determine the schema rules the entry must follow.
An entrys object class that determines what kind of entry it is, is called a
structural object class and cannot be changed. Other object classes are called
auxiliary and may be added to or deleted from the entry.
Use of auxiliary object classes in LDAP allows for an object class to be
combined with an existing object class. For example, an entry with structural
object class inetOrgPerson, and auxiliary object class zimbraAccount, would
be an account. An entry with the structural object class zimbraServer would be
a server in the Zimbra system that has one or more Zimbra packages
installed.
Zimbra Collaboration LDAP Schema
At the core of every LDAP implementation is a database organized using a
schema.
The Zimbra LDAP schema extends the generic schema included with
OpenLDAP software. It is designed to coexist with existing directory
installations.
All attributes and object classes specifically created for Zimbra Collaboration
are prefaced by zimbra., such as, zimbraAccount object class or
zimbraAttachmentsBlocked attribute.
The following schema files are included in the OpenLDAP implementation:
core.schema
cosine.schema
inetorgperson.schema
zimbra.schema
amavisd.schema
dyngroup.schema
nis.schema
Note: You cannot modify the Zimbra schema.
26 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration Objects
Object Description Object class
Accounts Represents an account on the Zimbra
mailbox server that can be logged into.
Account entries are either
administrators or user accounts. The
object class name is zimbraAccount.
This object class extends the
zimbraMailRecipient object class.
All accounts have the following
properties:
A name in the format of
[email protected]
A unique ID that never changes and is
never reused
A set of attributes, some of which are
user-modifiable (preferences) and
others that are only configurable by
administrators
All user accounts are associated with a
domain, so a domain must be created
before creating any accounts.
zimbraAccount
Class of
Service
(COS)
Defines the default attributes an
account has and what features are
allowed or denied. The COS controls
features, default preference settings,
mailbox quotas, message lifetime,
password restrictions, attachment
blocking, and server pools for creation
of new accounts.
zimbraCOS
Domains Represents an email domain such as
example.com or example.org. A
domain must exist before email
addressed to users in that domain can
be delivered.
zimbraDomain
Distribution
Lists
Also known as mailing lists, are used to
send mail to all members of a list by
sending a single email to the list
address.
zimbraDistributionList
Zimbra Collaboration 8.5 Open Source Edition 27
Zimbra LDAP Service
Dynamic
Groups
Are like distribution lists. The difference
is members of a dynamic group are
dynamically computed by a LDAP
search. The LDAP search filter is
defined in an attribute on the dynamic
group entry.
Note: Both distribution lists and
dynamic groups can be used as
grantee or target in the delegated
administrator framework.
zimbraGroup
Servers Represents a particular server in the
Zimbra system that has one or more of
the Zimbra software packages installed.
Attributes describe server configuration
information, such as which services are
running on the server.
zimbraServer
Global
Configurati
on
Specifies default values for the
following objects: server and domain. If
the attributes are not set for other
objects, the values are inherited from
the global settings.
Global configuration values are
required and are set during installation
as part of the Zimbra core package.
These become the default values for
the system.
zimbraGlobalConfig
Alias Represents an alias of an account,
distribution list or a dynamic group. The
zimbraAliasTarget attribute points to
target entry of this alias entry.
zimbraAlias
Zimlet Defines Zimlets that are installed and
configured in Zimbra.
zimbraZimletEntry
Calendar
Resource
Defines a calendar resource such as
conference rooms or equipment that
can be selected for a meeting. A
calendar resource is an account with
additional attributes on the
zimbraCalendarResource object
class.
zimbraCalendarResour
ce
Identity Represents a persona of a user. A
persona contains the users identity
such as display name and a link to the
signature entry used for outgoing
emails. A user can create multiple
personas. Identity entries are created
under the users LDAP entry in the DIT.
zimbraIdentity
Object Description Object class
28 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Account Authentication
Supported authentication mechanisms are Internal, External LDAP, and
External Active Directory. The authentication method type is set on a per-
domain basis. If zimbraAuthMech attribute is not set, the default is to use
internal authentication.
The internal authentication method uses the Zimbra schema running on the
OpenLDAP server.
The zimbraAuthFallbackToLocal attribute can be enabled so that the system
falls back to the local authentication if external authentication fails. The default
is FALSE.
Internal Authentication Mechanism
The internal authentication method uses the Zimbra schema running on the
OpenLDAP directory server. For accounts stored in the OpenLDAP server, the
userPassword attribute stores a salted-SHA1 (SSHA) digest of the users
password. The users provided password is computed into the SSHA digest
and then compared to the stored value.
External LDAP and External AD Authentication Mechanism
External LDAP and external Active Directory authentication can be used if the
email environment uses another LDAP server or Microsoft Active Directory for
authentication and Zimbra-LDAP for all other Zimbra Collaboration-related
transactions. This requires that users exist in both OpenLDAP and in the
external LDAP server.
Data
Source
Represents an external mail source of a
user. Two examples of data source are
POP3 and IMAP. A data source
contains the POP3/IMAP server name,
port, and password for the users
external email account. The data
source also contains persona
information, including the display name
and a link to the signature entry for
outgoing email messages sent on
behalf of the external account. Data
Source entries are created under the
users LDAP entry in the DIT.
zimbraDataSource
Signature Represents a users signature. A user
can create multiple signatures.
Signature entries are created under the
users LDAP entry in the DIT.
zimbraSignature
Object Description Object class
Zimbra Collaboration 8.5 Open Source Edition 29
Zimbra LDAP Service
The external authentication methods attempt to bind to the specified LDAP
server using the supplied user name and password. If this bind succeeds, the
connection is closed and the password is considered valid.
The zimbraAuthLdapURL and zimbraAuthLdapBindDn attributes are required
for external authentication.
zimbraAuthLdapURL attribute ldap://ldapserver:port/ identifies the IP
address or host name of the external directory server, and port is the port
number. You can also use the fully qualified host name instead of the port
number.
For example:
ldap://server1:3268
ldap://exch1.acme.com
If it is an SSL connection, use ldaps: instead of ldap:. The SSL certificate
used by the server must be configured as a trusted certificate.
zimbraAuthLdapBindDn attribute is a format string used to determine
which DN to use when binding to the external directory server.
During the authentication process, the user name starts out in the format:
[email protected]
The user name might need to be transformed into a valid LDAP bind DN
(distinguished name) in the external directory. In the case of Active
Directory, that bind dn might be in a different domain.
Custom Authentication
You can implement a custom authentication to integrate external
authentication to your proprietary identity database. When an authentication
request comes in, Zimbra checks the designated auth mechanism for the
domain. If the auth mechanism is set to custom authentication, Zimbra
invokes the registered custom auth handler to authenticate the user.
To set up custom authentication, prepare the domain for the custom auth and
register the custom authentication handler.
Preparing a domain for custom auth
To enable a domain for custom auth, set the domain attribute, zimbraAuthMet
to custom:{registered-custom-auth-handler-name}.
In the following example, sample is the name that custom authentication is
registered under.
zmprov modifydomain {domain|id} zimbraAuthMech custom:sample.
Register a custom authentication handler.
To register a custom authentication handler, invoke
ZimbraCustomAuth.register [handlerName, handler] in the init method of the
30 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
extension.
Class: com.zimbra.cs.account.ldap.ZimbraCustomAuth
Method: public synchronized static void register [String handlerName,
ZimbraCustomAuth handler]
Definitions
handlerName is the name under which this custom auth handler is
registered to Zimbras authentication infrastructure. This name is set in
the domains zimbraAuthMech attribute of the domain.
handler is the object on which the authenticate method is invoked for
this custom auth handler. The object has to be an instance of
ZimbraCustomAuth (or subclasses of it).
Example
How Custom Authentication Works
When an authentication request comes in, if the domain is specified to use
custom auth, the authenticating framework invokes the authenticate method
on the ZimbraCustomAuth instance passed as the handler parameter to
ZimbraCustomAuth.register ().
The account object for the principal to be authenticated and the clear-text
password entered by the user are passed to ZimbraCustomAuth.authenticate
(). All attributes of the account can be retrieved from the account object.
Kerberos5 Authentication Mechanism
Kerberos5 Authentication Mechanism authenticates users against an external
Kerberos server.
1. Set the domain attribute zimbraAuthMech to kerberos5.
2. Set the domain attribute zimbraAuthKerberos5Realm to the Kerberos5
realm in which users in this domain are created in the Kerberos database.
public class SampleExtensionCustomAuth implements ZimbraExtension {
public void init() throws ServiceException {
/*
* Register to Zimbra's authentication infrastructure
*
* custom:sample should be set for domain attribute zimbraAuthMech
*/
ZimbraCustomAuth.register("sample", new SampleCustomAuth());
}
...
}
Zimbra Collaboration 8.5 Open Source Edition 31
Zimbra LDAP Service
When users log in with an email password and the domain,
zimbraAuthMech is set to kerberos5, the server constructs the Kerberos5
principal by {localpart-of-the-email}@{value-of-
zimbraAuthKerberos5Realm} and uses that to authenticate to the
kerberos5 server.
To specify Kerberos5 for an individual account set the accounts
zimbraForeignPrincipal as kerberos5:{kerberos5-principal}. For example:
kerberos5:[email protected].
Global Address List
The Global Address List (GAL) is a company directory of users, usually within
the organization itself, that is available to all users of the email system. Zimbra
Collaboration uses the company directory to look up user addresses from
within the company.
For each Zimbra Collaboration domain you can configure GAL to use:
External LDAP server
Zimbra Collaboration internal LDAP server
Both external LDAP server and OpenLDAP in GAL searches
The Zimbra Collaboration Web Client can search the GAL. When the user
searches for a name, that name is turned into an LDAP search filter similar to
the following example, where the string %s is the name the user is searching
for.
GAL Attributes in Zimbra Collaboration
The Attributes Mapped to Zimbra Collaboration Contact table maps generic
GAL search attributes to their Zimbra Collaboration contact fields.
LDAP attributes are mapped to GAL entry fields. For example, the LDAP
attribute displayName and cn can be mapped to GAL entry field fullName. The
mapping is configured in the zimbraGalLdapAttrMap attribute.
( | ( cn = %s*) ( sn=%s*) ( gn=%s*) ( mai l =%s*) )
( zi mbr aMai l Del i ver yAddr ess = %s*)
( zi mbr aMai l Al i as=%s*)
( zi mbr aMai l Addr ess = %s*)
Table 1: Attributes Mapped to Zimbra Collaboration Contact
Standard LDAP Attribute
Zimbra Collaboration Contact
Field
co workCountry
company Company
32 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration GAL Search Parameters
GAL is configured on a per-domain basis. To configure the attributes, you can
run the GAL Configuration Wizard from the administration console.
Modifying Attributes
Additions, changes and deletions to the GAL attributes are made through the
Zimbra administration console or from the zmprov CLI utility.
Users can modify attributes for their account in the directory when users
change their options from the Zimbra Web Client, they also modify the
attributes when they change their preferences.
Flushing LDAP Cache
When you modify the following type of entries in the Zimbra LDAP server, you
might need to flush the LDAP cache to make the change available on the
server.
Themes
Locales
givenName/gn firstName
sn lastName
cn fullName
initials initials
l workCity
street, streetaddress workStreet
postalCode workPostalCode
telephoneNumber workPhone
mobile mobile
pager pager
facisimileTelephoneNumber faxNumber
st workState
title jobTitle
mail email
objectClass Not currently mapped
Table 1: Attributes Mapped to Zimbra Collaboration Contact
Standard LDAP Attribute
Zimbra Collaboration Contact
Field
Zimbra Collaboration 8.5 Open Source Edition 33
Zimbra LDAP Service
Account
Groups
COS
Domains
Global configuration
Server
Zimlet configuration
Flush the Cache for Themes and Locales
When you add or change theme (skin) property files and locale resource files
for ZCS on a server, you must flush the cache to make the new content
available.
To flush skins, type zmprov flushCache skin.
To flush locales, type zmprov flushCache locale.
Flush Accounts, Groups, COS, Domains, and Servers
When you modify the account, COS, groups, domain, and server attributes,
the change is effective immediately on the server to which the modification is
done. On the other servers, the LDAP entries are automatically updated after
a period of time if the attributes are cached.
The default ZCS setting to update the server is 15 minutes. The caching
period is configured on local config key.
To change the setting, type
zmlocalconfig ldap_cache_<object>_maxage.
To make changes available immediately, type
zmprov flushCache [account|cos|domain|group|server] [name|id].
If you do not specify a name or ID along with the type, all entries in cache
for that type are flushed and the cache is reloaded.
Note: Some server attributes require a server restart even after the cache is
flushed. For example, settings like bind port or number of processing
threads.
Flush Global Attributes
When you modify global config attributes, the changes are effective
immediately on the server to which the modification is done. On other mailbox
servers, you must flush the cache to make the changes available or restart the
server. LDAP entries for global config attributes do not expire.
Some global config attributes are computed into internal representations only
once per server restart. For efficiency reasons, changes to those attributes are
34 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
not effective until after a server restart, even after the cache is flushed. Also,
some global configuration settings and server settings that are inherited from
global config are only read once at server startup, for example port or number
of processing threads. Modifying these types of attributes requires a server
restart.
To flush the cache for global config changes on all servers:
1. Modify the setting on the local server
zmprov mcf zimbraImapClearTextLoginEnabled TRUE
The change is only effective on the server
zimbra_zmprov_default_soap_server, port zimbra_admin-service_port.
2. Flush the global config cache on all other servers, zmprov flushCache
must be issued on all servers, one at a time. For example:
zmprov s server-2 flushcache config
zmprov s server-3 flushcache config
3. To determine if the action requires a restart
zmprov desc -a <attributename>.
The requiresRestart value is added to the output if a restart is required.
Zimbra Collaboration 8.5 Open Source Edition 35
5 Zimbra Mail Transfer Agent
The Zimbra MTA (Mail Transfer Agent) receives mail via SMTP and routes
each message using Local Mail Transfer Protocol (LMTP) to the appropriate
Zimbra mailbox server.
Topics in this chapter include:
Zimbra MTA Deployment
SMTP Authentication
Anti-Virus and Anti-Spam Protection
Receiving and Sending Mail
The Zimbra MTA server includes the following programs:
Postfix MTA for mail routing, mail relay, and attachment blocking.
Clam AntiVirus for scanning email messages and attachments in email
messages for viruses.
SpamAssassin to identify unsolicited commercial email (spam).
Amavisd-New used as an interface between Postfix and ClamAV /
SpamAssassin.
Zimbra Milter Server which enforces restrictions on which addresses can
send to distribution lists and adds Reply-To and X-Zimbra-DL headers to
messages sent from distribution lists.
Zimbra Policy server can aid in protecting Alias Domains from Backscatter
Spam
In the Zimbra Collaboration configuration, mail transfer and delivery are
distinct functions. Postfix primarily acts as a MTA, and the Zimbra mail server
acts as a Mail Delivery Agent (MDA).
The MTA configuration is stored in LDAP. A configuration script polls the LDAP
directory every two minutes for modifications and updates the Postfix
configuration files with the changes.
Incoming Mail Routing Overview
The Zimbra mailbox server receives the messages from the Zimbra MTA
server an passes them through any filters that have been created.
36 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
The MTA server receives mail via SMTP and routes each mail message to the
appropriate mailbox server using LMTP. As each mail message arrives, its
contents are indexed so that all elements can be searched.
Zimbra MTA Deployment
ZCS includes a precompiled version of Postfix to route and relay mail and
manage attachments. Postfix receives inbound messages via SMTP, performs
anti-virus and anti-spam filtering and hands off the mail messages to the
Zimbra Collaboration server via LMTP.
Postfix also plays a role in transferring outbound messages. Messages
composed from the Zimbra Web Client are sent by the Zimbra server through
Postfix, including messages sent to other users on the same server.
Postfix in a Zimbra Environment
*The Edge MTA can be any edge security solution for mail. You might already
deploy such solutions for functions such as filtering. Some filtering might be
duplicated between an edge MTA and the Zimbra MTA.
Postfix Configuration Files
Zimbra modified the following Postfix files specifically to work with ZCS:
main.cf. Modified to include the LDAP tables. The configuration script in
the Zimbra MTA pulls data from the Zimbra LDAP and modifies the Postfix
configuration files.
master.cf. Modified to use Amavisd-New.
Zimbra MTA
Zimbra mail server
SMTP
LMTP
Storage format
Edge MTA*
Spam and Virus filtering
Message blocking (some types)
Mail routing
Mail relay
Alias/list expansion
Directory services
Alias/list information
Routing to Zimbra hosts
Virus and Spam filtering
(Postfix)
(optional)
Zimbra Collaboration 8.5 Open Source Edition 37
Zimbra Mail Transfer Agent
Important: Do not modify the Postfix configuration files! Changes you make
will be overwritten.
SMTP Authentication
SMTP authentication allows authorized mail clients from external networks to
relay messages through the Zimbra MTA. The user ID and password is sent to
the MTA when the SMTP client sends mail so that the MTA can verify if the
user is allowed to relay mail.
Note: User authentication is provided through the Zimbra LDAP directory
server, or if implemented, through the Microsoft Active Directory Sever.
SMTP Restrictions
You can enable restrictions so that messages are not accepted by Postfix
when non-standard or other disapproved behavior is exhibited by an incoming
SMTP client. These restrictions provide some protection against spam
senders. By default, clients that do not greet with a fully qualified domain
name are restricted. DNS based restrictions are also available.
Important: Understand the implications of these restrictions before you
implement them. You might have to compromise on these checks to
accommodate people outside of your system who have poorly implemented
mail systems.
Sending Non Local Mail to a Different Server
You can configure Postfix to send nonlocal mail to a different SMTP server,
commonly referred to as a relay or smart host.
A common use case for a relay host is when an ISP requires that all your
email be relayed through a designated host, or if you have filtering SMTP
proxy servers.
The relay host setting must not be confused with Web mail MTA setting. Relay
host is the MTA to which Postfix relays non-local email. Webmail MTA is used
by the Zimbra server for composed messages and must be the location of the
Postfix server in the Zimbra MTA package.
Configure Relay MTA for external delivery from the administration console,
Global Settings>MTA page.
Important: Use caution when setting the relay host to prevent mail loops.
38 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Anti-Virus and Anti-Spam Protection
The Amavisd-New utility is the interface between the Zimbra MTA and Clam
AntiVirus (ClamAV) and SpamAssassin scanners.
Anti-Virus Protection
ClamAV software is the virus protection engine enabled for each ZCS server.
The anti-virus software is configured to put messages that have been
identified as having a virus to the virus quarantine mailbox. By default, the
Zimbra MTA checks every two hours for any new anti-virus updates from
ClamAV. You can change this from the administration console, Global
Settings>AS/AV page.
Note: Updates are obtained via HTTP from the ClamAV website.
Scanning Attachments in Outgoing Mail
You can enable real-time scanning of attachments in outgoing emails sent
using the Zimbra Web Client. If enabled, when an attachment is added to an
email, it is scanned using ClamAV prior to sending the message. If ClamAV
detects a virus, it will block attaching the file to the message. By default,
scanning is configured for a single node installation.
To enable using a single node:
zmprov mcf zimbraAttachmentsScanURL clam://localhost:3310/
zmprov mcf zimbraAttachmentsScanEnabled TRUE
To enable in a multi-node environment, one of the MTA nodes needs to be
picked for handling ClamAV scanning. Then enable the following:
zmprov ms <mta server>zimbraClamAVBindAddress <mta server>
zmprov mcf zimbraAttachmentsScanURL clam://<mta server>:3310/
zmprov mcf zimbraAttachmentsScanEnabled TRUE
Anti-Spam Protection
Zimbra uses SpamAssassin to identify unsolicited commercial email (spam)
with learned data stored in either the Berkeley DB database or a MariaDB
database.
Note: For information about how to customize SpamAssassin, see the
Zimbra wiki article SpamAssassin Customizations.
SpamAssassin uses predefined rules as well as a Bayes database to score
messages with a numerical range. Zimbra uses a percentage value to
determine "spaminess" based on a SpamAssassin score of 20 as 100%. Any
message tagged between 33%-75% is considered spam and delivered to the
Zimbra Collaboration 8.5 Open Source Edition 39
Zimbra Mail Transfer Agent
users junk folder. Messages tagged above 75% are always considered spam
and discarded.
By default, Zimbra uses the Berkeley DB database for spam training. You can
also use a MariaDB database.
To use the MariaDB method on the MTA servers, set
zmlocalconfig -e antispam_mariadb_enabled=TRUE
When this is enabled, Berkeley DB database is not enabled.
Note: The DSPAM spam filter is also included with ZCS, but the default is to
not enable DSPAM. You can enable DSPAM by setting the localconfig
attribute amavis_dspam_enabled to TRUE on the MTA servers.
zmlocalconfig -e amavis_dspam_enabled=true
Training the Spam Filter
How well the anti-spam filter works depends on user input to recognize what is
considered spam or ham. The SpamAssassin filter learns from messages that
users specifically mark as spam by sending them to their junk folder or not
spam by removing them from their junk folder. A copy of these marked
messages is sent to the appropriate spam training mailbox.
At installation, a spam/ham cleanup filter is configured on only the first MTA.
The ZCS spam training tool, zmtrainsa, is configured to automatically retrieve
these messages and train the spam filter. The zmtrainsa script empties these
mailboxes each day.
Note: New installs of ZCS limit spam/ham training to the first MTA installed. If
you uninstall or move this MTA, you will need to enable spam/ham
training on another MTA, as one host should have this enabled to run
zmtrainsa --cleanup.
To set this on a new MTA server
zmlocalconfig -e zmtrainsa_cleanup_host=TRUE
Initially, you might want to train the spam filter manually to quickly build a
database of spam and non-spam tokens, words, or short character sequences
that are commonly found in spam or ham. To do this, you can manually
forward messages as message/rfc822 attachments to the spam and non-
spam mailboxes. When zmtrainsa runs, these messages are used to teach the
spam filter. Make sure you add a large enough sampling of messages to get
accurate scores. To determine whether to mark messages as spam at least
200 known spams and 200 known hams must be identified.
SpamAssassins sa-update tool is included with SpamAssassin. This tool
updates SpamAssassin rules from the SA organization. The tool is installed
into /opt/zimbra/zimbramon/bin.
40 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Configure Final Destination for Spam
You can configure Amavis behavior to deal with a spam items final destination
using the zimbraAmavisFinalSpamDestiny attribute. The default is
D_DISCARD (which will not deliver the email to the addressee).
The attributes can be set using:
zmprov mcf " zimbraAmavisFinalSpamDestiny" D_PASS
zmprov ms serverhostname.com D_PASS
Values that can be set include:
D_PASS: Email put into junk folder.
D_BOUNCE: Email is not delivered.
D_REJ ECT: Email returned to sender.
D_DISCARD: Email is not delivered to the addressee.
Setting Up Trusted Networks
The ZCS configuration allows relaying only for the local network, but you can
configure trusted networks that are allowed to relay mail. You set the MTA
trusted networks as a global setting, but you can configure trusted networks as
a server setting. The server setting overrides the global setting.
This can be configured from the administration console.
To set up MTA trusted networks as a global setting, go to the Configure >
Global Settings >MTA page and in the MTA Trusted Networks field enter the
trusted network addresses.
To set up MTA trusted networks on a per server basis, make sure that MTA
trusted networks have been set up as global settings and then go the
Configure >Servers >MTA page and in the MTA Trusted Networks field enter
the trusted network addresses for the server.
Enter the network addresses separated by commas and/or a space. Continue
long lines by starting the next line with space.
Examples of how to type the addresses:
127.0.0.0/8, 168.100.189.0/24
No commas: 127.0.0.0/8 168.100.189.0/24 10.0.0.0/8 [::1]/128
[fe80::%eth0]/64
Enabling a Milter Server
Milter server can be enabled to enforce restrictions on which addresses can
send to distribution lists and add Reply-To and X-Zimbra-DL headers to
messages sent from distribution lists. This can be enabled globally or for
specific servers from the administration console.
Zimbra Collaboration 8.5 Open Source Edition 41
Zimbra Mail Transfer Agent
Note: Only enable a Milter Server on a server where an MTA is running.
To configure globally, enable the milter server from the Configure>Global
Settings>MTA page.
To enable milter server for a specific server, go to the Configure>Servers>
MTA page. You can set milter server bind addresses for individual servers.
Receiving and Sending Mail
The Zimbra MTA delivers the incoming and the outgoing mail messages. For
outgoing mail, the Zimbra MTA determines the destination of the recipient
address. If the destination host is local, the message is passed to the Zimbra
server for delivery. If the destination host is a remote mail server, the Zimbra
MTA must establish a communication method to transfer the message to the
remote host. For incoming messages, the MTA must be able to accept
connection requests from remote mail servers and receive messages for the
local users.
To send and receive email, the MTA must be configured in DNS with both an A
record and an MX Record. For sending mail, the MTA uses DNS to resolve
hostnames and email-routing information. To receive mail, the MX record must
be configured correctly to route messages to the mail server.
You must configure a relay host if you do not enable DNS.
Message Queues
When the Zimbra MTA receives mail, it routes the mail through a series of
queues to manage delivery; incoming, active, deferred, hold, and corrupt.
Internet
Active Deferred
Hold
Incoming
SMTP
Port 25
SMTP
Port 25
Internal
Mail
Mail
Spamassassin ClamAV
Amavisd-N
MTA Queues
Message
Store
42 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
The incoming message queue holds the new mail that has been received.
Each message is identified with a unique file name. Messages are moved to
the active queue when there is room. If there are no problems, message move
through this queue very quickly.
The active message queue holds messages that are ready to be sent. The
MTA sets a limit to the number of messages that can be in the active queue at
any one time. From here, messages are moved to and from the anti-virus and
anti-spam filters before being delivered to another queue.
Messages that cannot be delivered are placed in the deferred queue. The
reasons for the delivery failures are documented in a file in the deferred
queue. This queue is scanned frequently to resend the message. If the
message cannot be sent after the set number of delivery attempts, the
message fails and is bounced back to the original sender. You can choose to
send a notification to the sender that the message has been deferred.
The hold message queue keeps mail that could not be processed. Messages
stay in this queue until the administrator moves them. No periodic delivery
attempts are made for messages in the hold queue.
The corrupt queue stores damaged unreadable messages.
You can monitor the mail queues for delivery problems from the administration
console. See Chapter 12, Monitoring ZCS Servers.
Zimbra Collaboration 8.5 Open Source Edition 43
6 Zimbra Proxy Server
Note: This chapter has been updated. See www.zimbra.com for the latest
revision of the Zimbra Collaboration Administrator Guide.
Zimbra Proxy is a high-performance proxy server that can be configured as a
POP3/IMAP/HTTP proxy used to reverse proxy IMAP/POP3 and HTTP client
requests to a set of backend servers.
The Zimbra Proxy package is installed and configured during the Zimbra
Collaboration installation. You can install this package on a mailbox server,
MTA server, or on its own independent server. When the Zimbra Proxy
package is installed, the proxy feature is enabled. In most cases, no
modification is necessary.
Topics in this chapter include:
Proxy Components
Proxy Architecture and Flow
Change the Zimbra Proxy Configuration
Zimbra Proxy
Configure Zimbra HTTP Proxy
Configure Zimbra Proxy for Kerberos Authentication
Proxy Components
Zimbra Proxy components include:
Zimbra Nginx. An IMAP/POP3/HTTP proxy server that handles all incoming
IMAP/POP3/HTTP requests.
Memached. A distributed memory object caching system. Route
information is cached for further use to increase performance.
Zimbra Proxy Route Lookup Handler. Servlet that handles queries for the
user account route information.
Proxy Architecture and Flow
The following sequence describes the architecture and flow of Zimbra Proxy.
44 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
1. End clients connect to Zimbra Proxy using a POP/IMAP/HTTP requests to
a backend server. Nginx handles the incoming POP/IMAP/HTTP requests.
2. When Zimbra Proxy receives an incoming connection, Nginx sends an
HTTP request to the Route Lookup Handler, a servlet located on the
mailbox server. this servlet processes the server and port information of
the user account.
3. The Route Lookup Handler locates the route information for the account
and returns this information to Nginx.
4. The Memcached component stores the route information for a configured
period of time. By default, this time is one hour. Nginx uses this route
information until the time expires, instead of querying the Route Lookup
Handler.
5. Nginx uses the route information to connect to Zimbra Mailbox.
6. Zimbra Proxy connects to Zimbra Mailbox and initiates the mail proxy
session. The end client behaves as if it is connecting directly to Zimbra
Mailbox.
Change the Zimbra Proxy Configuration
When Zimbra proxy is configured, the Zimbra proxy config performs keyword
substitution as necessary with values from the Zimbra LDAP configuration and
localconfig.
If changes are required after the Zimbra Proxy is set up, modify the Zimbra
LDAP attributes or localconfig values and run zmconfigd to generate the
updated Zimbra Proxy configuration. The Zimbra proxy configuration file is in /
opt/zimbra/conf/nginx.conf. The nginx.conf includes the main config,
memcache config, mail config, and web config files.
Common changes to Zimbra Proxy configuration are IMAP/POP configuration
changes from the original default setup
HTTP reverse proxy configuration changes from the original default setup
GSSAPI authentication for Kerberos. In this case you manually identify the
location of the Kerberos Keytab file, including Zimbra Proxy password
Zimbra Proxy
Zimbra Proxy allows end users to access their Zimbra Collaboration account
using end clients such as Microsoft Outlook, Mozilla Thunderbird, or other
POP/IMAP end-client software. End users can connect using POP3, IMAP,
POP3S (Secure POP3), or IMAPS (Secure IMAP).
For example, proxying allows users to enter imap.example.com as their IMAP
server. The proxy running on imap.example.com inspects their IMAP traffic,
does a lookup to determine which backend mailbox server a users mailbox
Zimbra Collaboration 8.5 Open Source Edition 45
Zimbra Proxy Server
lives on and transparently proxies the connection from users IMAP client to
the correct mailbox server.
Zimbra Proxy Ports for POP and IMAP
The following ports are used either by Zimbra Proxy or by Zimbra Mailbox. If
you have any other services running on these ports, turn them off.
End clients connect directly to Zimbra Proxy, using the Zimbra Proxy Ports.
Zimbra Proxy connects to the Route Lookup Handler or Zimbra Mailbox using
the Zimbra Mailbox Ports.
Setting Up IMAP and POP Proxy After HTTP Proxy Installation
Zimbra IMAP proxy is installed with Zimbra Collaboration and set up during
installation from the configuration menus. To set up the HTTP proxy, Zimbra
proxy must be installed on the identified proxy nodes in order to set up HTTP
proxy. No other configuration is usually required.
If you need to set up IMAP/POP proxy after you have already installed Zimbra
HTTP proxy, and set up the Zimbra mailbox server and the proxy node.
Note: You can run the command as zmproxyconfig -r, to run against a remote
host. This requires the server to be properly configured in the LDAP
master.
Set Up IMAP/POP Proxy with Separate Proxy Node
If your configuration includes a separate proxy server, you must do the
following.
1. On each Zimbra mailbox server that you want to proxy with, enable the
proxy for IMAP/POP proxy.
/opt/zimbra/libexec/zmproxyconfig -e -m -H mailbox.node.service.hostname
Zimbra Proxy Ports Port
POP3 110
POP3S (Secure POP3) 995
IMAP 143
IMAPS (Secure IMAP) 993
Zimbra Mailbox Ports Port
Route Lookup Handler 7072
POP3 Proxy 7110
POP3S Proxy 7995
IMAP Proxy 7143
IMAPS Proxy 7993
46 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
This configures the following:
zimbraImapBindPort to 7143
zimbraImapProxyBindPort to 143
zimbraImapSSLBindPort to 7993
zimbraImapSSLProxyBindPort to 993
zimbraPop3BindPort to 7110
zimbraPop3ProxyBindPort to110
zimbraPop3SSLBindPort to 7995
zimbraPop3SSLProxyBindPort to 995
zimbralmapCleartextLoginEnabled to TRUE
zimbraReverseProxyLookupTarget to TRUE
zimbraPop3CleartextLoginEnabled to TRUE
2. Restart services on the proxy and mailbox servers.
zmcontrol restart
Set Up Proxy Node
1. On each proxy node that has the proxy service installed, enable the proxy
for the web.
/opt/zimbra/libexec/zmproxyconfig -e -m -H proxy.node.service.hostname
This configures the following:
zimbraImapBindPort to 7143
zimbraImapProxyBindPort to 143
zimbraImapSSLBindPort to 7993
zimbraImapSSLProxyBindPort to 993
zimbraPop3BindPort to 7110
zimbraPop3ProxyBindPort to110
zimbraPop3SSLBindPort to 7995
zimbraPop3SSLProxyBindPort to 995
zimbraReverseProxyMailEnabled to TRUE
Set Up a Single Node
If Zimbra proxy is installed with Zimbra Collaboration on the same server, do
the following.
1. Enable the proxy for the web.
Zimbra Collaboration 8.5 Open Source Edition 47
Zimbra Proxy Server
/opt/zimbra/libexec/zmproxyconfig -e -m -H mailbox.node.service.hostname
This configures the following:
zimbraImapBindPort to 7143
zimbraImapProxyBindPort to 143
zimbraImapSSLBindPort to 7993
zimbraImapSSLProxyBindPort to 993
zimbraPop3BindPort to 7110
zimbraPop3ProxyBindPort to110
zimbraPop3SSLBindPort to 7995
zimbraPop3SSLProxyBindPort to 995
zimbraImapCleartextLoginEnabled to TRUE
zimbraReverseProxyLookupTarget to TRUE
zimbraPop3CleartextLoginEnabled to TRUE
zimbraReverseProxyMailEnabled to TRUE
2. Restart services on the proxy and mailbox servers.
zmcontrol restart
Configure Zimbra HTTP Proxy
Zimbra Proxy can also reverse proxy HTTP requests to the right back-end
server.
For example, users can use a web browser to connect to the proxy server at
http://mail.example.com. The connection from users whose mailboxes live on
mbs1. example.com is proxied to mbs1.example.com by the proxy running on
the mail.example.com server,. REST and CalDAV clients, Zimbra Connector
for Outlook, Zimbra Connector for BES, and Zimbra Mobile Sync devices are
also supported by the proxy.
Note: When ZCB is configured in Zimbra Collaboration, the proxy
configuration must be changed from the directions here. See the
Zimbra wiki article
Installing Blackberry Enterprise Server in a Zimbra Proxy Environment
at http://wiki.zimbra.com/wiki/
Installing_Blackberry_Enterprise_Server_%28ZCB/
BES%29_in_a_Zimbra_Proxy_Environment.
HTTP reverse proxy routes requests as follows:
48 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
If the requesting URL can be examined to determine the user name, then
the request is routed to the backend mailbox server of the user in the URL.
REST, CalDAV, and Zimbra Mobile Sync are supported through this
mechanism.
If the request has an auth token cookie (ZM_AUTH_TOKEN), the request is
routed to the backend mailbox server of the authenticated user.
If the above methods do not work, the IP hash method is used to load
balance the requests across the backend mailbox servers which are able
to handle the request or do any necessary internal proxying.
Setting Up HTTP Proxy
To set up HTTP proxy, Zimbra Proxy must be installed on the identified nodes.
Note: You can run the command as /opt/zimbra/libexec/zmproxyconfig -r, to
run against a remote host. Note that this requires the server to be
properly configured in the LDAP master.
Set Up HTTP Proxy as a Separate Proxy Node
When your configuration includes a separate proxy server follow these steps.
1. On each Zimbra mailbox server that you want to proxy with, enable the
proxy for the web.
/opt/zimbra/libexec/zmproxyconfig -e -w -H mailbox.node.service.hostname
This configures the following:
zimbraMailReferMode to reverse-proxied. See Note below.
zimbraMailPort to 8080, to avoid port conflicts.
zimbraMailSSLPort to 8443, to avoid port conflicts.
zimbraReverseProxyLookupTarget to TRUE
zimbraMailMode to http. This is the only supported mode.
2. Restart services on the proxy and mailbox servers.
zmcontrol restart
3. Configure each domain with the public service host name to be used for
REST URLs, email, and Briefcase folders.
zmprov modifyDomain <domain.com>zimbraPublicServiceHostname
<hostname.domain.com>
Set Up Proxy Node
1. On each proxy node that has the proxy service installed, enable the proxy
for the web.
Zimbra Collaboration 8.5 Open Source Edition 49
Zimbra Proxy Server
/opt/zimbra/libexec/zmproxyconfig -e -w -H proxy.node.service.hostname
This configures the following:
zimbraMailReferMode to reverse-proxied. See Note below.
zimbraMailProxyPort to 80, to avoid port conflicts.
zimbraMailSSLProxyPort to 443, to avoid port conflicts.
zimbraReverseProxyHttpEnabled to TRUE to indicate that Web proxy is
enabled.
zimbraReverseProxyMailMode defaults to HTTP.
To set the proxy server mail mode, add the -x option to the command with the
specific mode: http, https, both, redirect, mixed.
Set Up a Single Node for HTTP Proxy
If Zimbra proxy is installed along with ZCS on the same server, follow this
step.
1. On each zimbra mailbox server that you want to proxy with, enable the
proxy for the web.
/opt/zimbra/libexec/zmproxyconfig -e -w -H mailbox.node.service.hostname
This configures the following:
zimbraMailReferMode to reverse-proxied. See Note below.
zimbraMailPort to 8080, to avoid port conflicts.
zimbraMailSSLPort to 8443, to avoid port conflicts.
zimbraReverseProxyLookupTarget to TRUE
zimbraMailMode to http. This is the only supported mode.
zimbraMailProxyPort to 80, to avoid port conflicts.
zimbraMailSSLProxyPort to 443, to avoid port conflicts.
zimbraReverseProxyHttpEnabled to TRUE to indicate that Web proxy is
enabled.
zimbraReverseProxyMailMode defaults to HTTP.
To set the proxy server mail mode, add the -x option to the command with
the specific mode: http, https, both, redirect, mixed.
2. Restart services on the proxy and mailbox servers.
zmcontrol restart
Configure each domain with the public service host name to be used for
REST URLs, email and Briefcase folders.
zmprov modifyDomain <domain.com>zimbraPublicServiceHostname
<hostname.domain.com>
50 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Set Up Proxy to use Clear Text for Upstream Connections
When setting up the proxy to use clear text for upstream connections, set
zimbraReverseProxySSLToUpstreamEnabled to FALSE.
This attribute defaults to TRUE. In an "out of the box" proxy set up, the
upstream communication defaults to SSL.
REST URL Generation
For REST URL, you set the host name, service protocol, and services port
globally or for a specific domain from the following attributes.
zimbraPublicServiceHostname
zimbraPublicServiceProtocol
zimbraPublicServicePort
When generating REST URLs:
If domain.zimbraPublicServiceHostname is set, use
zimbraPublicServiceProtocol +zimbraPublicServiceHostname +
zimbraPublicServicePort
Otherwise it falls back to the server (account's home server) attributes:
- protocol is computed from server.zimbraMailMode
- hostname is server.zimbraServiceHostname
- port is computed from the protocol.
Note: Why use zimbraMailReferMode - In earlier versions, a local config
variable called zimbra_auth_always_send_refer determined which
action the back-end server took when a users mailbox did not reside
on the server that the user logged in to. The default value of FALSE
redirected the user if the user was logging in on the wrong backend
host.
On a multiserver ZCS, if a load balanced name was needed to create a
friendly landing page, a user would always have to be redirected. In that case,
zimbra_auth_always_send_refer was set to TRUE.
Now with a full-fledged reverse proxy, users do not need to be redirected. The
localconfig variable zimbraMailReferMode is used with nginx reverse proxy.
Set Proxy Trusted IP Addresses
When a proxy is configured with ZCS, each proxy servers IP address must be
configured in LDAP attribute zimbraMailTrustedIP to identify the proxy
addresses as trusted when users log in through the proxy. The proxy IP
address is added to the X-Forwarded-For header information. The X-
Forwarded-For header is automatically added to the localconfig
zimbra_http_originating_ip_header attribute. When a user logs in, this IP
address and the users address are verified in the Zimbra mailbox log.
Zimbra Collaboration 8.5 Open Source Edition 51
Zimbra Proxy Server
Set each proxy IP address in the attribute. For example, if you have two proxy
servers:
zmprov mcf +zimbraMailTrustedIP {IP of nginx-1} +zimbraMailTrustedIP {IP of
nginx-2}
Note: To verify that X-Forwarded-For was correctly added to the localconfig,
type zmlocalconfig | grep -i http. You should see zimbra_http
originating_ip_header = X-Forwarded-For.
Configure Zimbra Proxy for Kerberos Authentication
If you use the Kerberos5 authenticating mechanism, you can configure it for
the IMAP and POP proxy.
Note: Make sure that your Kerberos5 authentication mechanism is correctly
configured. See Chapter 4, Zimbra LDAP Service.
1. On each proxy node, set the zimbraReverseProxyDefaultRealm server
attribute to the realm name corresponding to the proxy server. For
example:
zmprov ms [DNS name.isp.net] zimbraReverseProxyDefaultRealm [ISP.NET]
2. Each proxy IP address where email clients connect must be configured for
GSSAPI authentication by the mail server. On each proxy node for each of
the proxy IP addresses:
zmprov mcf +zimbraReverseProxyAdminIPAddress [IP address]
3. On each proxy server:
zmprov ms [proxyexample.net] zimbraReverseProxyImapSaslGssapiEnabled
TRUE
zmprov ms proxyl.isp.net zimbraReverseProxyPop3SaslGssapiEnabled TRUE
4. Restart the proxy server
zmproxyctl restart
52 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration 8.5 Open Source Edition 53
7 Using the Administration Console
The Zimbra administration console is a browser-based user interface that
allows you to centrally manage Zimbra servers and user accounts.
Topics in this chapter include:
Administrator Accounts
Log in to the Administration Console
Message of the Day for Administrators
Zimbra Search
Administrator Accounts
When you installed Zimbra Collaboration, one global administrator account is
created. Global administrator can log into the administration console to
manage accounts and server configurations. Additional administrator
accounts can be created. All administrator accounts have equal privileges.
To give administrator privileges to an account, check the Global Administrator
box on the General Information page in the users account.
Change Administrator Passwords
The first global administrator password is created at installation. You can
change the password at any time.
From the admin console Accounts, select the admin account and change
the password.
From the CLI, type zmprov sp [email protected] password
Log in to the Administration Console
1. To start the console in a typical installation, use the following URL pattern.
https://server.domain.com:7071/
Where server.domain.com is the current running Zimbra server name or IP
address and 7071 is the default HTTP listen port.
2. Enter the complete administrator address as [email protected] and the
password.The initial password is configured when Zimbra Collaboration is
installed.
54 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Managing Tasks
You can manage most of the ZCS tasks from the administration console, This
includes creating accounts, setting up COSs, monitoring server status, adding
and removing domains, scheduling backup sessions, and more.
When you are working in the administration console to configure or edit an
item, you can click on the text labels on the configuration pages to see which
zimbra attribute is associated with the field you are configuring.
There are some configuration and maintenance tasks that you cannot perform
from the administration console, such as starting and stopping services and
managing the local server configuration. You perform these tasks with the CLI.
Message of the Day for Administrators
Global administrators can create messages of the day (MOTD) that
administrators view when logging into the administration console.
Every time the administrator logs in the message displays at the top left of the
administration console. The message can be closed, replaced, or removed.
Example of a Message of the Day
Create a Message of the Day
To create a message globally or for a specific domain (the quotes must be
used):
zmprov md domainexample.com zimbraAdminConsoleLoginMessage message
to display
To create more than one message to display, run the command again to
create additional messages, but add a plus sign (+) before the attribute:
zmprov md domainexample.com +zimbraAdminConsoleLoginMessage second
message to display
Remove a Message of the Day
To remove a specific message, type the attribute, adding a minus sign (-)
before the attribute and type the message:
zmprov md domainexample.com -zimbraAdminConsoleLoginMessage message
to display
Zimbra Collaboration 8.5 Open Source Edition 55
Using the Administration Console
To remove all messages, type the attribute and add a single quote at the
end:
zmprov md domainexample.com zimbraAdminConsoleLoginMessage
Zimbra Search
You can use the search field on the administration console header to search
for items by accounts, distribution lists, aliases, domains, or class of service or
you can search through all object types.
If you do not know the complete name, you can enter a partial name. Partial
names can result in a list that has the partial name string anywhere in the
information. You can also use the Zimbra mailbox ID number to search for an
account. To return a search from a mailbox ID, the complete ID string must be
entered in the search.
In the search options section of the Search>Navigation pane you can create a
more specific search The following search options open as individual search
panes to let you select the criteria for the search.
You can also use the unified search from the Help link drop-down to find
answers to common questions. When you use this search, the Zimbra wiki,
forums and documents are searched. The results are displayed in a new
window with links to the information.
Saved Searches section by default includes predefined common search
queries. You can also create and save your own queries. After you enter the
query syntax, click Save Search and give the search a name. The search is
added to the Saved Searches section.
Option Description
Basic Attributes Search for a user by first name, last name,
display name or account ID number. You can
search for administrators or delegated
administrators only.
Status Search for accounts by status: Active, closed
Locked, Lockout, Pending, Maintenance
Last Login Time Search for accounts by the last login time. You
can specify a data range to search.
External Email Address Search for an account with an external email
address.
COS Search for objects by COS or for objects that are
not assigned a COS.
Server Search for accounts on selected servers.
Domains Search for accounts on selected domains.
56 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration 8.5 Open Source Edition 57
8 Managing Configuration
The ZCS components are configured during the initial installation of the
software. After the installation, you can manage the following components
from either the administration console or using the CLI utility.
Topics in this chapter include:
Global Configuration
Working With Domains
Managing Server Settings
Managing SSL Certificates for ZCS
Using DKIM to Authenticate Email Message
Anti-spam Settings
Anti-virus Settings
Zimbra Free/Busy Calendar Scheduling
Storage Management
Email Retention Management
Customized Admin Extensions
Help is available from the administration console about how to perform tasks
from the administration console. If the task is only available from the CLI, see
Zimbra CLI Commands for a description of how to use the CLI utility.
Global Configuration
Global Settings apply to all accounts in the Zimbra servers. They are initially
set during installation. You can modify the settings from the administration
console.
Configurations set in Global Settings define inherited default values for the
following objects: server, account, COS, and domain. If these attributes are
set in the server, the server settings override the global settings.
To configure global settings, go to the administration console Configure >
Global Settings page.
Configured global settings include:
Default domain
58 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Maximum number of results returned for GAL searches. The default is
100.
Setting how users view email attachments and what type of attachments
are not allowed
Configuring authentication process, setting the Relay MTA for external
delivery, enabling DNS lookup and protocol checks
Set the spam check controls and anti-virus options for messages received
that may have a virus
Set up free/busy scheduling across a mix of Zimbra Collaboration servers
and third party email servers
Customize themes color scheme and add your logo to the themes
Configure the company name that displays when external guests log on to
see a shared Briefcase folder
General Global Settings
The General Information page includes the following settings.
Option Description
Most results returned by
GAL search
The maximum number of GAL results returned
from a user search. The default is 100.
Default domain Domain that users logins are authenticated
against.
Number of scheduled tasks
that can run simultaneously
Number of threads used to fetch content from
remote data sources. The default is 20. If set too
low, users do not get their mail from external
sources pulled down often enough. If set too high,
the server may be consumed with downloading
this mail and not servicing main user requests.
Sleep time between subse-
quent mailbox purges
The duration of time that the server should rest
between purging mailboxes. By default, message
purge is scheduled to run every 1 minute.
Note: If the message purge schedule is
set to 0, messages are
not purged, even if the mail, trash
and spam message life
time is set.
Zimbra Collaboration 8.5 Open Source Edition 59
Managing Configuration
Setting Up Email Attachment Rules
Global email attachment settings allow you to specify global rules for handling
attachments to an email message. You can also set rules by COS and for
individual accounts. When attachment settings are configured in Global
Settings, the global rule takes precedence over COS and Account settings.
The following attachment setting options can be configured from the Global
Settings Advanced page. To set by COS or account, go to their Advanced
page, Attachment Settings section.
Blocking Email Attachments by File Type
You can also reject messages with certain types of files attached. You select
which file types are unauthorized from the Common extensions list. You can
also add other extension types to the list. Messages with those type of files
attached are rejected. By default the recipient and the sender are notified that
the message was blocked. If you do not want to send a notification to the
recipient when messages are blocked, you can disable this option from the
Global Settings>Attachments page.
Global MTA Settings
The Global Settings>MTA page is used to enable or disable authentication
and configure a relay hostname, the maximum message size, enable DNS
lookup, protocol checks, and DNS checks.
Maximum size of an
uploaded file for Briefcase
files (kb)
The maximum size of a file that can be uploaded
into Briefcase. Note: the maximum message size
for an email message and attachments that can
be sent is configured in the Global Settings MTA
page
Admin help URL and Dele-
gated admin help URL
If you do not want to use the ZCS Help, you can
designate the URL that is linked from the
administration console Help
Option Description
Attachments cannot be
viewed regardless of COS
Users cannot view any attachments. This global
setting can be set to prevent a virus outbreak
from attachments, as no mail attachments can be
opened.
Attachments are viewed
according to COS
This global setting states the COS sets the rules
for how email attachments are viewed
Option Description
60 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Authentication Authentication should be enabled, to support mobile
SMTP authentication users so that their email client
can talk to the Zimbra MTA.
TLS authentication only forces all SMTP auth to use
Transaction Level Security to avoid passing
passwords in the clear.
Network Web mail MTA Host name and Web mail MTA Port. The
MTA that the web server connects to for sending
mail. The default port number is 25.
The Relay MTA for external delivery is the relay host
name. This is the Zimbra MTA to which Postfix relays
non-local email.
If your MX records point to a spam-relay or any other
external non-Zimbra server, enter the name of that
server in the Inbound SMTP host name field. This
check compares the domain MX setting against the
zimbraInboundSmtpHostname setting, if set. If this
attribute is not set, the domain MX setting is checked
against zimbraSmtpHostname.
MTA Trusted Networks. Configure trusted networks
that are allowed to relay mail. Specify a list of network
addresses, separated by commas and/or a space.
If Enable DNS lookups is checked, the Zimbra MTA
makes an explicit DNS query for the MX record of the
recipient domain. If this option is disabled, set a relay
host in the Relay MTA for external delivery.
If Allow domain administrators to check MX records
from Admin Console is checked, domain
administrators can check the MX records for their
domain.
Milter Server If Enable Milter Server is checked, the milter enforces
the rules that are set up for who can send email to a
distribution list.
Archiving
Configuration
If you installed the Archiving feature, you can enable
it here.
Messages Set the Maximum messages size for a message and
its attachments that can be sent. Note: To set the
maximum size of an uploaded file to Briefcase, go to
the General Information page.
You can enable the X-Originating-IP header to
messages checkbox. The X-Originating-IP header
information specifies the original sending IP of the
email message the server is forwarding.
Zimbra Collaboration 8.5 Open Source Edition 61
Managing Configuration
Global IMAP and POP Settings
IMAP and POP access can be enabled as a global setting on the Global
Settings>IMAP or POP pages or by editing a servers IMAP or POP pages.
When you make changes to the IMAP or POP settings, you must restart
Zimbra Collaboration before the changes take effect.
IMAP and POP3 polling intervals can be set from the administration console
COS Advanced page. The default is to not set the polling interval.
Note: If IMAP/POP proxy is set up, making sure that the port
numbers are configured correctly.
With POP3, users can retrieve their mail stored on the Zimbra server and
download new mail to their computer. The users POP configuration in their
Preference>Mail page determines how their messages are downloaded and
saved.
Working With Domains
One domain is identified during the installation process. You can add domains
after installation. From the administration console you can manage the
following domain features.
Global Address List
Authentication
Virtual hosts for the domain to establish a default domain for a user login
Public service host name that is used for REST URLs, commonly used in
sharing.
Maximum number of accounts that can be created on the domain
Free/Busy Interop settings for use with Microsoft Exchange.
Policy Service
Checks
Customize zimbraMtaRestriction (restrictions to reject
some suspect SMTP clients).
Protocol checks To reject unsolicited commercial email (UCE), for
spam control.
DNS checks To reject mail if the clients IP address is unknown,
the hostname in the greeting is unknown, or if the
senders domain is unknown.
Add other email recipient restrictions to the List of
RBLs field.
Note: RBL (Real time black-hole lists) can be turned on
or off from the Zimbra CLI.
62 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Domain SSL certificates
A domain can be renamed and all account, distribution list, alias and resource
addresses are changed to the new domain name. The CLI utility is used to
changing the domain name. See Renaming a Domain.
Note: Domain settings override global settings.
Domain General Information Settings
The Domain>General Information page includes the following options:
The default time zone for the domain. If a time zone is configured in a COS
or for an account, the domain time zone setting is ignored.
Public service host name. Enter the host name of the REST URL. This is
commonly used for sharing. See Setting up a Public Service Host Name.
Inbound SMTP host name. If your MX records point to a spam-relay or any
other external non-Zimbra server, enter the name of the server here.
Default Class of Service (COS) for the domain. This COS is automatically
assigned to accounts created on the domain if another COS is not set.
Domain status. The domain status is active in the normal state. Users can
log in and mail is delivered. Changing the status can affect the status for
accounts on the domain also. The domain status is displayed on the
Domain>General page. Domain status can be set as follows:
Active. Active is the normal status for domains. Accounts can be
created and mail can be delivered. Note: If an account has a different
status setting than the domain setting, the account status overrides the
domain status.
Closed. When a domain status is marked as closed, Login for accounts
on the domain is disabled and messages are bounced. The closed
status overrides an individual accounts status setting.
Locked. When a domain status is marked as locked, users cannot log
in to check their email, but email is still delivered to the accounts. If an
accounts status setting is marked as maintenance or closed, the
accounts status overrides the domain status setting.
Maintenance. When the domain status is marked as maintenance,
users cannot log in and their email is queued at the MTA. If an account
status setting is marked as closed, the accounts status overrides the
domain status setting.
Suspended. When the domain status is marked as suspended, users
cannot log in, their email is queued at the MTA, and accounts and
distribution lists cannot be created, deleted, or modified. If an
accounts status setting is marked as closed, the accounts status
overrides the domain status setting.
Zimbra Collaboration 8.5 Open Source Edition 63
Managing Configuration
Setting up a Public Service Host Name
You can configure each domain with the public service host name to be used
for REST URLs. This is the URL that is used when sharing email folders and
Briefcase folders, as well as sharing task lists, address books, and calendars.
When users share a Zimbra Collaboration folder, the default is to create the
URL with the Zimbra server hostname and the Zimbra service host name. This
is displayed as http://server.domain.com/service/home/username/sharedfolder.
The attributes are generated as follows:
Hostname is server.zimbraServiceHostname
Protocol is determined from server.zimbraMailMode
Port is computed from the protocol
When you configure a public service host name, this name is used instead of
the server/service name, as http://publicservicename.domain.com/home/
username/sharedfolder. The attributes to be used are:
zimbraPublicServiceHostname
zimbraPublicServiceProtocol
zimbraPublicServicePort
You can use another FQDN as long as the name has a proper DNS entry to
point at server both internally and externally.
Global Address List (GAL) Mode
The Global Address List (GAL) is your company-wide listing of users that is
available to all users of the email system. GAL is configured on a per-domain
basis. The GAL mode setting for each domain determines where the GAL
lookup is performed.
The GAL Configuration Wizard in the administration console is used to
configure the GAL attributes. The three GAL modes that can be configured
include the following:
Internal. The Zimbra LDAP server is used for directory lookups.
External. External directory servers are used for GAL lookups. You can
configure multiple external LDAP hosts for GAL. All other directory
services use the Zimbra LDAP service (configuration, mail routing, etc.).
When you configure an external GAL, you can configure different search
settings and sync settings.You might want to configure different search
settings if your LDAP environment is set up to optimize LDAP searching by
setting up an LDAP cache server, but users also will need to be able to
sync to the GAL.
Both. Internal and external directory servers are used for GAL lookups.
64 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Using GAL sync accounts for faster access to GAL
A GAL sync account is created for the domain when an internal or external
GAL is created, and if you have more than one mailbox server, you can create
a GAL sync account for each mailbox server in the domain. Using the GAL
sync account gives users faster access to auto complete names from the
GAL.
When a GAL sync account is created on a server, GAL requests are directed
to the servers GAL sync account instead of the domains GAL sync account.
The GalSyncResponse includes a token which encodes the GAL sync
account ID and current change number. The client stores this and then uses it
in the next GalSyncRequest. Users perform GAL sync with the GAL sync
account they initially sync with. If a GALsync account is not available for some
reason, the traditional LDAP-based search is run.
Note: The GAL sync accounts are system accounts and do not use a Zimbra
license.
When you configure the GAL sync account, you define the GAL datasource
and the contact data is syncd from the datasource to the GAL sync accounts
address books. If the mode Both is selected, an address book is created in the
account for each LDAP data source.
The GAL polling interval for the GAL sync determines how often the GALsync
account syncs with the LDAP server. The sync intervals can be in x days,
hours, minutes, or seconds. The polling interval is set for each data source.
When the GAL sync account syncs to the LDAP directory, all GAL contacts
from the LDAP are added to the address book for that GAL. During the sync,
the address book is updated with new contact, modified contact and deleted
contact information. You should not modify the address book directly. When
the LDAP syncs the GAL to the address book, changes you made directly to
the address book are deleted.
You create GALsync accounts from the administration console. The CLI
associated with this feature is zmgsautil.
Creating Additional GALsync Accounts
When ZCS is configured with more than one server, you can add an additional
GAL sync account for each server.
1. In the administration console, select Configure>Domains.
2. Select the domain to add another GAL sync account.
3. In the gear box, select Configure GAL.
4. Click Add a GAL account.
5. In the GAL sync account name field, enter the name for this account. Do
not use the default name.
Zimbra Collaboration 8.5 Open Source Edition 65
Managing Configuration
6. Select the mailbox server that this account will apply to.
7. Enter the GAL datasource name, If the GAL mode is BOTH, enter the data
source name for both the internal GAL and the external GAL.
8. Set the GAL polling interval to how often the GAL sync account should
sync with the LDAP server to update.
9. Click Finish.
Changing GAL sync account name.
The default name for the GAL sync account is galsync. When you configure
the GAL mode, you can specify another name. After the GAL sync account is
created, you cannot rename the account because syncing the data fails.
To change the account name delete the existing GAL sync account and
configure a new GAL for the domain.
1. In the administration console, select Configure>Domains.
2. Select the domain where you want to change the GAL sync account name.
3. In the gear box, select Configure GAL to open the configuration wizard and
change the GAL mode to internal. Do not configure any other fields. Click
Finish.
4. In the domains account Content pane, delete the domains galsync
account.
5. Select the domain again and select Configure GAL to reconfigure the GAL.
In the GAL sync account name field, enter the name for the account.
Complete the GAL configuration and click Finish. The new account is
displayed in the Accounts Content pane.
Authentication Modes
Authentication is the process of identifying a user or a server to the directory
server and granting access to legitimate users based on user name and
password information provided when users log in. Zimbra Collaboration offers
the following three authentication mechanisms:
Internal. The Internal authentication uses the Zimbra directory server for
authentication on the domain. When you select Internal, no other
configuration is required.
External LDAP. The user name and password is the authentication
information supplied in the bind operation to the directory server. You must
configure the LDAP URL, LDAP filter, and to use DN password to bind to
the external server.
External Active Directory. The user name and password is the
authentication information supplied to the Active Directory server. You
identify the Active Directory domain name and URL.
66 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
The authentication method type is set on a per-domain basis. On the
administration console, you use an authentication wizard to configure the
authentication settings on your domain.
To configure authentication modes, go to the administration console
Configure>Domains, and in the gear box select, Configure Authentication.
Virtual Hosts
Virtual hosting allows you to host more than one domain name on a server.
The general domain configuration does not change. When you create a virtual
host, this becomes the default domain for a user login. Zimbra Web Client
users can log in without having to specify the domain name as part of their
user name.
Virtual hosts are entered on the administration console for a domain on the
Domains>Virtual Hosts page. The virtual host requires a valid DNS
configuration with an A record.
To open the Zimbra Web Client log in page, users enter the virtual host name
as the URL address. For example, https://mail.company.com.
When the Zimbra login screen displays, users enter only their user name and
password. The authentication request searches for a domain with that virtual
host name. When the virtual host is found, the authentication is completed
against that domain.
Renaming a Domain
When you rename a domain you are actually creating a new domain, moving
all accounts to the new domain and deleting the old domain. All account, alias,
distribution list, and resource addresses are changed to the new domain
name. The LDAP is updated to reflect the changes.
Before you rename a domain
Make sure MX records in DNS are created for the new domain name
Make sure you have a functioning and current full backup of the domain
After the domain has been renamed
Update external references that you have set up for the old domain name
to the new domain name. This may include automatically generated
emails that were sent to the administrators mailbox such as backup
session notifications
Immediately run a full backup of the new domain
Rename the domain
zmprov -l rd [olddomain.com] [newdomain.com]
Zimbra Collaboration 8.5 Open Source Edition 67
Managing Configuration
Domain Rename Process
When you run this zmprov command, the domain renaming process goes
through the following steps:
1. The status of the old domain is changed to an internal status of shutdown,
and mail status of the domain is changed to suspended. Users cannot
login, their email is bounced by the MTA, and accounts, calendar
resources and distribution lists cannot be created, deleted or modified.
2. The new domain is created with the status of shutdown and the mail status
suspended.
3. Accounts, calendar resources, distribution lists, aliases, and resources are
all copied to the new domain.
4. The LDAP is updated to reflect the new domain address.
5. The old domain is deleted.
6. The status for the new domain is changed to active. The new domain can
start accepting email messages.
Adding a Domain Alias
A domain alias allows different domain names to direct to a single domain
address. For example, your domain is domain.com, but you want users to
have an address of example.com, you can create example.com as the alias
for the domain.com address. Sending mail to [email protected] is the same
as sending mail to [email protected].
Note: A domain alias is a domain name just like your primary domain name.
You must own the domain name and verify your ownership before you
can add it as an alias.
To add a domain alias, go to the administration console Configure>Domains,
and in the gear box select, Add a Domain Alias.
Enabling Support for Domain Disclaimers
Disclaimers are set per-domain. When upgrading, an existing global
disclaimer is converted to domain specific disclaimers on every domain to
preserve behavior with previous releases.
Per domain disclaimer support can be enabled using the following steps.
1. Create a new domain (e.g. example.com), and account (e.g.
[email protected])
zimbra@server-064:~$ zmprov cd example.com
cb9a4846-6df1-4c18-8044-4c1d4c21ccc5
zimbra@server-064:~$ zmprov ca [email protected] test123
68 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
95d4caf4-c474-4397-83da-aa21de792b6a
zimbra@server-064:~$ zmprov -l gaa
[email protected]
[email protected]
...
2. Enable the use of disclaimers
zimbra@server-064:~$ zmprov mcf zimbraDomainMandatoryMailSignatureEn-
abled TRUE
zimbra@server-064:~$ zmprov gcf
zimbraDomainMandatoryMailSignatureEnabled
zimbraDomainMandatoryMailSignatureEnabled: TRUE
3. Add disclaimers to the new domain
zimbra@server-064:~$ zmprov md qatest.com
zimbraAmavisDomainDisclaimerText "text disclamer"
zimbraAmavisDomainDisclaimerHTML "HTML disclaimer"
zimbra@server-064:~$ zmprov gd qatest.com
zimbraAmavisDomainDisclaimerText zimbraAmavisDomainDisclaimerHTML
#name example.com
zimbraAmavisDomainDisclaimerHTML: HTML disclaimer
zimbraAmavisDomainDisclaimerText: text disclamer
zimbra@server-064:~$ zmprov gd server-064.eng.example.com
zimbraAmavisDomainDisclaimerText zimbraAmavisDomainDisclaimerHTML
#name server-064.eng.example.com
a. On the first MTA:
zimbra@server-064:~$ ./libexec/zmaltermimeconfig -e example.com
Enabled disclaimers for domain: example.comm
Generating disclaimers for domain example.com.
b. On all additional MTAs:
./libexec/zmaltermimeconfig
To test, send an email from the account (e.g. [email protected]) in html
and plain text format,
To verify, check emails received with correct HTML disclaimer and plain
text disclaimer.
To disable for the domain example.com
a. On the first MTA, as the Zimbra user:
./libexec/zmaltermimeconfig -d example.com
b. On all additional MTAs:
./libexec/zmaltermimeconfig
Zimbra Collaboration 8.5 Open Source Edition 69
Managing Configuration
Disable Disclaimers for Intra-domain Emails
You can enable the option for emails between individuals in the same domain
to not have a disclaimer attached.
Set the attribute attachedzimbraAmavisOutboundDisclaimersOnly to TRUE.
To preserve backwards compatibility, this attribute defaults to FALSE.
Disable the Disclaimer Feature
It is possible to completely remove support for disclaimers by setting the
related attribute to FALSE
zmprov mcf zimbraDomainMandatoryMailSignatureEnabled FALSE
Zimlets on the Domain
All Zimlets that are deployed are displayed in the domains Zimlets page. If you
do not want all the deployed Zimlets made available for users on the domain,
select from the list the Zimlets that are available for the domain. This overrides
the Zimlet settings in the COS or for an account.
Managing Server Settings
A server is a machine that has one or more of the Zimbra service packages
installed. During the installation, the Zimbra server is automatically registered
on the LDAP server.
In the administration console, you can view the current status of all the servers
that are configured with Zimbra software, and you can edit or delete existing
server records. You cannot add servers directly to LDAP. The Zimbra
Collaboration Installation program must be used to add new servers because
the installer packages are designed to register the new host at the time of
installation.
The server settings that can be viewed from the admin console, Configure
Servers link for a specific server include:
General information about the service host name, and LMTP advertised
name and bind address, and the number of threads that can
simultaneously process data source imports.
A list of enabled services. You can disable and enable the services.
Authentication types enabled for the server, setting a Web mail MTA
hostname different from global. Setting relay MTA for external delivery,
and enabling DNS lookup if required. Enable the Milter Server and set the
bind address.
Enabling POP and IMAP and setting the port numbers for a server. If
IMAP/POP proxy is set up, making sure that the port numbers are
configured correctly.
Index and message volumes configuration.
70 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
IP Address Bindings. If the server has multiple IP addresses, IP Address
binding allows you to specify which interface to bind to.
Proxy settings if proxy is configured.
Backup and Restore configuration for the server. When backup and
restore is configured for the server, this overrides the global backup and
restore setting.
Servers inherit global settings if those values are not set in the server
configuration. Settings that can be inherited from the Global configuration
include MTA, SMTP, IMAP, POP, anti-virus, and anti-spam configurations.
General Server Settings
The General Information page includes the following configuration information:
Server display name and a description field
Server hostname
LMTP information including advertised name, bind address, and number
of threads that can simultaneously process data source imports. The
default is 20 threads.
Purge setting. The server manages the message purge schedule. You
configure the duration of time that the server should rest between
purging mailboxes from the administration console, Global settings or
Server settings, General Information page. By default, message purge is
scheduled to run every 1 minute.
When installing a reverse proxy the communication between the proxy
server and the backend mailbox server must be in plain text. Checking
This server is a reverse proxy lookup target automatically sets the
following:
zimbraImapCleartextLoginEnabled=TRUE
zimbraReverseProxyLookupTarget=TRUE
zimbraPop3CleartextLoginEnabled=TRUE
The Notes text box can be used to record details you want to save.
Change MTA Server Settings
The MTA page shows the following settings:
Authentication enabled. Enables SMTP client authentication, so users can
authenticate. Only authenticated users or users from trusted networks are
allowed to relay mail. TLS authentication when enabled, forces all SMTP
auth to use Transaction Level Security (similar to SSL) to avoid passing
passwords in the clear.
Network settings, including Web mail MTA hostname, Web mail MTA
timeout, the relay MTA for external delivery, MTA trusted networks ID, and
the ability to enable DNS lookup for the server.
Zimbra Collaboration 8.5 Open Source Edition 71
Managing Configuration
Milter Server. If Enable Milter Server is checked, the milter enforces the
rules that are set up for who can send email to a distribution list on the
server.
Setting Up IP Address Binding
If the server has multiple IP addresses, you can use IP address binding to
specify which specific IP addresses you want a particular server to bind to.
You can configure the following from the administration console, Configure >
Servers, IP Address Binding page.
Managing SSL Certificates for ZCS
A certificate is the digital identity used for secure communication between
different hosts or clients and servers. Certificates are used to certify that a site
is owned by you.
Two types of certificates can be used - self-signed and commercial
certificates.
A self-signed certificate is an identity certificate that is signed by its own
creator.
You can use the Certificate Installation Wizard to generate a new self-
signed certificate. This is useful when you use a self-signed certificate and
want to change the expiration date. The default is 1825 days (5 years).
Self-signed certificates are normally used for testing.
A commercial certificate is issued by a certificate authority (CA) that
attests that the public key contained in the certificate belongs to the
organization (servers) noted in the certificate.
When Zimbra Collaboration Server is installed, the self-signed certificate is
automatically installed and can be used for testing Zimbra Collaboration
Server. You should install the commercial certificate when Zimbra
Collaboration Server is used in your production environment.
Option Description
Web Client Server IP
Address
Interface address on which the HTTP server
listens
Web Client Server SSL IP
Address
Interface address on which the HTTPS server
listens
Web Client Server SSL Cli-
ent Cert IP Address
Interface address on which HTTPS server
accepting the client certificates listen
Admin Console Server IP
Address
Administrator console Interface address on which
HTTPS server listens
72 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Installing Certificates
To generate the CSR, you complete a form with details about the domain,
company, and country, and then generate a CSR with the RSA private key.
You save this file to your computer and submit it to your commercial certificate
authorizer.
To obtain a commercially signed certificate, use the Zimbra Certificates Wizard
in the administration console to generate the RSA Private Key and Certificate
Signing Request (CSR). Go to Home > Certificates and in the gear icon select
Install Certificates. The Certificate Installation Wizard dialog box displays.
You enter the following information in the wizard:
Download the CSR from the Zimbra server and submit it to a Certificate
Authority, such as VeriSign or GoDaddy. They issue a digitally signed
certificate.
When you receive the certificate, use the Certificates Wizard a second time to
install the certificate on the Zimbra Collaboration. When the certificate is
installed, you must restart the server to apply the certificate.
Option Description
Common Name (CN) Exact domain name that should be used to
access your Web site securely.
Are you going to use a wildcard common name?
If you want to manage multiple sub domains on a
single domain on the server with a single
certificate, check this box. An asterisk (*) is added
to the Common Name field.
Country Name (C) County name you want the certificate to display
as our company location
State/Province (ST) State/province you want the certificate to display
as your company location.
City (L) City you want the certificate to display as your
company location.
Organization Name (O) Your company name
Organization Unit (OU) Unit name (if applicable)
Subject Alternative Name
(SAN)
If you are going to use a SAN, the input must be a
valid domain name. When SAN is used, the
domain name is compared with the common
name and then to the SAN to find a match. You
can create multiple SANs. When the alternate
name is entered here, the client ignores the
common name and tries to match the server
name to one of the SAN names.
Zimbra Collaboration 8.5 Open Source Edition 73
Managing Configuration
Viewing Installed Certificates
You can view the details of certificates currently deployed. Details include the
certificate subject, issuer, validation days and subject alternative name. To
view installed certificates, go to Home > Certificates and select a service host
name. Certificates display for different Zimbra services such as LDAP,
mailboxd, MTA and proxy.
Maintaining Valid Certificates
It is important to keep your SSL certificates valid to ensure clients and
environments work properly, as the ZCS system can become non-functional if
certificates are allowed to expire. You can view deployed SSL certificates from
the ZCS administrator console, including their validation days. It is suggested
that certificates are checked periodically, so you know when they expire and to
maintain their validity.
Install a SSL Certificate for a Domain
You can install an SSL certificate for each domain on a Zimbra Collaboration
server. Zimbra Proxy must be installed on Zimbra Collaboration and correctly
configured to support multiple domains. For each domain, a virtual host name
and Virtual IP address are configured with the virtual domain name and IP
address.
Each domain must be issued a signed commercial certificate that attests that
the public key contained in the certificate belongs to that domain.
1. Configure the Zimbra Proxy Virtual Host Name and IP Address.
zmprov md <domain>+zimbraVirtualHostName {domain.example.com}
+zimbraVirtualIPAddress {1.2.3.4}
Note: The virtual domain name requires a valid DNS configuration with an
A record.
2. Go to the administration console and edit the domain. Copy the domains
issued signed commercial certificates and private key files to the
Domain>Certificate page.
3. Copy the root certificate and the intermediate certificates in descending
order, starting with your domain certificate. This allows the full certificate
chain to be validated.
4. Remove any password authentication from the private key before the
certificate is saved.
See your commercial certificate provider for details about how to remove
the password.
5. Click Save.
The domain certificate is deployed to /opt/zimbra/conf/domaincerts
74 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Using DKIM to Authenticate Email Message
Domain Keys Identified Mail (DKIM) defines a domain-level authentication
mechanism that lets your organization take responsibility for transmitting an
email message in a way that can be verified by a recipient. Your organization
can be the originating sending site or an intermediary. Your organizations
reputation is the basis for evaluating whether to trust the message delivery.
You can add a DKIM digital signature to outgoing email messages, associating
the message with a domain name of your organization. You can enable DKIM
signing for any number of domains that are being hosted by ZCS. It is not
required for all domains to have DKIM signing enabled for the feature to work.
DKIM defines an authentication mechanism for email using
A domain name identifier
Public-key cryptography
DNS-based public key publishing service.
The DKIM signature is added to the email message header field. The header
information look like this example.
Receivers who successfully validate a DKIM signature can use information
about the signer as part of a program to limit spam, spoofing, phising, or other
undesirable behavior.
Configure ZCS for DKIM Signing
DKIM signing to outgoing mail is done at the domain level. To set up DKIM you
must run the CLI zmdkimkeyutil to generate the DKIM keys and selector. You
then update the DNS server with the selector which is the public key.
1. Log in to the ZCS server and as zimbra, type
/opt/zimbra/libexec/zmdkimkeyutil -a -d <example.com>
The public DNS record data that must be added for the domain to your
DNS server is displayed. The public key DNS record appears as a DNS
TXT-record that must be added for the domain to your DNS server.
Optional. To specify the number of bits for the new key, include -b in the
command line, -b <####>. If you do not add the -b, the default setting is
1024 bits.
DKIM-Signature a=rsa-sha1; q=dns;
d=example.com;
[email protected];
s=jun2005.eng; c=relaxed/simple;
t=1117574938; x=1118006938;
h=from:to:subject:date;
b=dzdVyOfAKCdLXdJ Oc9G2q8LoXSlEniSb
av+yuU4zGeeruD00lszZVoG4ZHRNiYzR
Zimbra Collaboration 8.5 Open Source Edition 75
Managing Configuration
The generated DKIM data is stored in the LDAP server as part of the
domain LDAP entry.
2. Work with your service provider to update your DNS for the domain with
the DKIM DNS text record.
3. Reload the DNS and verify that the DNS server is returning the DNS
record.
4. To verify that the public key matches the private key, type
/opt/zimbra/opendkim/sbin/opendkim-testkey -d <example.com>-s <0E9F184A-
9577-11E1-AD0E-2A2FBBAC6BCB>-x /opt/zimbra/conf/opendkim.conf
-d is the domain name
-s is the selector name
-x is the configuration file
Update DKIM Data for a Domain
When the DKIM keys are updated, the DNS server must be reloaded with the
new TXT record.
Good practice is to leave the previous TXT record in DNS for a period of time
so that email messages that were signed with the previous key can still be
verified.
1. Log in to the ZCS server and as zimbra, type
/opt/zimbra/libexec/zmdkimkeyutil -u -d <example.com>
Optional. To specify the number of bits for the new key, include -b in the
command line, -b <####>. If you do not add the -b, the default setting is
1024 bits.
2. Work with your service provider to update your DNS for the domain with
the DKIM DNS text record.
3. Reload the DNS and verify that the DNS server is returning the DNS
record.
4. To verify that the public key matches the private key, type
DKI M Dat a added t o LDAP f or domai n exampl e. comwi t h sel ect or
B534F5FC- EAF5- 11E1- A25D- 54A9B1B23156
Publ i c si gnat ur e t o ent er i nt o DNS:
B534F5FC- EAF5- 11E1- A25D- 54A9B1B23156. _domai nkey I N TXT " v=DKI M1;
k=r sa; p=MI Gf MA0GCSqGSI b3DQEBAQUAA4GNADCBi QKBgQC+ycHj GL/
mJ XEVl RZnxZL/ VqaN/
J k9Vl l vI OTkKgwLSFt VsKC69kVaUDDj b3zkpJ 6qpswj j OCO+0eGJ ZFA4aB4BQj FBHbl
97vgNnpJ q1sV3QzRf Hr N8X/
gdhvf KSI wSDFFl 3DHewKDWNcCzBkNf 5wHt 5uj eavz2XogL8Hf eL0bTwI DAQAB" ; - -
- - - DKI M B534F5FC- EAF5- 11E1- A25D- 54A9B1B23156 f or exampl e. com
76 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
/opt/zimbra/opendkim/sbin/opendkim-testkey -d <example.com>-s <0E9F184A-
9577-11E1-AD0E-2A2FBBAC6BCB>-x /opt/zimbra/conf/opendkim.conf
-d is the domain name
-s is the selector name
-x is the configuration file
Remove DKIM Signing from ZCS
Removing DKIM signing deletes the DKIM data from LDAP. New email
message no longer are signed for the domain. When you remove DKIM from
the domain, good practice is to leave the previous TXT record in DNS for a
period of time so that email messages that were signed with the previous key
can still be verified.
1. To remove, type
/opt/zimbra/libexec/zmdkimkeyutil -r -d example.com
Retrieve DKIM Data for a Domain
1. To see the stored DKIM information for the domain, selector, private key,
public signature and identity, type
/opt/zimbra/libexec/zmdkimkeyutil -q -d example.com
Anti-spam Settings
ZCS uses SpamAssassin to control spam. SpamAssassin uses predefined
rules as well as a Bayes database to score messages. Zimbra evaulates
spaminess based on percentage. Messages tagged between 33%-75% are
considered spam and delivered to the users junk folder. Messages tagged
above 75% are not sent to the user and are discarded.
You can change the anti-spam settings from the administration console Global
Settings>AS/AV page.
When a message is tagged as spam, the message is delivered to the
recipients junk folder. Users can view the number of unread messages that
are in their junk folder and can open the junk folder to review the messages
marked as spam. If you have the anti-spam training filters enabled, when
users add or remove messages in the junk folder, their action helps train the
spam filter. See Anti-Spam Protection.
RBL (Real time black-hole lists) can be turned on or off in SpamAssassin from
the Zimbra CLI.
Anti-Spam Training Filters
The automated spam training filter is enabled by default and two feedback
system mailboxes are created to receive mail notification.
Zimbra Collaboration 8.5 Open Source Edition 77
Managing Configuration
Spam Training User for mail that was not marked as spam but should be.
Non-spam (referred to as ham) training user for mail that was marked as
spam but should not have been.
The mailbox quota and attachment indexing is disabled for these training
accounts. Disabling quotas prevents bouncing messages when the mailbox is
full.
How well the anti-spam filter works depends on recognizing what is
considered spam. The SpamAssassin filter learns from messages that users
specifically mark as spam by sending them to their junk folder or not spam by
removing them from their junk folder. A copy of these marked messages is
sent to the appropriate spam training mailbox.
When ZCS is installed, the spam/ham cleanup filter is configured on only the
first MTA. The ZCS spam training tool, zmtrainsa, is configured to
automatically retrieve these messages and train the spam filter. The zmtrainsa
script is enabled through a crontab job to feed mail to the SpamAssassin
application, allowing SpamAssassin to learn what signs are likely to mean
spam or ham. The zmtrainsa script empties these mailboxes each day.
Note: New installs of ZCS limit spam/ham training to the first MTA installed. If
you uninstall or move this MTA, you will need to enable spam/ham
training on another MTA, as one host should have this enabled to run
zmtrainsa --cleanup.
To set this on a new MTA server
zmlocalconfig -e zmtrainsa_cleanup_host=TRUE
Disabling the Spam Training Mailboxes
The ZCS default is that all users can give feedback when they add or remove
items from their junk folder. If you do not want users to train the spam filter you
can disable this function.
1. Modify the global configuration attributes, ZimbraSpamIsSpamAccount and
ZimbraSpamIsNotSpamAccount
2. Remove the account addresses from the attributes.
zmprov mcf ZimbraSpamIsSpamAccount
zmprov mcf ZimbraSpamIsNotSpamAccount
When these attributes are modified, messages marked as spam or not spam
are not copied to the spam training mailboxes.
Manually Training Spam Filters
Initially, you might want to train the spam filter manually to quickly build a
database of spam and non-spam tokens, words, or short character sequences
that are commonly found in spam or ham. To do this, you can manually
78 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
forward messages as message/rfc822 attachments to the spam and non-
spam mailboxes.
When zmtrainsa runs, these messages are used to teach the spam filter. Make
sure you add a large enough sampling of messages to get accurate scores. To
determine whether to mark messages as spam at least 200 known spams and
200 known hams must be identified.
Zimbra Collaboration 8.5 Open Source Edition 79
Managing Configuration
Protect Alias Domains from Backscatter Spam
To reduce the risk of backscatter spam, you can run a service that runs a
Zimbra Access Policy Daemon that validates RCPT To: content specifically for
alias domains.
Note: For information about creating domain aliases, see the Zimbra wiki
article at http://wiki.zimbra.com/index.php?title=ManagingDomains.
1. Set the Postfix LC key.
zmlocalconfig -e postfix_enable_smtpd_policyd=yes
2. Type
zmprov mcf +zimbraMtaRestriction "check_policy_service unix:private/policy"
The postfix_policy_time_limit key is set because by default the Postfix spawn
(8) daemon kills its child process after 1000 seconds. This is too short for a
policy daemon that might run as long as an SMTP client is connected to an
SMTP process.
Disable Postfix Policy Daemon
1. Type zmlocalconfig -e postfix_enable_smtpd_policyd=no
2. Type zmprov mcf -zimbraMtaRestriction "check_policy_service unix:private/
policy"
Set Email Recipient Restrictions
RBL (Realtime Blackhole Lists) can be turned on or off in the MTA from the
administration console Global Settings>MTA page.
For protocol checks, the following three RBLs can be enabled:
Hostname in greeting violates RFC - reject_invalid_hostname
Client must greet with a fully qualified hostname -
reject_non_fqdn_hostname
Sender address must be fully qualified - reject_non_fqdn_sender
The following RBLs can also be set.
reject_rbl_client cbl.abuseat.org
reject_rbl_client bl.spamcop.net
reject_rbl_client dnsbl.sorbs.net
reject_rbl_client sbl.spamhaus.org
reject_rbl_client relays.mail-abuse.org
As part of recipient restrictions, you can also use the reject_rbl_client <rbl
hostname> option.
80 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
To add RBLs from the administration console, go to the Global
Settings>MTA>DNS checks section, List of RBLs.
For a list of current RBLs, see the Comparison of DNS blacklists article at
http://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists.
Add RBLs Using the CLI
1. Log in to the server and go to the Zimbra directory. Type su -zimbra.
2. To view which RBLs are set, type
zmprov gacf | grep zimbraMtaRestriction
3. To add any new RBL types, you must list the existing RBLs and the new
RBLs all in one command.
zmprov mcf zimbraMtaRestriction [RBL type]
For example, to add all possible restrictions:
zmprov mcf zimbraMtaRestriction reject_invalid_hostname
zimbraMtaRestriction reject_non-fqdn_hostname zimbraMtaRestriction
reject_non_fqdn_sender zimbraMtaRestriction reject_rbl_client cbl.abuseat.org
zimbraMtaRestriction reject_rbl_client bl.spamcop.net zimbraMtaRestriction
reject_rbl_client dnsbl.sorbs.net zimbraMtaRestriction reject_rbl_client
sbl.spamhaus.org zimbraMtaRestriction reject_rbl_client relays.mail-
abuse.org
Note: Use quotes when typing RBL types that are two words.
Setting Global Rule for Messages Marked as Both Spam and Whitelist
When you use a third-party application to filter messages for spam before
messages are received by ZCS, the ZCS global rule is to send all messages
that are marked by the third-party as spam to the junk folder. This includes
messages that are identified as spam and also identified as whitelisted
If you do not want messages that are identified as whitelisted to be sent to the
junk folder, you can configure zimbraSpamWhitelistHeader and
zimbraSpamWhitelistHeaderValue to pass these messages to the users
mailbox. This global rule is not related to the Zimbra MTA spam filtering rules.
Messages are still passed through a users filter rules.
Procedure
1. To search the message for a whitelist header, type
zmprov mcf zimbraSpamWhitelistHeader <X-Whitelist-Flag>
2. To set the value, type
zmprov mcf zimbraSpamWhitelistHeaderValue <value_of_third-party_white-
lists_messages>
Zimbra Collaboration 8.5 Open Source Edition 81
Managing Configuration
Anti-virus Settings
Anti-virus protection is enabled for each server when the Zimbra software is
installed. The anti-virus software is configured to send messages that have
been identified as having a virus to the virus quarantine mailbox.
An email notification is sent to recipients letting them know that a message
has been quarantined. The quarantine mailbox message lifetime is set to 7
days.
The global settings for the anti-virus protection is configured with these
options enabled:
Block encrypted archives, such as password protected zipped files.
Send notification to recipient to alert that a mail message had a virus
and was not delivered.
You can change the anti-spam settings from the administration console Global
Settings>AS/AV page.
During Zimbra Collaboration installation, the administrator notification address
for anti-virus alerts is configured. The default is to set up the admin account to
receive the notification. When a virus has been found, a notification is
automatically sent to that address.
By default, the Zimbra MTA checks every two hours for any new anti-virus
updates from ClamAV. The frequency can be set between 1 and 24 hours. You
can change this from the Global Settings>AS/AV page.
Note: Updates are obtained via HTTP from the ClamAV website.
Zimbra Free/Busy Calendar Scheduling
The Free/Busy feature allows users to view each others calendars for
efficiently scheduling meetings. You can set up free/busy scheduling across
ZCS and Microsoft Exchange servers.
ZCS can query the free/busy schedules of users on Microsoft Exchange 2003,
2007, or 2010 servers and also can propagate the free/busy schedules of ZCS
users to the Exchange servers.
To set free/busy interoperability, the Exchange systems must be set up as
described in the Exchange Setup Requirements section, and the Zimbra
Collaboration Global Config, Domain, COS and Account settings must be
configured. The easiest way to configure Zimbra Collaboration is from the
administration console.
Exchange 2003/2007/2010 Setup Requirements.
The following is required to set up the free/busy feature:
82 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Either a single Active Directory (AD) must be in the system or the global
catalog must be available.
The Zimbra Collaboration server must be able to access the HTTP(S) port
of IIS on at least one of the Exchange servers.
Web interface to Exchange public folders needs to be available via IIS.
(http://server/public/)
Zimbra Collaboration users must be provisioned as a contact on the AD
using the same administrative group for each mail domain. This is required
only for ZCS to Exchange free/busy replication.
For Zimbra Collaboration to Exchange free/busy replication, the Exchange
user email address must be provisioned in the account attribute
zimbraForeignPrincipal for all Zimbra Collaboration users.
Configuring Free/Busy on Zimbra Collaboration
To set Free/Busy Interoperability up from the administration console, the
global config, Domain, COS and Account settings must be configured as
described here.
Either globally or by domain configure the Exchange server settings.
Microsoft Exchange Server URL. This is the Web interface to the
Exchange.
Microsoft Exchange Authentication Scheme, either Basic or Form.
Basic is authentication to Exchange via HTTP basic authentication.
Form is authentication to Exchange as HTML form based
authentication.
Microsoft Exchange Server Type, either WebDav or ews
Select WebDAV to support free/busy with Exchange 2003 or
Exchange 2007.
Select ews (Exchange Web Service) to support free/busy with
Exchange 2010, SP1.
Include the Microsoft Exchange user name and password. This is the
name of the account in Active Directory and password that has access to
the public folders. These are used to authenticate against the Exchange
server on REST and WebDAV interfaces.
Add the o and ou values that are configured in the legacyExchangeDN
attribute for Exchange on the Global Config Free/Busy Interop page, the
Domain Free/Busy Interop page or on the Class of Service (COS)
Advanced page. Set at the global level this applies to all accounts talking
to Exchange.
In the Accounts Free/Busy Interop page, configure the foreign principal
email address for the account. This sets up a mapping from the Zimbra
Collaboration account to the corresponding object in the AD.
Zimbra Collaboration 8.5 Open Source Edition 83
Managing Configuration
Note: To find these settings on the Exchange server, you can run the
Exchange ADSI Edit tool and search the legacyExchangeDN attribute
for the o= , ou= , and cn= settings.
Storage Management
Managing Storage Volumes
In the Volume page you manage storage volumes on the Zimbra Mailbox
server. When Zimbra Collaboration is installed, one index volume and one
message volume are configured on each mailbox server. You can add new
volumes, set the volume type, and set the compression threshold.
Note: If Compress Blobs is enabled (YES), the disk space used is
decreased, but memory requirements for the server increases.
Index Volumes
Each Zimbra mailbox server is configured with one current index volume.
Each mailbox is assigned to a permanent directory on the current index
volume. You cannot change which volume the account is assigned.
As volumes become full, you can create a new current index volume for new
accounts. You can add new volumes, set the volume type, and set the
compression threshold
Index volumes not marked current are still actively in use for the accounts
assigned to them. Any index volume that is referenced by a mailbox as its
index volume cannot be deleted.
Message Volumes
When a new message is delivered or created, the message is saved in the
current message volume. Message volumes can be created, but only one is
configured as the current volume where new messages are stored. When the
volume is full, you can configure a new current message volume. The current
message volume receives all new messages. New messages are never
stored in the previous volume.
A current volume cannot be deleted, and message volumes that have
messages referencing the volume cannot be deleted.
Email Retention Management
You can configure retention policies for user accounts email, trash, and junk
folders. The basic email retention policy is to set the email, trash and spam
message lifetime in the COS or for individual accounts.
84 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
You can set up specific retention policies that users can enable for the Inbox
and other email folders in their account. Users can also create their own
retention policies.
You can enable the dumpster feature to save messages that are deleted from
Trash. When an message lifetime has been reached based on email lifetime
rules or deletion policies, the message is moved to the dumpster if it is
enabled. Users can recover deleted items from the dumpster until the
threshold set in the Visibility lifetime in dumpster for end user setting. If
dumpster is not enabled, messages are purged from the server when the
email retention lifetime is reached.
You can also set up a legal hold on an account to prevent message from being
deleted.
Configure Email Lifetime Rules
You can configure when email messages should be deleted from an accounts
folders, and the trash and junk folders by COS or for individual accounts.
By default, the server purges email messages that have exceeded their
lifetime every minute.You can change the duration of time that the server
should rest between purging mailboxes in the administration console, Global
settings or Server settings, General Information page.
For example, the purge interval is set to 1 minute, after mailbox1 is purged of
messages that meet the message lifetime setting, the server waits 1 minute
before beginning to purge mailbox2.
If the message purge schedule is set to 0, messages are not purged even if
the mail, trash and spam message lifetime is set.
Note: Because users cannot see these message lifetime settings, if you set a
purge limit, make the purge policy known to your users.
Configure Message Retention and Deletion Policies
Retention and deletion policies can be configured as a global setting or as a
COS setting. Users can select these policies to apply to their message folders
Feature Name Description
Email message
lifetime
Number of days a message can remain in a folder
before it is purged. This includes data in RSS folders.
The default is 0; email messages are not deleted. The
minimum configuration for email message lifetime is
30 days.
Trashed message
lifetime
Number of days a message remains in the Trash
folder before it is purged. The default is 30 days.
Spam message
lifetime
Number of days a message can remain in the J unk
folder before it is purged. The default is 30 days.
Zimbra Collaboration 8.5 Open Source Edition 85
Managing Configuration
in their account. They can also set up their own retention and deletion policies.
Users enable a policy you set up or create their own policies from their folders
Edit Properties dialog box.
System wide retention and deletion policies can be managed from the
administration console.
To configure global retention or deletion policies, go to the
Configure>Global Settings>Retention Policy page.
To configure retention or deletion policies by COS, go to the
Configure>Class of Service><COS>, Retention Policy page. Make sure
Enable COS-level policies instead of inheriting from the policy defined in
Global Settings is enabled.
The retention policy is not automatically enforced on a folder. If users delete
an item in a folder that has not met the threshold of the retention policy, the
following message is displayed, You are deleting a message that is within its
folders retention period. Do you wish to delete the message?
When the threshold for the deletion policy is reached, items are deleted from
the account. They are not sent to the Trash folder. If the dumpster feature is
enabled, they are sent to the dumpster, if it is not enabled, they are purged
from the server.
How Lifetime and Retention/Deletion Policies Work Together
If the Email Message Lifetime is set to a value other than zero (0), this setting
applies in addition to the disposal or retention policy values applied to a folder.
For example:
Email Message Lifetime is set to 120 days
Folder A has a policy with a disposal threshold of 360 days. Messages in
Folder a are disposed of in 120 days.
Folder B has a policy with disposal threshold of 90 days. Messages in
Folder B are disposed of in 90 days.
Folder C has a policy with retention range of 150 days. Messages in
Folder C are disposed of in 120 days.
Managing the Dumpster
When a message, trash or spam lifetime has been reached, the message is
moved to the dumpster if the feature is enabled. When users right-click on
Trash, they can click Recover deleted items to retrieve items from their trash
that has been deleted in the last x days. This threshold is based on the
Visibility lifetime in dumpster for end user setting.
The Retention lifetime in dumpster before purging setting sets retention lifetime
for items in dumpster. Items in dumpster older than the threshold are purged
and cannot be retrieved.
86 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Administrators can access the individual dumpsters content, including spam,
and they can delete data at any time before the message lifetime is reached.
To search for an item in the dumpster folder, type
zmmailbox -z -m <[email protected]>s --dumpster -l <#>--types
<message,contact,document><search-field>
The search field can be a date range: 'before:mm/dd/yyyy and after:mm/dd/
yyyy' or emails from or to a particular person: 'from: J oe', etc.
To delete items in the dumpster folder, type
zmmailbox -z -m <[email protected]>-A dumpsterDeleteItem <item-ids>
The dumpster folder feature can be managed from the administration console.
1. To enable this feature, go to the Configure>Class of service>[COSname],
Features page, General Features section. Check Dumpster folder.
2. To set Visibility lifetime in dumpster for end user, go to the COSs,
Advanced page, Timeout Policy section.
3. To set Retention lifetime in dumpster before purging, go to the COSs
Advanced page, Email Retention Policy section.
Configure Legal Hold on an Account
If the dumpster folder feature is enabled, you can set up a legal hold to
preserve all items in user accounts.
When dumpster is enabled, Can purge dumpster folder is also enabled.
Disabling this feature turns off purging of items in the users dumpster. This
can be set by a COS or for individual accounts. When Can purge dumpster
folder is enabled, any deletion policies set up on the accounts folders are
ignored.
To configure legal hold on an account from the administration console by
COS, go to Configure>Class of Service>Features page and deselect Can
purge dumpster folder.
For individual accounts, go to Manage>Accounts and select the account.
Disable the feature on the Features page.
Customized Admin Extensions
You can create custom modules to add to the Zimbra administration console
user interface. The admin extension framework allows developers to add new
views to the administration console, manage new data objects in the
administration console, extend existing objects with new properties, and
customize existing views.
You upload and install your modules from the administration console
Zimbra Collaboration 8.5 Open Source Edition 87
Managing Configuration
Go to the Zimbra Wiki, Extending Admin UI at http://wiki.zimbra.com/
index.php?title=Extending_Admin_UI for documentation about how to create
an extended admin UI module.
Backing Up the System
Backing up the mailbox server on a regular basis can help you quickly restore
your email service if there is an unexpected crash. You should include backing
up the Zimbra Collaboration server in your system-wide backup process. Only
full backups of the Zimbra Collaboration data can be created.
Before backing up the Zimbra Collaboration data, all servers must be stopped.
To stop the servers, use the CLI command, zmcontrol stop. After the backup is
complete, to restart the servers, use zmcontrol start. See Appendix A, for
more information about these command.
To restore the Zimbra Collaboration data, you must delete the existing data
and then restore the backup files. The servers must be stopped before
restoring the data.
88 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Zimbra Collaboration 8.5 Open Source Edition 89
9 Managing User Accounts
Topics in this chapter include:
Change Status of Accounts
Delete an Account
View an Accounts Mailbox
Use an Email Alias
Work with Distribution Lists
Using Dynamic Distribution Lists
Change Status of Accounts
The status of an account determines whether a user can log in and receive
mail. The account status displays on the Accounts Content pane in the
administration console.
An accounts status can be one of the following:
Active. Active is the normal status for a mailbox account. Mail is delivered
and users can log into the client interface.
Maintenance. When a mailbox status is set to maintenance, login is
disabled, and mail addressed to the account is queued at the MTA.
Note: Maintenance status is automatically set on an account when a
backup is being run, or when importing/exporting or restoring an
account.
Pending. Pending is a status that can be assigned when a new account is
created and not yet ready to become active. The login is disabled and
messages are bounced.
Locked. When a mailbox status is locked, the user cannot log in, but mail
is still delivered to the account. The locked status can be set if you suspect
that a mail account has been hacked or is being used in an unauthorized
manner.
Closed. When a mailbox status is closed, the login is disabled, and
messages are bounced. This status is used to soft-delete an account
before deleting the account from the server. A closed account does not
change the account license.
90 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
LockOut. This is set automatically when users who try to log in do not enter
their correct password and are then locked out of their account. You
cannot set this status manually. You set up a login policy with a specified
number of consecutive failed login attempts that are allowed before they
are locked out. How long the account is locked out is set by COS or
account configuration, but you can remove the locked out status at any
time.
Delete an Account
You can delete accounts from the administration console. This removes the
account from the server, deletes the messages in the message store, and
changes the number of accounts used against your license.
Before you delete an account, run a full backup of that account to save the
account information. See the Backup and Restore chapter.
View an Accounts Mailbox
You can view a selected accounts mailbox content, including all folders,
calendar entries, and tags from the administration console. Select an account
and from the gear icon drop down menu select View Mail. The users ZWC
account opens in a new browser window.
This feature can be used to assist users who are having trouble with their mail
account as you and the account user can be logged on to the account at the
same time.
Any View Mail action to access an account is logged to the audit.log file.
Use an Email Alias
An email alias is an email address that redirects all mail to a specified mail
account. An alias is not an email account. Each account can have unlimited
numbers of aliases.
When you select Aliases from the Manage Aliases navigation pane, all aliases
that are configured are displayed in the content pane. You can created an
alias, view the account information for a specific alias, move the alias from one
account to another, and delete the alias.
Work with Distribution Lists
A distribution list is a group of email addresses contained in a list with a
common email address. When users send to a distribution list, they are
sending the message to everyone whose address is included in the list. The
address line displays the distribution list address; the individual recipient
addresses cannot be viewed.
You can create distribution lists that require an administrator to manage the
member list and you can create dynamic distribution lists that automatically
Zimbra Collaboration 8.5 Open Source Edition 91
Managing User Accounts
manages adding and deleting members in the list. For more information about
dynamic distribution lists, see Using Dynamic Distribution Lists on page 93.
You can see which distribution lists a user is a member of from the users
account Member of page. When a Zimbra users email address is added to a
distribution list, the users account Member Of page is updated with the
distribution list name. When a distribution list is deleted, the distribution list
name is automatically removed from the accounts Member Of page.
Setting Subscription Policies for Distribution Lists
Subscription policies can be set up to manage a distribution lists membership.
Owners of the list manage the subscription policy from the Properties page of
a distribution list.
Management Options for Owners of Distribution Lists
You can add owners to distribution lists and they manage the list from their
ZWC accounts Address Book, Distribution List folder. Owners of a list can
right click a distribution list and click the Edit Group link to edit a list.
Besides adding and deleting members, distribution list properties that owners
can configure include:
Marking the list as private so it is hidden in the Global Address List
Managing who can send messages to the list
Setting a member subscription policy
Adding additional owners
Option Description
New Subscription Requests Automatically accept. Membership is open
to anyone who subscribes.
Require list owner approval. To subscribe,
users send an email to the owner of the
distribution list and the owner replies to this
email request.
Automatically reject. No one can be added
to this distribution list.
Unsubscription Requests Automatically accept. Anyone can remove
their name from the list.
Require list owner approval To be removed
from the distribution list, users send an email
to the owner. The owner must accept the
email request to remove the name.
Automatically reject. Users cannot remove
themselves from the list.
92 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Creating a Distribution List
1. In the administration console, go to Manage>Distribution Lists.
2. In the gear icon, click New.
3. On the Members page, add the distribution list name. Do not use spaces.
The other fields are optional.
4. Find members to add to the distribution list in the right column. Select the
members to add and click Add Selected. If you want to add all addresses
on the page, click Add This Page. If you want to add members that are not
in the company list, in the Or enter addresses below section, type a
complete mail address.
5. Click Next to configure the Properties page.
6. In the Members Of page, select distribution lists that should be direct or
indirect members of the list.
Option Description
Can receive mail Enabled by default. If this distribution list should
not receive mail select this box.
Hide in GAL Enable to create distribution lists that do not
display in the Global Address List (GAL). You can
use this feature to limit the exposure of the
distribution list to only those that know the
address.
Mail Server This is set to auto by default. To select a specific
mail server, uncheck auto and select a specific
server from the list.
Dynamic Group If you check this box, the Member URL field
displays and you create a dynamic distribution
list.
See Create Dynamic Distribution Lists from the
Administration Console on page 94.
New Subscription Requests Select from
Automatically accept
Require list owner approval
Automatically reject
Unsubscription Requests Select from
Automatically accept
Require list owner approval
Automatically reject.
Zimbra Collaboration 8.5 Open Source Edition 93
Managing User Accounts
7. If the distribution list should have alias, create it.
8. If this distribution list can be managed by other users, enter these email
addresses in the Owners page.
9. Set how messages received to the distribution list should be replied to.
10. Click Finish. The distribution list is enabled and the URL is created.
Enable Viewing of Distribution List Members for AD Accounts
To view Active Directory distribution list members in messages or in the
address book, the GAL group handler for Active Directory must be configured
in the ZCS GALsync account for each Active Directory.
To update the GALsync account for each Active Directory, you must know the
GALsync account name and all data sources on that GALsync account.
1. To find the GALsync account name:
zmprov gd {domain} zimbraGalAccountId
The above command displays the zimbra ID of the GALsync account. To
find the name:
zmprov ga {zimbraId-of-the-GAL-sync-account} | grep "#name"
2. To find the data sources for the GALsync account:
zmprov gds {gal-sync-account-name-for-the-domain}
3. To enable the group handler for the Active Directory:
zmprov mds {gal-sync-account-name-for-the-domain} {AD-data-source-name}
zimbraGalLdapGroupHandlerClass com.zimbra.cs.gal.ADGalGroupHandler
Using Dynamic Distribution Lists
Dynamic distribution lists automatically manage the membership. Users are
added and removed from the distribution list automatically. When you create a
dynamic distribution list, a member URL is specified. This member URL is
used to identify who should be members of the list. You can view this URL
from the administration console distribution lists Properties page.
You can create dynamic distribution lists from the administration console or
from the CLI. In the URL, you specify specific object classes that identifies the
type of users to be added to the dynamic distribution list. For example, you
can configure a dynamic distribution list with the object class=zimbraAccount.
In this case, when accounts are provisioned or accounts are deleted, the
dynamic distribution list is updated.
You can create dynamic distribution lists for all mobile users or POP/IMAP
users.
94 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
You can modify a distribution list to change the filter rules. When you modify a
distribution list, the members in the list are changed to reflect the new rule.
Create Dynamic Distribution Lists from the Administration
Console
1. In the administration console, go to Manage>Distribution Lists.
2. In the gear icon, click New.
3. On the Members page, add the dynamic distribution list name. Do not use
spaces. Do not add members to the list.
4. Click Next to configure the Properties page.
Option Description
Can receive mail Enabled by default. If this distribution list should
not receive mail select this box.
Hide in GAL Enable to create distribution lists that do not
display in the Global Address List (GAL). You can
use this feature to limit the exposure of the
distribution list to only those that know the
address.
Mail Server This is set to auto by default. To select a specific
mail server, uncheck auto and select a specific
server from the list.
Dynamic Group Check this box.
Can be used in right man-
agement
Uncheck this box.
Zimbra Collaboration 8.5 Open Source Edition 95
Managing User Accounts
5. If the dynamic distribution list should have an alias, create it.
6. If this dynamic distribution list can be managed by other users, enter these
email addresses in the Owners page.
7. If you want to set up a reply to address, enter it here. Any replies to this
distribution list are sent to this address.
8. Click Finish. The dynamic distribution list is created.
Users are added automatically to the list based on the filter you specified. If
you add or delete users, the list is updated.
Note: If you use the CLI to modify a dynamic distribution list originally
created on the administration console, you must set
zimbraIsACLGroup FALSE for that dynamic distribution list.
Member URL The Member URL is the type of LDAP URL filter
that determine which type of users are added and
removed in the list.
Type the URL for this list. In the command, ldap:/
//??sub? is the URL. You can add any
combination of filters to this to create different
types of dynamic distribution lists.
Examples of type of URLs.
All users, GAL account names, and spam/ham
account list
ldap:///??sub?(objectClass=zimbraAccount)
Delegated administrators list
ldap:///
??sub?(&(objectClass=zimbraAccount)(zimbraIs
DelegatedAdminAccount=TRUE))
All active accounts
ldap:///
??sub?(&(objectClass=zimbraAccount)(ZimbraA
ccountStatus=active))
All users with the title manager. The title is
taken from the accounts Contact Information
Job Title field. In this example, this field would be
set to Manager.
ldap:///
??sub?(&(objectClass=zimbraAccount)(title=Ma
nager))
New Subscription Requests Select Automatically reject.
Unsubscription Requests Select Automatically reject.
Option Description
96 Open Source Edition Zimbra Collaboration 8.5
Administrator Guide
Using CLI to Manage Dynamic Distribution Lists
Use the zmprov CLI command to manage dynamic distribution lists. In the
command, ldap:///??sub? is the URL. You can add any combination of filters to
this to create different types of dynamic distribution lists.
Create a dynamic distribution list of all new and existing accounts
All users, GAL account names, and spam/ham account names are included.
When user accounts are deleted, they are removed from the list.
zmprov cddl <[email protected]>memberURL ldap:///
??sub?(objectClass=zimbraAccount) zimbraIsACLGroup FALSE
Create a COS and Assign Users
If you create COSs and assign users to the COS based on specific criteria,
such as all managers, you can quickly modify a dynamic distribution list to be
used for a specific COS.
Examples of creating dynamic distribution lists for specific user types.
Create a dynamic distribution list that includes all users that have active
accounts in a specific COS.
zmprov cddl <[email protected]>memberURL ldap:///
??sub?(&(objectClass-zimbraAccount) (zimbraCOSId=513e02e-9abc-4acf-863a-
6dccf38252e3) (zimbraAccountStatus=active) ) zimbraIsACLGroup FALSE
Create a dynamic distribution list that includes all users based on job titles.
To use this, the accounts Contact Information Job Title field must include
the title. In this example it would be set to Manager.
zmprov cddl <[email protected]>memberURL ldap:///
??sub?(&(objectClass-zimbraAccount) (zimbraCOSId=513e02e-9abc-4acf-863a-
6dccf38252e3) (title=Manager) ) zimbraIsACLGroup FALSE
Create a dynamic distribution list for all delegated administrators.
zmprov cddl <[email protected]>memberURL ldap:///??sub?(&
(objectClass-zimbraAccount) (zimbraCOSId=513e02e-9abc-4acf-863a-
6dccf38252e3) (zimbraIsDelegatedADminAccount=TRUE) )
zimbraIsACLGroup FALSE