Class CImMimeHeader

class CImMimeHeader : public CBase;

Description

Stores a MIME email header.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CImMimeHeader - Stores a MIME email header

Members

Defined in CImMimeHeader:
ContentBase(), ContentDescription(), ContentDisposition(), ContentDispositionParams(), ContentDispositionParams(), ContentID(), ContentLocation(), ContentSubType(), ContentTransferEncoding(), ContentTransferEncoding(), ContentType(), ContentTypeParams(), ContentTypeParams(), ExternalizeL(), GetContentTypeValue(), InternalizeL(), MimeCharset(), NewL(), NewLC(), RelativePath(), Reset(), RestoreL(), SetContentBaseL(), SetContentDescriptionL(), SetContentDispositionL(), SetContentIDL(), SetContentLocationL(), SetContentSubTypeL(), SetContentTransferEncodingL(), SetContentTypeL(), SetMimeCharset(), SetRelativePathL(), SetVersion(), Size(), StoreL(), StoreWithoutCommitL(), Version(), XTypeParams(), XTypeParams(), ~CImMimeHeader()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CImMimeHeader *NewLC();

Description

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

Return value

CImMimeHeader * New CImMimeHeader object

static IMPORT_C CImMimeHeader *NewL();

Description

Allocates and creates a new CImMimeHeader object.

Return value

CImMimeHeader * New CImMimeHeader object

IMPORT_C ~CImMimeHeader();

Description

Destructor.

IMPORT_C void Reset();

Description

Resets all header field values.

IMPORT_C TInt Size();

Description

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

Return value

TInt Size (bytes)

IMPORT_C void InternalizeL(RMsvReadStream &aReadStream);

Description

Internalises the settings from a specified stream.

Parameters

RMsvReadStream &aReadStream Stream to read from

IMPORT_C void ExternalizeL(RMsvWriteStream &aWriteStream) const;

Description

Externalises the settings to a specified stream.

Parameters

RMsvWriteStream &aWriteStream Stream to write to

IMPORT_C void RestoreL(CMsvStore &aMessageStore);

Description

Restores settings from a specified message store.

Parameters

CMsvStore &aMessageStore Message store to read from

IMPORT_C void StoreL(CMsvStore &aMessageStore) const;

Description

Stores settings to a specified message store.

Parameters

CMsvStore &aMessageStore Message store to write to

IMPORT_C void StoreWithoutCommitL(CMsvStore &aMessageStore) const;

Description

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

Parameters

CMsvStore &aMessageStore Message store to write to

IMPORT_C void SetContentTypeL(const TDesC8 &aPath);

Description

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

IMPORT_C const TPtrC8 ContentType() const;

Description

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

Return value

const TPtrC8 Field value

IMPORT_C void SetContentSubTypeL(const TDesC8 &aPath);

Description

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

IMPORT_C const TPtrC8 ContentSubType() const;

Description

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

const TPtrC8 Field value

IMPORT_C void SetContentDispositionL(const TDesC8 &aPath);

Description

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

IMPORT_C const TPtrC8 ContentDisposition() const;

Description

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

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

Return value

const TPtrC8 Field value

IMPORT_C void SetContentDescriptionL(const TDesC8 &aPath);

Description

Sets the Content-Description field value.

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

Parameters

const TDesC8 &aPath Field value

IMPORT_C const TPtrC8 ContentDescription() const;

Description

Gets the Content-Description field value.

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

Return value

const TPtrC8 Field value

IMPORT_C void SetContentBaseL(const TDesC8 &aPath);

Description

Sets the Content-Base field value.

Parameters

const TDesC8 &aPath Field value

IMPORT_C const TPtrC8 ContentBase() const;

Description

Gets the Content-Base field value.

Return value

const TPtrC8 Field value

IMPORT_C void SetContentIDL(const TDesC8 &aPath);

Description

Sets the Content-ID field value.

Parameters

const TDesC8 &aPath Field value

IMPORT_C const TPtrC8 ContentID() const;

Description

Gets the Content-ID field value.

Return value

const TPtrC8 Field value

IMPORT_C void SetContentLocationL(const TDesC16 &aPath);

Description

Sets the Content-Location field value.

Parameters

const TDesC16 &aPath Field value

IMPORT_C const TPtrC16 ContentLocation() const;

Description

Gets the Content-Location field value.

Return value

const TPtrC16 Field value

IMPORT_C void SetRelativePathL(const TDesC8 &aPath);

Description

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

Parameters

const TDesC8 &aPath Relative location

IMPORT_C const TPtrC8 RelativePath() const;

Description

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

Return value

const TPtrC8 Relative location

IMPORT_C void SetContentTransferEncodingL(const TDesC8 &aType);

Description

Sets the Content-Transfer-Encoding field value.

Parameters

const TDesC8 &aType Field value

IMPORT_C TImEncodingType ContentTransferEncoding() const;

Description

Gets the Content-Transfer-Encoding field value.

Return value

TImEncodingType Field value

IMPORT_C TImEncodingType ContentTransferEncoding(TDes8 &rType) const;

Description

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

Parameters

TDes8 &rType On return, the field value as a string

Return value

TImEncodingType Field value

IMPORT_C const TPtrC8 GetContentTypeValue(const TDesC8 &aContentTypeParameter) const;

Description

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

const TDesC8 &aContentTypeParameter Parameter type

Return value

const TPtrC8 Parameter value

inline const CDesC8Array &ContentTypeParams() const;

Description

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

Return value

const CDesC8Array & Parameters and associated values

inline const CDesC8Array &ContentDispositionParams() const;

Description

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

Return value

const CDesC8Array & Parameters and associated values

inline const CDesC8Array &XTypeParams() const;

Description

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

Return value

const CDesC8Array & Parameters and associated values

inline CDesC8Array &ContentTypeParams();

Description

Gets the Content-Type parameters and their associated values.

Return value

CDesC8Array & Parameters and associated values

inline CDesC8Array &ContentDispositionParams();

Description

Gets the Content-Disposition parameters and their associated values.

Return value

CDesC8Array & Parameters and associated values

inline CDesC8Array &XTypeParams();

Description

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

Return value

CDesC8Array & Parameters and associated values

inline const TUint16 Version() const;

Description

Return value

const TUint16

inline void SetVersion(TUint16 aVersion);

Description

Parameters

TUint16 aVersion

IMPORT_C void SetMimeCharset(const TUint aCharset);

Description

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

UID values for different MIME charsets are in charconv.h

Parameters

const TUint aCharset Character set

IMPORT_C TUint MimeCharset() const;

Description

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

UID values for different MIME charsets are in charconv.h

Return value

TUint Character set