User Tools

Site Tools


reference:import_users_from_file

Import Users From File

VPOP3 supports the importation and exportation of users, via a CSV file (see below for a specification of the CSV file format).
NOTE: This process is not designed to provide a complete backup of user data, nor is it intended to facilitate moving VPOP3 to a new computer. Instead, see the following relevant pages: Move VPOP3, Backup VPOP3.

To import users from a file, within the Administration Settings → Users page, click Import users from file. This should then open a window, which allows you to select the CSV file.
Once you have selected the CSV file, click Preview Import, to finalise the import settings.

CSV file format

The simplest way to create a new CSV file is to use a dedicated software package, such as Microsoft Excel. Within Excel, you will need to save the file as type CSV (Comma delimited) (*.csv).

You may optionally include a header line at the top of the CSV file, which allows you to specify a customised column order.
Irrespective of whether you include the header line, you will be able to override the column definitions at the final stage. Nonetheless, for simplicity, it is typically recommended that you enter the data for each of the columns, in the following order.

Column header label Description Accepted values
User Id The username Any text
Password The password Any text
Admin Whether the user is an administrator 0/1
Reply To Rarely needed: VPOP3 will override relevant addresses with this address, in outgoing mail A valid email address
Assistant The assistant's email address A valid email address/username
Send Only To Assistant Whether to dispose of the user's own copy of incoming messages 0/1
Forward To Automatically forward incoming mail to this address A valid email address/username
Use Forwarding Whether to enable forwarding for this user 0/1
Comments A comment/note related to the user Any text
In 'Everyone' List Whether the user is added to the list called Everyone 0/1
Is Internet Mail Allowed Whether Allow sending of Internet mail is enabled 0/1
Is Incoming Mail Allowed Whether Allow receiving of Internet mail is enabled 0/1
Monitor Messages Whether the user's messages are specifically selected for monitoring 0/1
Max Outgoing Size The maximum permitted size (in bytes) for outgoing messages Numeric
WebPassword A specifically separate password for logging into webmail Any text

Finalising the import

After clicking Preview Import, you should be presented with options for finalising the import.
If you have included a header line in the CSV file, the columns should be sorted into that customised order. Otherwise, the columns should appear in the default order.

Your first task is to ensure that all desired columns have been assigned to the correct attribute, and then if there are any, to change all undesired columns to “Ignore”.

Next, review the three checkboxes:

  • Ignore first line - You should tick this if the first line contains header labels
  • Update Existing Users - You should tick this if you want to overwrite settings for users that already exist
  • Remove users not present in imported file - You should only tick this if you are sure that all of the users are contained within the import file, and you would not want any other user accounts to remain within VPOP3

Finally, specify how the users' passwords are to be created:

  • From File The password will be imported from the relevant mapped field in the CSV file
    • Encrypted If the CSV file had previously been exported from VPOP3, and the passwords have not been changed, tick this option
  • Randomly Apply a randomly generated password for each user
  • Use the Username This is not recommended, particularly where remote access to VPOP3 is possible, because guessable passwords are a security risk
  • Use the text “Password” This is not recommended, particularly where remote access to VPOP3 is possible, because guessable passwords are a security risk

Log file

After importing the file successfully, VPOP3 will write a file called importusers.log to the VPOP3 folder. The passwords will be included in this file if VPOP3 did not read encrypted passwords from the CSV file. This is useful if you have told VPOP3 to randomly generate passwords.

reference/import_users_from_file.txt · Last modified: 2018/11/14 10:45 (external edit)