Previous | Contents | Index |
delete_message
Command: delete a user's message
A specific message stored for a user account can be deleted with the delete_message
command. The message to be deleted is identified by means of a UIDL as returned by the %msgr_uidl
substitution string of the show_users
command.
If a return_messages
parameter with a bvalue
of 1
is specified, then a non-delivery notice will be sent to the message's
originator if the message is unread. Note that if the message has
multiple recipients, those recipient's copies of the message are not
affected by this command.
Parameter names and associated values accepted by the command are listed in Table 4-5.
parameter=value |
Description | |
---|---|---|
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. |
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.
|
return_messages=bvalue
|
Optional |
Boolean value,
0 or
1 , indicating whether (
1 ) or not (
0 ) a non-delivery notice should be sent if the message has
not been read by the user. By default, a non-delivery notice is not
sent; this corresponds to a
bvalue of
0 . When
bvalue is
1 , a non-delivery notice is sent should the message prove
to be unread.
|
uidl=string
|
Required | UIDL for this user's instance of the message to be deleted. |
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 not contain wild card characters. |
Only a single instance of the username
and uidl
parameters can appear.
As an example, consider the following command which deletes the message with UIDL !!!!01234
for the account sue
:
command=delete_message&username=sue&uidl=!!!!01234& return_messages=1&on_success=delmsg_success.txt& on_error=delmsg_error.txt |
return_messages=1
is specified, a non-delivery notice is sent for each unread message which is deleted.
Previous | Next | Contents | Index |