Collapse all Symbian^3 Product Developer Library

CImEncodedHeader Class Reference

class CImEncodedHeader : public CBase

Encapsulates an undecoded Internet Mail header. This class encapsulates the 8 bit data of supported fields for the CImHeader prior to decoding. It allows this information to populate an associated CImHeader class for redecoding.

Inherits from

CImEncodedHeader
- CBase

Public Member Functions
	~CImEncodedHeader()
CDesCArray &	BccRecipients()
const CDesCArray &	BccRecipients()
CDesCArray &	CcRecipients()
const CDesCArray &	CcRecipients()
void	CopyFromHeaderL(const CImHeader &, TBool)
void	CopyToHeaderL(CImHeader &)
TInt	DataSize()
TUint	DecodeCharset()
void	ExternalizeL(RMsvWriteStream &)
const TPtrC8	From()
void	InternalizeL(RMsvReadStream &)
CImEncodedHeader *	NewL()
CImEncodedHeader *	NewLC()
const TPtrC8	ReplyTo()
void	Reset()
void	RestoreL(CMsvStore &)
void	SetDecodeCharset(TUint)
void	SetFromL(const TDesC8 &)
void	SetReplyToL(const TDesC8 &)
void	SetSubjectL(const TDesC8 &)
void	SetVersion(TUint16)
void	StoreL(CMsvStore &)
const TPtrC8	Subject()
CDesCArray &	ToRecipients()
const CDesCArray &	ToRecipients()
TUint16	Version()

Private Member Functions
	CImEncodedHeader()
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CDesCArray *	iBcc
CDesCArray *	iCc
TUint	iDecodeCharset
HBufC8 *	iFrom
HBufC8 *	iReplyTo
HBufC8 *	iSubject
CDesCArray *	iTo
TUint16	iVersion

Constructor & Destructor Documentation

CImEncodedHeader()

CImEncodedHeader

(

)

[private]

~CImEncodedHeader()

~CImEncodedHeader

(

)

Member Functions Documentation

BccRecipients()

CDesCArray &

BccRecipients

(

)

Gets a list of "Bcc" recipients.

BccRecipients()

const CDesCArray &

BccRecipients

(

)

const

Gets a const list of "Bcc" recipients.

CcRecipients()

CDesCArray &

CcRecipients

(

)

Gets a list of "Cc" recipients.

CcRecipients()

const CDesCArray &

CcRecipients

(

)

const

Gets a const list of "Cc" recipients.

ConstructL()

void

ConstructL

(

)

[private]

CopyFromHeaderL(const CImHeader &, TBool)

void	CopyFromHeaderL	(	const CImHeader &	aFromHeader,
			TBool	aDeleteExistingData = false
		)

Parameters

const CImHeader & aFromHeader
TBool aDeleteExistingData = false

CopyToHeaderL(CImHeader &)

void

CopyToHeaderL

(

CImHeader &

aToHeader

)

const

Parameters

CImHeader & aToHeader

DataSize()

TInt

DataSize

(

)

const

Gets the combined length of all the field values stored.

DecodeCharset()

TUint

DecodeCharset

(

)

const

ExternalizeL(RMsvWriteStream &)

void

ExternalizeL

(

RMsvWriteStream &

aWriteStream

)

const

Externalises the settings to a specified stream.

Parameters

RMsvWriteStream & aWriteStream

Stream to write to

From()

const TPtrC8

From

(

)

const

Gets the "From" header field.

This consists of an address and (possibly) an alias.

InternalizeL(RMsvReadStream &)

void

InternalizeL

(

RMsvReadStream &

aReadStream

)

Internalises the settings from a specified stream.

Parameters

RMsvReadStream & aReadStream

Stream to read from

NewL()

CImEncodedHeader *

NewL

(

)

[static]

Allocates and creates a new CImHeader object, leaving the object on the cleanup stack.

NewLC()

CImEncodedHeader *

NewLC

(

)

[static]

Allocates and creates a new CImHeader object, leaving the object on the cleanup stack.

ReplyTo()

const TPtrC8

ReplyTo

(

)

const

Gets the "ReplyTo" header field.

Reset()

void

Reset

(

)

RestoreL(CMsvStore &)

void

RestoreL

(

CMsvStore &

aMessageStore

)

Restores settings from a specified message store.

Parameters

CMsvStore & aMessageStore

Message store to read from

SetDecodeCharset(TUint)

void

SetDecodeCharset

(

TUint

aCharset

)

Parameters

TUint aCharset

SetFromL(const TDesC8 &)

void

SetFromL

(

const TDesC8 &

aFrom

)

Sets the "From" header field.

Parameters

const TDesC8 & aFrom

Field value

SetReplyToL(const TDesC8 &)

void

SetReplyToL

(

const TDesC8 &

aReplyTo

)

Sets the "ReplyTo" header field.

Parameters

const TDesC8 & aReplyTo

Field value

SetSubjectL(const TDesC8 &)

void

SetSubjectL

(

const TDesC8 &

aSubject

)

Sets the "Subject" header field.

Parameters

const TDesC8 & aSubject

Field value

SetVersion(TUint16)

void

SetVersion

(

TUint16

aVersion

)

Parameters

TUint16 aVersion

StoreL(CMsvStore &)

void

StoreL

(

CMsvStore &

aMessageStore

)

const

Stores settings to a specified message store.

Parameters

CMsvStore & aMessageStore

Message store to write to

Subject()

const TPtrC8

Subject

(

)

const

Gets the "Subject" header field.

ToRecipients()

CDesCArray &

ToRecipients

(

)

ToRecipients()

const CDesCArray &

ToRecipients

(

)

const

Gets a const list of "To" recipients.

Version()

TUint16

Version

(

)

const

Member Data Documentation

CDesCArray * iBcc

CDesCArray *

iBcc

[private]

CDesCArray * iCc

CDesCArray *

iCc

[private]

TUint iDecodeCharset

TUint

iDecodeCharset

[private]

HBufC8 * iFrom

HBufC8 *

iFrom

[private]

HBufC8 * iReplyTo

HBufC8 *

iReplyTo

[private]

HBufC8 * iSubject

HBufC8 *

iSubject

[private]

CDesCArray * iTo

CDesCArray *

iTo

[private]

TUint16 iVersion

TUint16

iVersion

[private]