CImMimeHeader Class Reference

class CImMimeHeader : public CBase

Stores a MIME email header.

Inherits from

Public Member Functions
~CImMimeHeader ()
IMPORT_C const TPtrC8 ContentBase ()
IMPORT_C const TPtrC8 ContentDescription ()
IMPORT_C const TPtrC8 ContentDisposition ()
const CDesC8Array & ContentDispositionParams ()
CDesC8Array & ContentDispositionParams ()
IMPORT_C const TPtrC8 ContentID ()
IMPORT_C const TPtrC16 ContentLocation ()
IMPORT_C const TPtrC8 ContentSubType ()
IMPORT_C TImEncodingType ContentTransferEncoding ()
IMPORT_C TImEncodingType ContentTransferEncoding ( TDes8 &)
IMPORT_C const TPtrC8 ContentType ()
const CDesC8Array & ContentTypeParams ()
CDesC8Array & ContentTypeParams ()
IMPORT_C void ExternalizeL ( RMsvWriteStream &)
IMPORT_C const TPtrC8 GetContentTypeValue (const TDesC8 &)
IMPORT_C void InternalizeL ( RMsvReadStream &)
IMPORT_C TUint MimeCharset ()
IMPORT_C CImMimeHeader * NewL ()
IMPORT_C CImMimeHeader * NewLC ()
IMPORT_C const TPtrC8 RelativePath ()
IMPORT_C void Reset ()
IMPORT_C void RestoreL ( CMsvStore &)
IMPORT_C void SetContentBaseL (const TDesC8 &)
IMPORT_C void SetContentDescriptionL (const TDesC8 &)
IMPORT_C void SetContentDispositionL (const TDesC8 &)
IMPORT_C void SetContentIDL (const TDesC8 &)
IMPORT_C void SetContentLocationL (const TDesC16 &)
IMPORT_C void SetContentSubTypeL (const TDesC8 &)
IMPORT_C void SetContentTransferEncodingL (const TDesC8 &)
IMPORT_C void SetContentTypeL (const TDesC8 &)
IMPORT_C void SetMimeCharset (const TUint )
IMPORT_C void SetRelativePathL (const TDesC8 &)
void SetVersion ( TUint16 )
IMPORT_C TInt Size ()
IMPORT_C void StoreL ( CMsvStore &)
IMPORT_C void StoreWithoutCommitL ( CMsvStore &)
const TUint16 Version ()
const CDesC8Array & XTypeParams ()
CDesC8Array & XTypeParams ()
Private Member Functions
CImMimeHeader ()
TBool ArrayEntryExists ( CDesCArray &, TInt )
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
HBufC8 * iContentBase
HBufC8 * iContentDescription
HBufC8 * iContentDisposition
CDesC8Array * iContentDispositionParams
HBufC8 * iContentID
HBufC16 * iContentLocation
HBufC8 * iContentSubType
TImEncodingType iContentTransferEncoding
TBuf < 20 > iContentTransferEncodingBuffer
HBufC8 * iContentType
CDesC8Array * iContentTypeParams
TUint iMimeCharset
HBufC8 * iRelativePath
TUint16 iVersion
CDesC8Array * iXTypeParams

Constructor & Destructor Documentation

CImMimeHeader()

CImMimeHeader ( ) [private]

~CImMimeHeader()

IMPORT_C ~CImMimeHeader ( )

Member Functions Documentation

ArrayEntryExists(CDesCArray &, TInt)

TBool ArrayEntryExists ( CDesCArray & aArray,
TInt aField
) [private]

Parameters

CDesCArray & aArray
TInt aField

ConstructL()

void ConstructL ( ) [private]

ContentBase()

IMPORT_C const TPtrC8 ContentBase ( ) const

ContentDescription()

IMPORT_C const TPtrC8 ContentDescription ( ) const

ContentDisposition()

IMPORT_C const TPtrC8 ContentDisposition ( ) const

ContentDispositionParams()

const CDesC8Array & ContentDispositionParams ( ) const [inline]

Gets the const Content-Disposition parameters and their associated values.

ContentDispositionParams()

CDesC8Array & ContentDispositionParams ( ) [inline]

Gets the Content-Disposition parameters and their associated values.

ContentID()

IMPORT_C const TPtrC8 ContentID ( ) const

ContentLocation()

IMPORT_C const TPtrC16 ContentLocation ( ) const

ContentSubType()

IMPORT_C const TPtrC8 ContentSubType ( ) const

ContentTransferEncoding()

IMPORT_C TImEncodingType ContentTransferEncoding ( ) const

ContentTransferEncoding(TDes8 &)

IMPORT_C TImEncodingType ContentTransferEncoding ( TDes8 & rType ) const

Parameters

TDes8 & rType

ContentType()

IMPORT_C const TPtrC8 ContentType ( ) const

ContentTypeParams()

const CDesC8Array & ContentTypeParams ( ) const [inline]

Gets the const Content-Type parameters and their associated values.

ContentTypeParams()

CDesC8Array & ContentTypeParams ( ) [inline]

Gets the Content-Type parameters and their associated values.

ExternalizeL(RMsvWriteStream &)

IMPORT_C void ExternalizeL ( RMsvWriteStream & aWriteStream ) const

Parameters

RMsvWriteStream & aWriteStream

GetContentTypeValue(const TDesC8 &)

IMPORT_C const TPtrC8 GetContentTypeValue ( const TDesC8 & aContentTypeParameter ) const

