Import/Export Users from/to File

The primary use of this function is to export and import user accounts between two IceWarp Servers.

For transferring users to another IceWarp Email Server we recommend using the command line TOOL.EXE.

This powerful feature lets you export accounts from the selected domain to a specially formatted text file (.MAE for version 9.x or .EXP for version 10.x).

The file includes all Account types and account properties including the Email Address, Account Name, Account Type (as an integer value), Password and Properties (as an encoded string).

This file can be edited using a standard text editor.

The import feature lets you import accounts from the export file.

There are some important points you should be aware of:

if a domain listed in the file is missing in IceWarp Server it will be automatically created.
if any property values are not available in either the first four or as part of the encoded string then account defaults will be used.

It is highly recommended that you experiment with this facility before you use it on any large number of accounts on a production server.

NOTE: When exporting/importing accounts, only account structures are exported/imported. Account data is not exported/imported.

If you want to backup all account data, do it manually in the IceWarp/mail/[domain]/[user] directory.

To move accounts from one domain to another one, you can use the cut ant paste method. To move all domain accounts, you can just rename this domain – it keeps all data intact.

File Structure

Example

fred@<demo.com>,eJxjYGBg4AsuScxLSSxKUQgtTi2yhlAMIwYwspSOKP9igAH3PyOEctj5yGEgrB9w/w8wEM5NLUrMTknNzddLzs+NAYVGzEC7aWBAAwNDcW6xLigEHGDhMdBuoi9gtB5oF4yCUTAKRsHgAADS/h28

Tool.exe Commands

Tool.exe is a command line interface to the IceWarp Server API from Windows. On a Linux server this will be tool.sh. To use it, navigate to the IceWarp Server installation root where it is located (usually you would type cd "/Program Files/IceWarp/" or applicable location in Linux).

To export accounts, you can use this command (syntax followed by an example):

tool export account "*@<domain_name>" u_backup > <file_name>

tool export account "*@icewarp.com" u_backup > icewarp_com.csv

To import accounts, you can use this command (syntax followed by an example):

tool import account "<file_name>" u_name u_password u_comment

tool import account "domain_com.csv" u_name u_password u_comment

To reveal more commands, use this command (or refer to the Command Line Tool chapter):

tool --tutorial

NOTE: The backup/migration file suffix is .EXP but in previous versions before 10.0.0 it was .MAE. If you are exporting from an older version into .MAE you can simply rename this file to .EXP and it will be importable into the latest versions of IceWarp.

Import/Export of Accounts Via Console

For export of accounts:

In the Console, right-click name of the selected domain (Domains and Accounts – Management) and from the pop-up menu, select the Import/Export – Export domain and account to file items.
The standard Save As dialog opens.
Save the file e.g. as <domain_com>.EXP.

For import of accounts:

In the Console, right-click name of the selected domain (Domains and Accounts – Management) you want to import accounts to and from the pop-up menu, select the Import/Export – Import domain and account from file items.
The standard Open dialog opens.
Select the appropriate file to import accounts.

NOTES:

The domain you want to import accounts to has to have the same name as the domain that you exported accounts from.

Imported accounts are added – if there are any other accounts in the domain, these accounts are not deleted.

It is recommended to export/import accounts only between same versions of IceWarp Server.

Export of Phone Numbers

You may want to export phone numbers of users of some domain. These numbers are exported into a .csv file in the following structure:

Name, Email address, Phone number

To do it, follow these steps:

Right-click the appropriate domain name and select the Export/Import – Export Phone # to CSV items.
In the standard Save As dialog, select the wished location and save the file.