PMDF popstore & MessageStore Manager's Guide


Previous Contents Index

4.3.4.2 add_user Command: add a new user account

The add_user command adds one or more user accounts to the popstore. Parameter names and associated values accepted by the command are listed in the Table 4-2.

Table 4-2 add_user command parameters
parameter=value   Description
flag=fvalue
flag0=fvalue
flag1=fvalue
flag2=fvalue
flag3=fvalue
flag4=fvalue
Optional Usage flags for the 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.
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, a zero length group name is assumed thus placing the new account into the world group.
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.
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 value.
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 account. This string has a maximum length of 40 bytes.
password=string Required The account password. 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 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 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 value.
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 Username to associate with the account. This string has a maximum length of 32 bytes and can not contain wild card characters.

When creating a new account, values for omitted, optional parameters will be set to "zero": numeric values will be set to zero and string values will have a zero length.

If the username parameter is repeated, then multiple accounts are created, one with each username value. Each account so created will have the same password, flags, primary and overdraft quotas, etc.

As an example, consider the command


command=add_user&username=jdoe&password=SeCrEt&owner=Jane Doe& 
  success_format=add_success.txt&error_format=add_error.txt 
which creates the new account jdoe with password SeCrEt and owner field Jane Doe .

To set more than one usage flag, repeat the flag parameter. For instance,


command=add_user&username=jdoe&password=SeCrEt&owner=Jane Doe& 
  flag=nodismail&flag=nodisuser&flag=lockpwd& 
  success_format=add_success.txt&error_format=add_error.txt 
which sets the account's usage flags to nodismail , nodisuser , and lockpwd .


Previous Next Contents Index