DeleteMessage Method

Marks a message for deletion from the mailbox.

Syntax

object.DeleteMessage( MessageNumber )

Remarks

The DeleteMessage method marks the specified message for deletion from the mailbox. The following is a description of the arguments that may be passed to the method:

MessageNumber
Number of message to delete from the server. This value must be greater than zero. The first message in the mailbox is message number one.

This function only marks the message for deletion. The message is not actually deleted until the client disconnects from the server, however it will no longer be accessible by the client. To prevent deleted messages from actually being removed from the mailbox, call the Reset method.

Return Value

A value of zero is returned if the method was successful. Otherwise, a non-zero error code is returned which indicates the cause of the failure.

See Also

Reset Method


Copyright © 2008 Catalyst Development Corporation. All rights reserved.