CP_InternetMessage Class Reference

Base class to handle internet style messages (RFC822) used in sending and receiving information to servers that implement various internet protocols.

Inheritance diagram for CP_InternetMessage:

List of all members.

Public Member Functions
Constructor / Destructor
	CP_InternetMessage ()
	Constructor.
virtual	~CP_InternetMessage () throw ()
	Destructor.
Protected Attributes
CP_String	fBody
CP_String	fHeader
bool	fIsIncomingMessage
bool	fHeaderIsFormatted
Private Member Functions
Initialization
void	Init ()

---

Constructor & Destructor Documentation

CPLAT_Begin_Namespace_CPLAT CP_InternetMessage::CP_InternetMessage (   )

Constructor. Exceptions: none

CP_InternetMessage::~CP_InternetMessage (   )  throw () [virtual]

Constructor. Exceptions: none

---

Member Function Documentation

CP_String CP_InternetMessage::GetBody (   )  const

Return the body section of the message. Exceptions: none  Returns: CP_String const The body of the message.

CP_String CP_InternetMessage::GetHeader (   )  const

Return the header section of the message. Exceptions: none  Returns: CP_String const The header of the message.

void CP_InternetMessage::AddHeaderField (  const CP_String &  inHeaderTag, const CP_String &  inHeaderBody, const CP_String &  inHeaderLineTermination = CP_CRLF )  [virtual]

Adds a new member to the header. Parameters: inHeaderTag  Tag for this item. inHeaderBody  Text of the header item. inHeaderLineTermination  Line termination for this item. Exceptions: none  Returns: void

void CP_InternetMessage::SetBody (  const CP_String &  inBody  )

Sets the body section of the message. Parameters: inBody  The body of the message. Exceptions: none  Returns: void

void CP_InternetMessage::SetHeader (  const CP_String &  inHeader  )

Sets the header section of the message. Parameters: inHeader  The header of the message. Exceptions: none  Returns: void

void CP_InternetMessage::SetIsIncomingMessage (  bool  inIsIncoming  )

Set the flag to indicate if this is a message we are receiving, or sending. If inIsIncoming is true, then this is a received message. Parameters: inIsIncoming  Flag to indicate if incoming message. Exceptions: none  Returns: void

void CP_InternetMessage::SetIsHeaderFormatted (  bool  inIsFormatted  )

Set a flag to indicate if the header is formatted for sending. Parameters: inIsFormatted  Flag to indicate if the message is formatted for sending. Exceptions: none  Returns: void

bool CP_InternetMessage::IsIncomingMessage (   )

Returns the IsIncomingMessage flag. Exceptions: none  Returns: bool True if the message is incoming.

bool CP_InternetMessage::IsHeaderFormatted (   )

Returns the flag to indicate if the message is formatted for sending. Exceptions: none  Returns: bool True if the message is formatted.

void CP_InternetMessage::Init (   )  [private]

Initialize all data members to default or empty values. Exceptions: none  Returns: void Reimplemented in CP_MailMessage.

---

Member Data Documentation

CP_String CP_InternetMessage::fBody [protected]

CP_String CP_InternetMessage::fHeader [protected]

The body of the message in a CP_String object.

bool CP_InternetMessage::fIsIncomingMessage [protected]

The header of the message in a CP_String object.

bool CP_InternetMessage::fHeaderIsFormatted [protected]

Flag to indicate if this is an incoming message.

---

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

• CP_InternetMessage.h
• CP_InternetMessage.cpp

---