PopGetMessageCountEx
INT PopGetMessageCountEx(
HCLIENT hClient,  
UINT *lpnLastMessage,  
DWORD *lpdwMailboxSize  
);

The PopGetMessageCountEx function returns the number of mail messages that are currently available in the mailbox.

Parameters

hClient
Handle to the client session.
lpnLastMessage
Address of a variable that receives the number of the last valid message in the mailbox. If a NULL value is specified, this argument is ignored.
lpdwMailboxSize
Address of a variable that receives the current size of the mailbox. This value will decrease as messages are deleted. If a NULL value is specified, this argument is ignored.

Return Value

If the function succeeds, it returns the number of messages that are currently available. If no messages are available, either because the mailbox is empty or all of the messages have been deleted, this function will return zero. If the function fails, the return value is POP_ERROR. To get extended error information, call PopGetLastError.

Remarks

The PopGetMessageCountEx function returns the number of messages available in the mailbox, the last valid message number in the mailbox and the current size of the mailbox in bytes.

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.

See Also

PopDeleteMessage, PopGetHeaderValue, PopGetMessage, PopGetMessageHeaders, PopStoreMessage


Copyright © 2008 Catalyst Development Corporation. All rights reserved.