#include <messageSet.hpp>
Public Member Functions | |
| UIDMessageRange (const message::uid &uid) | |
| UIDMessageRange (const message::uid &first, const message::uid &last) | |
| UIDMessageRange (const UIDMessageRange &other) | |
| const message::uid | getFirst () const |
| const message::uid | getLast () const |
| void | enumerate (messageSetEnumerator &en) const |
| messageRange * | clone () const |
Additional Inherited Members | |
| Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
A range of (continuous) messages represented by their UID.
Constructor & Destructor Documentation
◆ UIDMessageRange() [1/3]
| UIDMessageRange | ( | const message::uid & | uid | ) |
Constructs a message range containing a single message.
- Parameters
-
uid message UID
Referenced by clone(), and UIDMessageRange().
◆ UIDMessageRange() [2/3]
| UIDMessageRange | ( | const message::uid & | first, |
| const message::uid & | last ) |
Constructs a message range for multiple messages.
- Parameters
-
first UID of the first message in the range last UID of the last message in the range, or use the special value '*' to designate the last message in the folder
◆ UIDMessageRange() [3/3]
| UIDMessageRange | ( | const UIDMessageRange & | other | ) |
Constructs a message range by copying from another range.
- Parameters
-
other range to copy
References messageRange::messageRange(), and UIDMessageRange().
Member Function Documentation
◆ clone()
|
virtual |
Clones this message range.
Implements messageRange.
References messageRange::messageRange(), and UIDMessageRange().
◆ enumerate()
|
virtual |
Enumerates this range with the specified enumerator.
- Parameters
-
en enumerator that will receive the method calls while enumerating this range
Implements messageRange.
References messageSetEnumerator::enumerateUIDMessageRange().
◆ getFirst()
| const message::uid getFirst | ( | ) | const |
Returns the UID of the first message in the range.
- Returns
- UID of the first message
◆ getLast()
| const message::uid getLast | ( | ) | const |
Returns the UID of the last message in the range, or '*' to designate the last message in the folder.
- Returns
- UID of the last message
The documentation for this class was generated from the following files:
