Zmprov Examples

Zmprov Examples

   KB 1663        Last updated on 2015-11-1  

(0 votes)


Create one account with a password that is assigned to the default COS:

zmprov ca password

Create one account, password with first name/last name:

zmprov ca password cn "Firstname Lastname" displayName "Firstname Lastname" givenName "Firstname" zimbraPrefFromDisplay "Firstname Lastname" 

Create one account with a password that is assigned to a specified COS. You must know the COS ID number. To find a COS ID, type zmprov gc <COSname>.:

zmprov ca <password> zimbraCOSid <cosIDnumberstring>

Create an account that forwards to another account:

zmprov ca <password> zimbraMailForwardingAddress

Create one account when the password is not authenticated internally:

zmprov ca ""

Change the administrator’s password. Use this command to change any password. Enter the address of the password to be changed:

zmprov sp password

To list all COSs and their attribute values:

zmprov gac -v

To list all COSs and their attribute values:

zmprov gaa

To list all user accounts [ is optional]:

zmprov -l gaa []

Note: The empty single quote is required and indicates that there is no local password

Use a batch process to create accounts:

see the Batch Provisioning from the CLI Utility section of the Managing the Zimbra Collaboration Suite chapter for the procedure.


Add an alias to an account:

zmprov aaa
Canonical address

> zimbraMailCanonicalAddress

Distribution Lists

Create distribution list. The ID of the distribution list is returned:

zmprov cdl

Add a member to a distribution list. Tip: You can add multiple members to a list from the administration console:

zmprov adlm


Create a domain that authenticates against Zimbra OpenLDAP:

zmprov cd zimbraAuthMech zimbra

Set the default domain:

zmprov mcf zimbraDefaultDomainName

To disable the imapproxy service:

zmprov ms `zmhostname` -zimbraServiceEnabled imapproxy

To enable logger on a single server:

zmprov +zimbraServiceEnabled logger

Then type zmloggerctl start, to start the logger.

Mail Notification

Modify zimbraNewMailNotification to customize the notification email template. A default email is sent from Postmaster notifying users that they have received mail in another mailbox. To change the template, you modify the receiving mailbox account. The variables are:

  • ${SUBJECT}
  • ${NEWLINE}

You can specify which of the above variables appear in the Subject, From, or Body of the email. The following example is changing the appearance of the message in the body of the notification email that is received at You can also change the template in a class of service, use zmprov mc. The command is written on one line.

zmprov ma zimbraNewMailNotificationBody 'Important message from ${SENDER_ADDRESS}.${NEWLINE}Subject:${SUBJECT}'
Verified Against: Zimbra Collaboration 8.0, 7.0 Date Created: 04/16/2014
Article ID: Date Modified: 2015-11-01

Try Zimbra

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

Want to get involved?

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

Looking for a Video?

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

Jump to: navigation, search