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()constGets the Content-Base field value.
• ContentDescription()constGets the Content-Description field value.
• ContentDisposition()constGets the Content-Disposition field value (either inline or attachment).
• ContentDispositionParams()Gets the Content-Disposition parameters and their associated values.
• ContentDispositionParams()constGets the const Content-Disposition parameters and their associated values.
• ContentID()constGets the Content-ID field value.
• ContentLocation()constGets the Content-Location field value.
• ContentSubType()constGets the Content-Type subtype field value (e.g. "plain" in Content-Typ...
• ContentTransferEncoding()constGets the Content-Transfer-Encoding field value.
• ContentTransferEncoding(TDes8 &)constGets the Content-Transfer-Encoding field value as a string.
• ContentType()constGets the Content-Type field value (e.g. "text" in Content-Type:text/pl...
• ContentTypeParams()Gets the Content-Type parameters and their associated values.
• ContentTypeParams()constGets the const Content-Type parameters and their associated values.
• ExternalizeL(RMsvWriteStream &)constExternalises the settings to a specified stream.
• GetContentTypeValue(const TDesC8 &)constGets the value for a particular Content-Type parameter.
• InternalizeL(RMsvReadStream &)Internalises the settings from a specified stream.
• MimeCharset()constGets the character set used in decoding the email MIME part.
• NewL()Allocates and creates a new CImMimeHeader object.
• NewLC()Allocates and creates a new CImMimeHeader object, leaving the object on the clea...
• RelativePath()constGets IMAP-specific information for the relative location of the entry to the par...
• Reset()Resets all header field values.
• RestoreL(CMsvStore &)Restores settings from a specified message store.
• SetContentBaseL(const TDesC8 &)Sets the Content-Base field value.
• SetContentDescriptionL(const TDesC8 &)Sets the Content-Description field value.
• SetContentDispositionL(const TDesC8 &)Sets the Content-Disposition field value (either inline or attachment).
• SetContentIDL(const TDesC8 &)Sets the Content-ID field value.
• SetContentLocationL(const TDesC16 &)Sets the Content-Location field value.
• SetContentSubTypeL(const TDesC8 &)Sets the Content-Type subtype field value (e.g. "plain" in Content-Typ...
• SetContentTransferEncodingL(const TDesC8 &)Sets the Content-Transfer-Encoding field value.
• SetContentTypeL(const TDesC8 &)Sets the Content-Type field value (e.g. "text" in Content-Type:text/pl...
• SetMimeCharset(const TUint)Sets the character set used in decoding the email MIME part.
• SetRelativePathL(const TDesC8 &)Sets IMAP-specific information for the relative location of the entry to the par...
• SetVersion(TUint16)
• Size()Estimates the size of the MIME header, constructed using the values stored.
• StoreL(CMsvStore &)constStores settings to a specified message store.
• StoreWithoutCommitL(CMsvStore &)constStores, but does not commit, settings to a specified message store.
• Version()const
• XTypeParams()Gets the MIME header parameters and their associated values. This can be used by...
• XTypeParams()constGets the const MIME header parameters and their associated values. This can be u...
• ~CImMimeHeader()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CImMimeHeader* NewLC();

Description

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

Return value

IMPORT_C static CImMimeHeader* NewL();

Description

Allocates and creates a new CImMimeHeader object.

Return value

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

IMPORT_C void InternalizeL(RMsvReadStream &aReadStream);

Description

Internalises the settings from a specified stream.

Parameters

IMPORT_C void ExternalizeL(RMsvWriteStream &aWriteStream) const;

Description

Externalises the settings to a specified stream.

Parameters

IMPORT_C void RestoreL(CMsvStore &aMessageStore);

Description

Restores settings from a specified message store.

Parameters

IMPORT_C void StoreL(CMsvStore &aMessageStore) const;

Description

Stores settings to a specified message store.

Parameters

IMPORT_C void StoreWithoutCommitL(CMsvStore &aMessageStore) const;

Description

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

Parameters

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

IMPORT_C const TPtrC8 ContentType() const;

Description

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

Return 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

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

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

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

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

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

IMPORT_C void SetContentBaseL(const TDesC8 &aPath);

Description

Sets the Content-Base field value.

Parameters

IMPORT_C const TPtrC8 ContentBase() const;

Description

Gets the Content-Base field value.

Return value

IMPORT_C void SetContentIDL(const TDesC8 &aPath);

Description

Sets the Content-ID field value.

Parameters

IMPORT_C const TPtrC8 ContentID() const;

Description

Gets the Content-ID field value.

Return value

IMPORT_C void SetContentLocationL(const TDesC16 &aPath);

Description

Sets the Content-Location field value.

Parameters

IMPORT_C const TPtrC16 ContentLocation() const;

Description

Gets the Content-Location field value.

Return 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

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

IMPORT_C void SetContentTransferEncodingL(const TDesC8 &aType);

Description

Sets the Content-Transfer-Encoding field value.

Parameters

IMPORT_C TImEncodingType ContentTransferEncoding() const;

Description

Gets the Content-Transfer-Encoding field value.

Return value

IMPORT_C TImEncodingType ContentTransferEncoding(TDes8 &rType) const;

Description

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

Parameters

Return 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

Return value

inline const CDesC8Array& ContentTypeParams() const;

Description

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

Return value

inline const CDesC8Array& ContentDispositionParams() const;

Description

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

Return value

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

inline CDesC8Array& ContentTypeParams();

Description

Gets the Content-Type parameters and their associated values.

Return value

inline CDesC8Array& ContentDispositionParams();

Description

Gets the Content-Disposition parameters and their associated values.

Return value

inline CDesC8Array& XTypeParams();

Description

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

Return value

inline const TUint16 Version() const;

Description

Return value

inline void SetVersion(TUint16 aVersion);

Description

Parameters

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

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