#include <IMAPFolderStatus.hpp>
Public Member Functions | |
| IMAPFolderStatus () | |
| IMAPFolderStatus (const IMAPFolderStatus &other) | |
| size_t | getMessageCount () const |
| size_t | getUnseenCount () const |
| shared_ptr< folderStatus > | clone () const |
| size_t | getRecentCount () const |
| vmime_uint32 | getUIDValidity () const |
| vmime_uint32 | getUIDNext () const |
| vmime_uint64 | getHighestModSeq () const |
| bool | updateFromResponse (const IMAPParser::mailbox_data *resp) |
| bool | updateFromResponse (const IMAPParser::resp_text_code *resp) |
Additional Inherited Members | |
 Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
Holds the status of an IMAP folder.
Constructor & Destructor Documentation
◆ IMAPFolderStatus() [1/2]
| IMAPFolderStatus | ( | ) |
◆ IMAPFolderStatus() [2/2]
| IMAPFolderStatus | ( | const IMAPFolderStatus & | other | ) |
Member Function Documentation
◆ clone()
|
virtual |
Clones this object.
- Returns
- a copy of this object
Implements folderStatus.
References vmime::dynamicCast().
◆ getHighestModSeq()
| vmime_uint64 getHighestModSeq | ( | ) | const |
Returns the highest modification sequence of all messages in the folder, or 0 if not available for this folder, or not supported by the server.
The server must support the CONDSTORE extension for this to be available.
- Returns
- highest modification sequence
◆ getMessageCount()
|
virtual |
Returns the total number of messages in the folder.
- Returns
- number of messages
Implements folderStatus.
◆ getRecentCount()
| size_t getRecentCount | ( | ) | const |
Returns the the number of messages with the Recent flag set.
- Returns
- number of messages flagged Recent
◆ getUIDNext()
| vmime_uint32 getUIDNext | ( | ) | const |
Returns the UID value that will be assigned to a new message in the folder.
If the server does not support the UIDPLUS extension, it will return 0.
- Returns
- UID of the next message
◆ getUIDValidity()
| vmime_uint32 getUIDValidity | ( | ) | const |
Returns the UID validity of the folder for the current session.
If the server is capable of persisting UIDs accross sessions, this value should never change for a folder.
- Returns
- UID validity of the folder
◆ getUnseenCount()
|
virtual |
Returns the number of unseen messages in the folder.
- Returns
- number of unseen messages
Implements folderStatus.
◆ updateFromResponse() [1/2]
Reads the folder status from the specified IMAP response.
- Parameters
-
resp parsed IMAP response
- Returns
- true if the status changed, or false otherwise
References vmime::count(), and vmime::dynamicCast().
◆ updateFromResponse() [2/2]
Reads the folder status from the specified IMAP response.
- Parameters
-
resp parsed IMAP response
- Returns
- true if the status changed, or false otherwise
References vmime::dynamicCast().
The documentation for this class was generated from the following files:
