SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWPop3StatReply Class Reference

Used to parse additional reply data returned in response to the POP3 STAT command. More...

#include <rw/pop3/RWPop3StatReply.h>

Inheritance diagram for RWPop3StatReply:
RWPop3Reply RWReply

Public Member Functions

 RWPop3StatReply (void)
 
int getMessageCount (void) const
 
int getOctets (void) const
 
- Public Member Functions inherited from RWPop3Reply
 RWPop3Reply (void)
 
RWCString getData (void) const
 
bool isErr (void) const
 
bool isOk (void) const
 
- Public Member Functions inherited from RWReply
 RWReply (void)
 
virtual ~RWReply (void)
 
virtual void clearAndDestroy (void)
 
virtual bool isComplete (void) const
 
virtual bool isValid (void) const
 

Private Member Functions

virtual void parse (void)
 

Related Symbols

(Note that these are not member symbols.)

std::ostream & operator<< (std::ostream &str, const RWPop3StatReply &r)
 

Additional Inherited Members

- Protected Types inherited from RWPop3Reply
enum  resultCode { CODE_UNKNOWN , CODE_OK , CODE_ERR }
 
- Protected Member Functions inherited from RWPop3Reply
void readFromPortal (const RWPortal &portal)
 
- Protected Attributes inherited from RWPop3Reply
RWCString data_
 
- Protected Attributes inherited from RWReply
bool complete_
 
bool valid_
 

Detailed Description

RWPop3StatReply is derived from RWPop3Reply. RWPop3StatReply parses out additional reply data returned in response to the POP3 STAT command. This data includes the number of messages waiting in the maildrop, and the number of octets consumed by those messages.

Constructor & Destructor Documentation

◆ RWPop3StatReply()

RWPop3StatReply::RWPop3StatReply ( void )

Default constructor.

Member Function Documentation

◆ getMessageCount()

int RWPop3StatReply::getMessageCount ( void ) const

Returns the number of messages waiting in the mail drop.

◆ getOctets()

int RWPop3StatReply::getOctets ( void ) const

Returns the total size (in octets) of the messages waiting in the mail drop.

◆ parse()

virtual void RWPop3StatReply::parse ( void )
privatevirtual

Performs an extended parse to obtain the number of waiting messages and their total size.

Reimplemented from RWPop3Reply.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & str,
const RWPop3StatReply & r )
friend

Outputs an RWPop3StatReply object to an std::ostream.

Note
RWPop3StatReply does not have an extraction (>>) operator.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.