PMDF popstore & MessageStore Manager's Guide

Messages stored for a popstore account can be deleted with the delete_messages command. If a return_messages parameter with a bvalue of 1 is specified, then a non-delivery notice will be sent for unread messages. Parameter names and associated values accepted by the command are listed in Table 4-6. Note that if the messages have other recipients, those other recipients' copies of the messages are not effected by this command.

Table 4-6 delete_messages command parameters

parameter=value		Description
group=name	Optional	Delete the messages stored for 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) non-delivery notices should be sent for unread messages. By default, non-delivery notices are not sent; this corresponds to a bvalue of 0. When bvalue is 1, non-delivery notices are sent for unread messages.
username=string	Required	Username of the account for which to delete the stored messages. This string has a maximum length of 32 bytes and can contain wild card characters.

When multiple instances of the username parameter are provided, messages for each of the specified accounts are deleted. When the value specified with a username parameter contains wild card characters, the operation will be confined to any matching user name 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 messages for the accounts sue and tom:

command=delete_messages&username=sue&username=tom&return_messages=1& on_success=delmsgs_success.txt&on_error=delmsgs_error.txt

As return=1 is specified, non-delivery notices are sent for each unread message which is deleted.