PMDF popstore & MessageStore Manager's Guide

The copy_user command creates a new account whose settings duplicate those of an existing account. Note that accounting information and stored messages are not copied.

The parameter names and associated values accepted by the command are listed in Table 4-3.

Table 4-3 copy_user command parameters

parameter=value		Description
flag=fvalue flag0=fvalue flag1=fvalue flag2=fvalue flag3=fvalue flag4=fvalue	Optional	Usage flags for the new account. fvalue must be one of dismail, nodismail, disuser, nodisuser, lockpwd, or nolockpwd. The flag0, flag1, ... parameters are provided for use in instances in HTML where the same parameter name cannot be used more than once in the same form.
log=bvalue	Optional	Boolean value, 0 or 1. When bvalue is 1, then a status message will be output indicating a successful operation. The default is bvalue=0. Note that errors are always reported.
group_name=name	Optional	Name of the management group, name, to place the new account in. The account must be placed into a group to which the manager creating the account has access to. When a group name is not specified for the new account, the group name of the account being copied is assumed.
on_error=file-spec	Required	Name of the formatting file to use to format the results when the command fails.
on_success=file-spec	Required	Name of the formatting file to use to format the results when the command succeeds.
overdraft=qvalue	Optional	Amount of storage overdraft to allow the new account. qvalue is a non-negative, floating point number.
overdraft_units=qunits	Optional	Storage units in which the overdraft quota qvalue is expressed. Must be one of b (bytes), kb (kilobytes), mb (megabytes), or gb (gigabytes). If this parameter is not specified, storage units of kb are assumed.
owner=string	Optional	Name of the owner of the new account. This string has a maximum length of 40 bytes.
password=string	Optional	The password for the new account. This string has a maximum length of 32 bytes. A zero-length password allows anyone to access the account.
private=string	Optional	Data to store in the new account's site-defined private data area. This string has a maximum length of 64 bytes.
quota=qvalue	Optional	Primary message storage quota for the new account. A qvalue of zero grants the account unlimited storage quota. If the quota_units parameter is not specified, then units of kilobytes, kb, are assumed. qvalue is a non-negative, floating point number.
quota_units=qunits	Optional	Storage units in which the quota qvalue is expressed. Must be one of b (bytes), kb (kilobytes), mb (megabytes), or gb (gigabytes).
username=string	Required	First instance of this parameter gives the name of the existing account to copy. Subsequent instances give the names of the new accounts to create. These strings each have a maximum length of 32 bytes and can not contain wild card characters.

The username parameter must appear at least twice. The first instance, when reading the command from left to right, gives the name of the account to copy. The second and subsequent instances give the names of the accounts to create. Values for account fields not specified in the command will be drawn from the account being copied.

As an example, consider the command

command=copy_user&username=default&username=jdoe& password=SeCrEt&owner=Jane Doe&success_format=copy_success.txt& error_format=copy_error.txt

which creates a new account jdoe which is a copy of the account default. The new account is given the password SeCrEt and owner field Jane Doe. All other fields duplicate those of the default account.

As an aside, note that the add_user command is actually implemented as a copy_user command with the default account being the account which is copied.