ZCS Administrator's Guide, Open Source Edition 4.5 Rev 2 11/07

zmmailbox

Long Name	Short Name	Description
--config	-c	<arg> File in which the configuration is stored
--default	-d	Show default values for keys listed in [args]
--edit	-e	Edit the configuration file, change keys and values specified. The [args] is in the key=value form.
--force	-f	Edit the keys whose change is known to be potentially dangerous
--help	-h	Shows the help for the usage options for this tool
--info	-i	Shows the documentation for the keys listed in [args]
--format	-m	<arg> Shows the values in one of these formats: plain (default), xml, shell, nokey.
--changed	-n	Shows the values for only those keys listed in the [args] that have been changed from their defaults
--path	-p	Shows which configuration file will be used
--quiet	-q	Suppress logging
--random	-r	This option is used with the edit option. Specified key is set to a random password string.
--show	-s	Forces the display of the password strings
--unset	-u	Removes the local setting for a variable, which causes it to fallback to the default
--expand	-x	Expand values

The zmmailbox tool is used for mailbox management. The command can help administrators provision new mailboxes along with accounts, debug issues with a mailbox, and help with migrations.

You can invoke the zmmailbox command from within the zmprov command. You enter selectMailbox within zmprov to access the zmmailbox command connected to that specified mailbox. You can then enter zmmailbox commands until you type exit. Exit returns you to zmprov. This is useful when you want to create accounts and also pre-create some folders, tags, or saved searches at the same time.

Syntax

zmmailbox [args] [cmd] [cmd-args ...]

Description

 

Short Name	Long Name	Syntax, Example, and Notes
-h	--help	display usage
-f	--file	use file as input stream
-u	--url	http[s]://{host}[:{port}] server hostname and optional port. Must use admin port with -z/-a
-a	--account {name}	account name to auth as
-z	--zadmin	use zimbra admin name/password from localconfig for admin/password
-m	--mailbox	mailbox to open
-p	--password {pass}	password for admin account and or mailbox
-P	--passfile {file}	read password from file
-v	--verbose	verbose mode (dumps full exception stack trace)
-d	--debug	debug mode (dumps SOAP messages)

Specific CLI tools are available for the different components of a mailbox. Usage is described in the CLI help for the following

 

zmmailbox help admin	help on admin-related commands
zmmailbox help commands	help on all commands
zmmailbox help contact	help on contact-related commands (address book)
zmmailbox help conversation	help on conversation-related commands
zmmailbox help folder	help on folder-related commands
zmmailbox help item	help on item-related commands
zmmailbox help message	help on message-related commands
zmmailbox help misc	help on miscellaneous commands
zmmailbox help search	help on search-related commands
zmmailbox help tag	help on tag-related commands

Examples

•	When you create an account, you may want to pre-create some tags and folders. You can invoke zmmailbox inside of zmprov by using "selectMailbox(sm)”

 

domain.example.com$ /opt/zimbra/bin/zmprov prov> ca user10@domain.example.com test123 9a993516-aa49-4fa5-bc0d-f740a474f7a8 prov> sm user10@domain.example.com mailbox: user10@domain.example.com, size: 0 B, messages: 0, unread: 0 mbox user10@domain.example.com> createFolder /Archive 257 mbox user10@domain.example.com> createTag TODO 64 mbox user10@domain.example.com> createSearchFolder /unread "is:unread" 258 mbox user10@domain.example.com> exit prov>

•	To find the mailbox size for an account

zmmailbox -z-m user@example.com gms

ZCS Administrator's Guide, Open Source Edition 4.5 Rev 2 11/07