Hunny Software Home || Hunny MIME++ Home || Hunny Mail++ Home

Main Page | Class Hierarchy | Class List | Class Members

EnvelopeData Class Reference

List of all members.

Detailed Description

EnvelopeData is a class that contains the data of an IMAP4 ENVELOPE structure.

An ENVELOPE structure is an optional data item in an IMAP4 FETCH response. The structure contains information obtained from the header fields of a message stored on the server. EnvelopeData contains accessor functions to access the fields of the ENVELOPE structure.


Public Member Functions

 EnvelopeData ()
 Default constructor.
 EnvelopeData (const EnvelopeData &other)
 Copy constructor.
virtual ~EnvelopeData ()
 Destructor.
EnvelopeData & operator= (const EnvelopeData &other)
 Assignment operator.
const char * Date () const
 Gets the value of the Date header field.
const char * Subject () const
 Gets the value of the Subject header field.
const char * InReplyTo () const
 Gets the value of the In-Reply-To header field.
const char * MessageId () const
 Gets the value of the Message-ID header field.
unsigned NumFrom () const
 Gets the number of From addresses.
const AddressData & From (unsigned index) const
 Gets the From address at the specified position.
unsigned NumSender () const
 Gets the number of Sender addresses.
const AddressData & Sender (unsigned index) const
 Gets the Sender address at the specified position.
unsigned NumReplyTo () const
 Gets the number of Reply-To addresses.
const AddressData & ReplyTo (unsigned index) const
 Gets the Reply-To address at the specified position.
unsigned NumTo () const
 Gets the number of To addresses.
const AddressData & To (unsigned index) const
 Gets the To address at the specified position.
unsigned NumCc () const
 Gets the number of Cc addresses.
const AddressData & Cc (unsigned index) const
 Gets the Cc address at the specified position.
unsigned NumBcc () const
 Gets the number of Bcc addresses.
const AddressData & Bcc (unsigned index) const
 Gets the Bcc address at the specified position.
void ImportData (const ListItem *root)
 Called by the parser to set the data for this object.

Constructor & Destructor Documentation

EnvelopeData (   ) 
 

Default constructor.

EnvelopeData (  const EnvelopeData &  other  ) 
 

Copy constructor.

Parameters:
other other object to copy

~EnvelopeData (   )  [virtual]
 

Destructor.

Member Function Documentation

const AddressData & Bcc (  unsigned  index  )  const
 

Gets the Bcc address at the specified position.

The parameter index must satisfy the constraint index < NumBcc().

Parameters:
index position of address to return
Returns:
Bcc address at specified position

const AddressData & Cc (  unsigned  index  )  const
 

Gets the Cc address at the specified position.

The parameter index must satisfy the constraint index < NumCc().

Parameters:
index position of address to return
Returns:
Cc address at specified position

const char * Date (   )  const
 

Gets the value of the Date header field.

Returns:
date of message in RFC 2822 format

const AddressData & From (  unsigned  index  )  const
 

Gets the From address at the specified position.

The parameter index must satisfy the constraint index < NumFrom().

Parameters:
index position of address to return
Returns:
From address at specified position

void ImportData (  const ListItem *  root  ) 
 

Called by the parser to set the data for this object.

Only the parser should call this function.

Parameters:
root root item of parse tree

const char * InReplyTo (   )  const
 

Gets the value of the In-Reply-To header field.

Returns:
content of In-Reply-To header field (possibly empty string)

const char * MessageId (   )  const
 

Gets the value of the Message-ID header field.

Returns:
content of Message-Id header field (possibly empty string)

unsigned NumBcc (   )  const
 

Gets the number of addresses in the Bcc header field.

Returns:
number of Bcc addresses

unsigned NumCc (   )  const
 

Gets the number of addresses in the Cc header field.

Returns:
number of Cc addresses

unsigned NumFrom (   )  const
 

Gets the number of addresses in the From header field.

Returns:
number of From addresses

unsigned NumReplyTo (   )  const
 

Gets the number of addresses in the Reply-To header field.

Returns:
number of Reply-To addresses

unsigned NumSender (   )  const
 

Gets the number of addresses in the Sender header field.

Returns:
number of Sender addresses

unsigned NumTo (   )  const
 

Gets the number of addresses in the To header field.

Returns:
number of To addresses

EnvelopeData & operator= (  const EnvelopeData &  other  ) 
 

Assignment operator.

Parameters:
other other object to copy
Returns:
*this

const AddressData & ReplyTo (  unsigned  index  )  const
 

Gets the Reply-To address at the specified position.

The parameter index must satisfy the constraint index < NumReplyTo().

Parameters:
index position of address to return
Returns:
Reply-To address at specified position

const AddressData & Sender (  unsigned  index  )  const
 

Gets the Sender address at the specified position.

The parameter index must satisfy the constraint index < NumSender().

Parameters:
index position of address to return
Returns:
Sender address at specified position

const char * Subject (   )  const
 

Gets the value of the Subject header field.

Returns:
subject of message (possibly empty string)

const AddressData & To (  unsigned  index  )  const
 

Gets the To address at the specified position.

The parameter index must satisfy the constraint index < NumTo().

Parameters:
index position of address to return
Returns:
To address at specified position

Copyright © 2001-2005 Hunny Software, Inc. All rights reserved.