:DeleteMessage()


Class

     aprPOP()

 

Syntax

     :DeleteMessage(nMessage, [hSession] ) -> lSuccess

 

Parameters

 

nMessage

Message number to delete from remote server.

 

hSession

Optional: If hSession is not passed, the value in :Session will be used

 

Return

Logical indicating Success.

Returns .T. if the operation succeeds, otherwise returns .F.

To get more information about the error, see :nErr and :cErr.

 

Description

The :DeleteMessage() method marks the specified message for deletion from the mailbox.

 

This method only marks the message for deletion. The message is not actually deleted until the user disconnects from the server. To prevent one or more marked messages from actually being deleted from the mailbox, call the PopReset function to reset the client session.

 

See Also

:Reset(), :Disconnect()