PMDF popstore & MessageStore Manager's Guide


Previous Next Contents Index

4.3.4.7 delete_user Command: delete a user account

Popstore accounts can be deleted with the delete_user command. Parameter names and associated values accepted by the command are listed in Table 4-7.

Table 4-7 delete_user command parameters
parameter=value   Description
group=name Optional Delete the matching accounts contained within the specified management group and subgroups thereof. The name of the group, name, can not contain wild card characters. This parameter should only be used when then value specified with the username parameter contains wild cards.
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.
return_messages=bvalue Optional Boolean value, 0 or 1, indicating whether ( 1) or not ( 0) unread messages stored for the account should be returned to their originator. By default, unread messages are not returned; this corresponds to a bvalue of 0. A bvalue of 1 requests that unread messages be returned.
username=string Required Username associated with the account to delete. This string has a maximum length of 32 bytes and can contain wild card characters.

When multiple instances of the username parameter are provided, each of the associated accounts are deleted. When the value specified with a username parameter contains wild card characters, the operation will be confined to any matching user names within the management group and subgroups of the manager requesting the operation. If a group name is also specified, then the operation will be further confined to that group and subgroups.

As an example, consider the following command which deletes the accounts sue and tom:


command=delete_user&username=sue&username=tom& 
  on_success=delusr_success.txt&on_error=delusr_error.txt 
Since the return_messages parameter is not specified, any unread messages will be deleted.


Previous Next Contents Index