CLI zmmailboxmove Network Edition only

CLI zmmailboxmove Network Edition only

   KB 1506        Last updated on 07/11/2015  




0.00
(0 votes)
Article-check.png  - This is certified documentation and is protected for editing by Zimbra Employees & Moderators only.
 - This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
 - This article is a Work in Progress, and may be unfinished or missing sections.

For the most recent information on this CLI, including syntax and description, see ZCS Administrator's Guide Network Edition > Appendix A Command-Line Utilities.

ZCS 6.0.x

zmmailboxmove

This command is used to move a mailbox from one Zimbra server to another. Mailboxes can be moved between Zimbra servers that share the same LDAP server. All the files are copied to the new server and LDAP is updated. After the mailbox is moved to a new server, a copy still remains on the older server, but the status of old mailbox is closed. Users cannot log on and mail is not delivered. You should check to see that all the mailbox contents were moved successfully before purging the old mailbox.

Syntax

zmmailboxmove {-a <arg>} {-t <arg>|-po} [options]

Description

Long Name Short Name Description
--account -a <arg> Email address of account to move
--help -h Shows the help for the usage options for this command
--overwriteMailbox -ow Overwrite target mailbox, if it exists
--purgeOld -po Purge old mailbox on previous server. After a mailbox has been successfully moved to a new server, perform purgeOld to remove the mailbox and its contents from the previous server.
--server -s <arg> Mail server hostname. The default is the localhost. Server where the --account mailbox is located.
--targetServer -t <arg> Server where mailbox is moved to Use -t option to move a mailbox from the current server to the new server specified by the option.
--authtokenfile -Y Use auth token string (has to be in JSON format) from command line
--authtoken -y Use auth token string (has to be in JSON format) from command line

Examples

In these examples, two separate command lines are used to move the mailbox and to purge the old mailbox. This is because -t and -po are mutually exclusive.

  • To move a mailbox from the default server to the target server:
zmmailboxmove -a user1@domain.com -t server2.domain.com
  • To move a mailbox from the default server to the target server, while overwriting any existing mailbox for the account on the target server:
zmmailboxmove -a user1@domain.com -t server2.domain.com -ow
  • To purge an old mailbox from the default server, after checking that the contents of the mailbox were successfully moved to the target server:
zmmailboxmove -a user1@domain.com -po


ZCS 5.0.x

ZCS 4.5.x


Verified Against: ZCS 6.0 Date Created: 5/4/2006
Article ID: https://wiki.zimbra.com/index.php?title=CLI_zmmailboxmove_Network_Edition_only Date Modified: 07/11/2015



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