CImMimeHeader Class Reference

#include <mw/miuthdr.h>

Link against: imcm.lib

class CImMimeHeader : public CBase

Inherits from

CImMimeHeader
- CBase

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()

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()

Detailed Description

Stores a MIME email header.

Constructor & Destructor Documentation

~CImMimeHeader ( )

IMPORT_C

~CImMimeHeader

(

)

Destructor.

Member Function Documentation

ContentBase ( )

IMPORT_C const TPtrC8

ContentBase

(

)

const

Gets the Content-Base field value.

Return Value: Field value

ContentDescription ( )

IMPORT_C const TPtrC8

ContentDescription

(

)

const

Gets the Content-Description field value.

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

Return Value: Field value

ContentDisposition ( )

IMPORT_C const TPtrC8

ContentDisposition

(

)

const

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

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

Return Value: Field value

ContentDispositionParams ( )

const CDesC8Array &

ContentDispositionParams

(

)

const [inline]

ContentDispositionParams ( )

CDesC8Array &

ContentDispositionParams

(

)

[inline]

ContentID ( )

IMPORT_C const TPtrC8

ContentID

(

)

const

Gets the Content-ID field value.

Return Value: Field value

ContentLocation ( )

IMPORT_C const TPtrC16

ContentLocation

(

)

const

Gets the Content-Location field value.

Return Value: Field value

ContentSubType ( )

IMPORT_C const TPtrC8

ContentSubType

(

)

const

Gets 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.

Return Value: Field value

ContentTransferEncoding ( )

IMPORT_C TImEncodingType

ContentTransferEncoding

(

)

const

Gets the Content-Transfer-Encoding field value.

Return Value: Field value

ContentTransferEncoding ( TDes8 & )

IMPORT_C TImEncodingType

ContentTransferEncoding

(

TDes8 &

rType

)

const

Gets the Content-Transfer-Encoding field value as a string.

Parameters
rType	On return, the field value as a string

Return Value: Field value

ContentType ( )

IMPORT_C const TPtrC8

ContentType

(

)

const

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

Return Value: Field value

ContentTypeParams ( )

const CDesC8Array &

ContentTypeParams

(

)

const [inline]

ContentTypeParams ( )

CDesC8Array &

ContentTypeParams

(

)

[inline]

ExternalizeL ( RMsvWriteStream & )

IMPORT_C void

ExternalizeL

(

RMsvWriteStream &

aWriteStream

)

const

Externalises the settings to a specified stream.

Parameters
aWriteStream	Stream to write to

GetContentTypeValue ( const TDesC8 & )

IMPORT_C const TPtrC8

GetContentTypeValue

(

const TDesC8 &

aContentTypeParameter

)

const

Gets the value for a particular Content-Type parameter.

For example, for "content-type: text/plain; name=umlaut.txt", GetContentType(_L8("name")) returns "umlaut.txt".

Parameters
aContentTypeParameter	Parameter type

Return Value: Parameter value

InternalizeL ( RMsvReadStream & )

IMPORT_C void

InternalizeL

(

RMsvReadStream &

aReadStream

)

Internalises the settings from a specified stream.

Parameters
aReadStream	Stream to read from

MimeCharset ( )

IMPORT_C TUint

MimeCharset

(

)

const

Gets the character set used in decoding the email MIME part.

UID values for different MIME charsets are in charconv.h

Return Value: Character set

NewL ( )

IMPORT_C CImMimeHeader *

NewL

(

)

[static]

Allocates and creates a new CImMimeHeader object.

Return Value: New CImMimeHeader object

NewLC ( )

IMPORT_C CImMimeHeader *

NewLC

(

)

[static]

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

Return Value: New CImMimeHeader object

RelativePath ( )

IMPORT_C const TPtrC8

RelativePath

(

)

const

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

Return Value: Relative location

Reset ( )

IMPORT_C void

Reset

(

)

Resets all header field values.

RestoreL ( CMsvStore & )

IMPORT_C void

RestoreL

(

CMsvStore &

aMessageStore

)

Restores settings from a specified message store.

Parameters
aMessageStore	Message store to read from

SetContentBaseL ( const TDesC8 & )

IMPORT_C void

SetContentBaseL

(

const TDesC8 &

aPath

)

Sets the Content-Base field value.

Parameters
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.

Sets the Content-Description field value.

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

Parameters
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.

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

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

Parameters
aPath	Field value

SetContentIDL ( const TDesC8 & )

IMPORT_C void

SetContentIDL

(

const TDesC8 &

aPath

)

Sets the Content-ID field value.

Parameters
aPath	Field value

SetContentLocationL ( const TDesC16 & )

IMPORT_C void

SetContentLocationL

(

const TDesC16 &

aPath

)

Sets the Content-Location field value.

Parameters
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.

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
aPath	Field value

SetContentTransferEncodingL ( const TDesC8 & )

IMPORT_C void

SetContentTransferEncodingL

(

const TDesC8 &

aType

)

Sets the Content-Transfer-Encoding field value.

Parameters
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.

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
aPath	Field value

SetMimeCharset ( const TUint )

IMPORT_C void

SetMimeCharset

(

const TUint

aCharset

)

Sets the character set used in decoding the email MIME part.

UID values for different MIME charsets are in charconv.h

Parameters
aCharset	Character set

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
aPath	Relative location

SetVersion ( TUint16 )

void

SetVersion

(

TUint16

aVersion

)

[inline]

Size ( )

IMPORT_C TInt

Size

(

)

Estimates the size of the MIME header, constructed using the values stored.

Return Value: Size (bytes)

StoreL ( CMsvStore & )

IMPORT_C void

StoreL

(

CMsvStore &

aMessageStore

)

const

Stores settings to a specified message store.

Parameters
aMessageStore	Message store to write to

StoreWithoutCommitL ( CMsvStore & )

IMPORT_C void

StoreWithoutCommitL

(

CMsvStore &

aMessageStore

)

const

Stores, but does not commit, settings to a specified message store.

Parameters
aMessageStore	Message store to write to

Version ( )

const TUint16

Version

(

)

const [inline]

XTypeParams ( )

const CDesC8Array &

XTypeParams

(

)

const [inline]

XTypeParams ( )

CDesC8Array &

XTypeParams

(

)

[inline]