PopDeleteMessage
INT PopDeleteMessage(
HCLIENT hClient,  
UINT nMessage  
);

The PopDeleteMessage function marks the specified message for deletion from the mailbox.

Parameters

hClient
Handle to the client session.
nMessage
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.

Return Value

If the function succeeds, the return value is zero. If the function fails, the return value is POP_ERROR. To get extended error information, call PopGetLastError.

Remarks

This function 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.

Requirements

Client: Requires Windows Vista, Windows XP or Windows 2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or Windows 2000 Server.
Header: Include cstools6.h.
Library: Use cspopav6.lib.
Unicode: Implemented as Unicode and ANSI versions.

See Also

PopGetMessage, PopGetMessageCount, PopReset


Copyright © 2008 Catalyst Development Corporation. All rights reserved.