Using Configuration File to Specify E-Mail Accounts for Migration

To perform e-mail messages migration, PMM requires a list of e-mail accounts for which to migrate account settings and messages. The way to provide such a list is to include them in the Mail migration section in the migration configuration file. If the file contains a list of e-mail accounts and is accessible by PMM, only the accounts listed in the file will be migrated.

The Mail migration section may contain the following information:

To specify e-mail accounts to be migrated by PMM, follow these steps:

  1. Open the <PLESK_DIR>\admin\bin\migrmng.exe.config file, where <PLESK_DIR> is the name of the directory where Plesk in installed.
  2. Type e-mail accounts information in the Mail migration section of the file or specify the full path to a file with the information about e-mail accounts to migrate and save the file.(Refer to the example below for the format used to specify e-mail-accounts).

    If you choose to indicate a separate file as a source of information about e-mail accounts, the contents of the file must mimic that of the Accounts element in the Mail migration section of the migrmng.exe.config file.

  3. Save directory.
  4. Start migration selecting the Mail messages migration option.

    For detailed instructions on how to select the migration option, consult the "Migrating E-Mail Content for Selected Domains" section.

Note: As a result of this procedure, the list of domains and e-mail accounts displayed in the Select mail domains to migrate window will include only domains with the e-mail accounts listed in the file. Make sure that the list of e-mail accounts is current. Once migration is completed and verified, remove the accounts information from the file.

The following is the example of the Mail migration section in the migrmng.exe.conig file:

……….

<Platform Name="Mail" Id="{10FB3A3D-BBCC-4270-9B67-28024D279180}">

<Providers backupProvider="" restoreProvider="" SkipMailMsgBackup="false" SmartRestore="true" >

<Provider idString="POP3" Address="" Port="" Timeout="0" />

<Provider idString="IMAP4"Address="" Port="" Timeout="0" />

<Provider idString="SMTP" Address="" Port="" Timeout="0"/>

<Provider idString="MailEnable" />

<Provider idString="SmarterMail" />

<Provider idString="MerakMailServer" />

<Provider idString="IMail" />

<Provider idString="hMail3" />

<Provider idString="hMail4" LoginName="" LoginPassword="" />

<Provider idString="MDaemon" />

</Providers>

<Accounts fromFile="" >

<Account Name="user1@example1.com" Pwd="userpass1" />

<Account Name="user2@example2.com" Pwd="userpass2" />

<Account Name="user1@example3.com" Pwd="userpass3" />

</Accounts>

</Platform>

……….

the Mail migration section may contain the following parameters:

XML Element

XML Attribute

Description

Data Types

Comment

Providers

 

backupProvider

Specifies source mail server type or mail transfer protocol.

String

 

If the attribute is not defined, the provider is determined by PMM automatically.

restoreProvider

Specifies target mail server type or mail transfer protocol.

String

If the attribute is not defined, the provider is determined by PMM automatically.

SkipMailMsgBackup

Enables migration of account information only, excluding mail messages.

Boolean

 

SmartRestore

Enables restoring e-mail data (including IMAP folders and flags) by using the IMAP protocol.

Boolean

If restoring by using the IMAP protocol fails and the attribute is set to true, PMM will restore content by using the standard options. Be mindful, however, that with SmartRestore="true" restoring will always be done to a mail server at 127.0.0.1: 143 regardless the migration configuration file settings. If you do not need to restore IMAP settings, set the attribute to false. If you would like to restore e-mail content to a destination other than 127.0.0.1: 143, configure the following elements and attributes to disable the SmartRestore mode and enable restoring by using the IMAP4 protocol to a specific destination address:port:

<Providers backupProvider="" restoreProvider="IMAP4" SkipMailMsgBackup="" SmartRestore="false" ><Provider idString="IMAP4"Address="" Port="" Timeout="0" />

Provider

 

idString

Specifies backup provider name (mail server type or mail transfer protocol).

String

A server name or mail transfer protocol: MailEnable, SmarterMail, MerakMailServer, IMail, MDaemon, hMail3, hMail4, IMAP4, POP3, SMTP

Address

Specifies domain name or IP address of the source mail server.

String

Should be specified for mail transfer protocols only.

Port

Specifies port number to use with a mail transfer protocol if different from default value.

<number>

Should be specified for mail transfer protocols only. The following default port numbers are used by PMM:

  • 40 (POP3)
  • 143 (IMAP)
  • 25 (SMTP)

Timeout

The mail server timeout value in seconds.

<number>

0 instructs PMM to use the built-in default timeout value (which is non-zero).

LoginName

Mail server administrator's login name.

String

Only for hMail v. 4.3 or later.

LoginPassword

Mail server administrator's password.

String

Only for hMail v. 4.3 or later.

Accounts

fromFile

Path to a file with information about e-mail accounts. E-mail content will be downloaded only for the accounts listed.

<path>

If specified, the Account Name elements will be ignored. The file to which the path points to must contain information about e-mail accounts in the following format:

<Accounts>

<Account Name="user1@example1.com" Pwd="userpass1" />

<Account Name="user2@example2.com" Pwd="userpass2" />

</Accounts>

Account Name

 

Name

Individual e-mail account name.

<user name>@<domain name>

 

Pwd

User password for an e-mail account.

<user password>

The parameter must be provided if PMM connects to mail server by using one of the mail transfer protocols requiring user authentication.

In this section:

When to Use Migration Configuration File

When Not to Use Migration Configuration File