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

Public Member Functions

 numberMessageRange (const size_t number)
 
 numberMessageRange (const size_t first, const size_t last)
 
 numberMessageRange (const numberMessageRange &other)
 
size_t getFirst () const
 
size_t 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 designated by their sequence number.

Constructor & Destructor Documentation

◆ numberMessageRange() [1/3]

numberMessageRange ( const size_t  number)

Constructs a message range containing a single message.

Parameters
numbermessage number (numbering starts at 1, not 0)

Referenced by numberMessageRange::clone().

◆ numberMessageRange() [2/3]

numberMessageRange ( const size_t  first,
const size_t  last 
)

Constructs a message range for multiple messages.

Parameters
firstnumber of the first message in the range (numbering starts at 1, not 0)
lastnumber of the last message in the range, or use the special value -1 to designate the last message in the folder

◆ numberMessageRange() [3/3]

Constructs a message range by copying from another range.

Parameters
otherrange to copy

Member Function Documentation

◆ clone()

messageRange * clone ( ) const
virtual

Clones this message range.

Implements messageRange.

References numberMessageRange::numberMessageRange().

◆ enumerate()

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::enumerateNumberMessageRange().

◆ getFirst()

size_t getFirst ( ) const

Returns the number of the first message in the range.

Returns
number of the first message

◆ getLast()

size_t getLast ( ) const

Returns the number of the last message in the range, or -1 to designate the last message in the folder.

Returns
number of the last message

The documentation for this class was generated from the following files: