VMime
UIDMessageRange Class Reference
Inheritance diagram for UIDMessageRange:
Collaboration diagram for UIDMessageRange:

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
 
messageRangeclone () const
 
- Public Member Functions inherited from messageRange
virtual ~messageRange ()
 

Additional Inherited Members

- Protected Member Functions inherited from messageRange
 messageRange ()
 
 messageRange (const messageRange &)
 
- Protected Member Functions inherited from object
 object ()
 
 object (const object &)
 
objectoperator= (const object &)
 
virtual ~object ()
 

Detailed Description

A range of (continuous) messages represented by their UID.

Constructor & Destructor Documentation

UIDMessageRange ( const message::uid uid)

Constructs a message range containing a single message.

Parameters
uidmessage UID

Referenced by UIDMessageRange::clone().

UIDMessageRange ( const message::uid first,
const message::uid last 
)

Constructs a message range for multiple messages.

Parameters
firstUID of the first message in the range
lastUID of the last message in the range, or use the special value '*' to designate the last message in the folder
UIDMessageRange ( const UIDMessageRange other)

Constructs a message range by copying from another range.

Parameters
otherrange to copy

Member Function Documentation

messageRange * clone ( ) const
virtual

Clones this message range.

Implements messageRange.

References UIDMessageRange::UIDMessageRange().

void enumerate ( messageSetEnumerator en) const
virtual

Enumerates this range with the specified enumerator.

Parameters
enenumerator that will receive the method calls while enumerating this range

Implements messageRange.

References messageSetEnumerator::enumerateUIDMessageRange().

const message::uid getFirst ( ) const

Returns the UID of the first message in the range.

Returns
UID of the first message
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: