| DWORD GetMailboxSize( |
| |
LPCTSTR lpszMailbox |
|
| ); |
The GetMailboxSize method returns the size of the specified
mailbox.
Parameters
- lpszMailbox
- A pointer to a string which specifies the
mailbox name.
Return Value
If the method succeeds, it returns the size of the mailbox. If an
error occurs, the method returns IMAP_ERROR. To get extended error
information, call GetLastError.
Remarks
The GetMailboxSize method may require a significant amount
of time to calculate the mailbox size if there are a large number of
messages in the mailbox. If the specified mailbox is not currently
selected, then the current mailbox is unselected, the new mailbox is
selected and the size calculated, and then the original mailbox is
re-selected. This will have the side-effect of causing any messages
marked for deletion to be expunged from the mailbox.
Because it can potentially result in long delays, it is not
recommended that an application calculate the mailbox size unless it
is absolutely necessary.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmapv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
CreateMailbox,
GetFirstMailbox,
GetNextMailbox,
RenameMailbox
|