:GetMessageCountEx()
Class
Syntax
GetMessageCountEx( [hSession] ) -> aMsgCnt
Parameters
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Returns an array of three values.
|
1 |
POP_COUNT_TOTAL |
Total number of messages in the mailbox |
|
2 |
POP_COUNT_LAST |
Last message number in the mailbox |
|
3 |
POP_COUNT_SIZE |
Current Size of the mailbox. |
If no messages are available, either because the mailbox is empty or all of the messages have been deleted, aMsgCnt[POP_COUNT_TOTAL] will be 0.
If the function fails, the return value of aMsgCnt[ POP_COUNT_TOTAL] is POP_ERROR.
To get more information about the error, see :nErr and :cErr.
Description
The :GetMessageCountEx() method 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.
See Also
:DeleteMessage(), :GetHeaderValue(), :GetMessage(), :GetMessageCount(), :GetMessageHeader(), :StoreMessage()