:GetMessageCount()


Class

     aprPOP()

 

Syntax

     GetMessageCount( [hSession] ) -> nMsgCnt

 

Parameters

 

hSession

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

 

Return

If the method 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, it will return zero.

If the function fails, the return value is POP_ERROR.

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

 

Description

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

  

See Also

:DeleteMessage(), :GetHeaderValue(), :GetMessage(), :GetMessageCountEx(), :GetMessageHeader(), :StoreMessage()