Parameters

const TDesC8 & aContentTypeParameter

InternalizeL(RMsvReadStream &)

IMPORT_C void InternalizeL ( RMsvReadStream & aReadStream )

Parameters

RMsvReadStream & aReadStream

MimeCharset()

IMPORT_C TUint MimeCharset ( ) const

NewL()

IMPORT_C CImMimeHeader * NewL ( ) [static]

NewLC()

IMPORT_C CImMimeHeader * NewLC ( ) [static]

RelativePath()

IMPORT_C const TPtrC8 RelativePath ( ) const

Reset()

IMPORT_C void Reset ( )

RestoreL(CMsvStore &)

IMPORT_C void RestoreL ( CMsvStore & aMessageStore )

Parameters

CMsvStore & aMessageStore

SetContentBaseL(const TDesC8 &)

IMPORT_C void SetContentBaseL ( const TDesC8 & aPath )

Sets the Content-Base field value.

Parameters

const TDesC8 & aPath Field value

SetContentDescriptionL(const TDesC8 &)

IMPORT_C void SetContentDescriptionL ( const TDesC8 & aPath )

Sets the Content-Description field value.

The value is MIME defined and should always be 8-bit.

Parameters

const TDesC8 & aPath Field value

SetContentDispositionL(const TDesC8 &)

IMPORT_C void SetContentDispositionL ( const TDesC8 & aPath )

Sets the Content-Disposition field value (either inline or attachment).

The value is MIME defined and should always be 8-bit.

Parameters

const TDesC8 & aPath Field value

SetContentIDL(const TDesC8 &)

IMPORT_C void SetContentIDL ( const TDesC8 & aPath )

Sets the Content-ID field value.

Parameters

const TDesC8 & aPath Field value

SetContentLocationL(const TDesC16 &)

IMPORT_C void SetContentLocationL ( const TDesC16 & aPath )

Sets the Content-Location field value.

Parameters

const TDesC16 & aPath Field value

SetContentSubTypeL(const TDesC8 &)

IMPORT_C void SetContentSubTypeL ( const TDesC8 & aPath )

Sets the Content-Type subtype field value (e.g. "plain" in Content-Type:text/plain).

The value is MIME defined and should always be 8-bit.

Parameters

const TDesC8 & aPath Field value

SetContentTransferEncodingL(const TDesC8 &)

IMPORT_C void SetContentTransferEncodingL ( const TDesC8 & aType )

Sets the Content-Transfer-Encoding field value.

Parameters

const TDesC8 & aType Field value

SetContentTypeL(const TDesC8 &)

IMPORT_C void SetContentTypeL ( const TDesC8 & aPath )

Sets the Content-Type field value (e.g. "text" in Content-Type:text/plain).

The value is MIME defined and should always be 8-bit.

Parameters

const TDesC8 & aPath Field value

SetMimeCharset(const TUint)

IMPORT_C void SetMimeCharset ( const TUint aCharset )

Parameters

const TUint aCharset

SetRelativePathL(const TDesC8 &)

IMPORT_C void SetRelativePathL ( const TDesC8 & aPath )

Sets IMAP-specific information for the relative location of the entry to the parent email message.

Parameters

const TDesC8 & aPath Relative location

SetVersion(TUint16)

void SetVersion ( TUint16 aVersion ) [inline]

Parameters

TUint16 aVersion

Size()

IMPORT_C TInt Size ( )

StoreL(CMsvStore &)

IMPORT_C void StoreL ( CMsvStore & aMessageStore ) const

Parameters

CMsvStore & aMessageStore

StoreWithoutCommitL(CMsvStore &)

IMPORT_C void StoreWithoutCommitL ( CMsvStore & aMessageStore ) const

Parameters

CMsvStore & aMessageStore

Version()

const TUint16 Version ( ) const [inline]

XTypeParams()

const CDesC8Array & XTypeParams ( ) const [inline]

Gets the const MIME header parameters and their associated values. This can be used by any MIME header fields.

XTypeParams()

CDesC8Array & XTypeParams ( ) [inline]

Gets the MIME header parameters and their associated values. This can be used by any MIME header fields.

Member Data Documentation

HBufC8 * iContentBase

HBufC8 * iContentBase [private]

HBufC8 * iContentDescription

HBufC8 * iContentDescription [private]

HBufC8 * iContentDisposition

HBufC8 * iContentDisposition [private]

CDesC8Array * iContentDispositionParams

CDesC8Array * iContentDispositionParams [private]

HBufC8 * iContentID

HBufC8 * iContentID [private]

HBufC16 * iContentLocation

HBufC16 * iContentLocation [private]

HBufC8 * iContentSubType

HBufC8 * iContentSubType [private]

TImEncodingType iContentTransferEncoding

TImEncodingType iContentTransferEncoding [private]

TBuf< 20 > iContentTransferEncodingBuffer

TBuf < 20 > iContentTransferEncodingBuffer [private]

HBufC8 * iContentType

HBufC8 * iContentType [private]

CDesC8Array * iContentTypeParams

CDesC8Array * iContentTypeParams [private]

TUint iMimeCharset

TUint iMimeCharset [private]

HBufC8 * iRelativePath

HBufC8 * iRelativePath [private]

TUint16 iVersion

TUint16 iVersion [private]

CDesC8Array * iXTypeParams

CDesC8Array * iXTypeParams [private]