Class CMsvMimeHeaders

class CMsvMimeHeaders : public CBase;

Description

Utility class to represent commonly used Mime Headers. This object represents a number of common Mime Headers into a single class. It is intended that this class is used to represent the Mime Headers for an attachment represented by the CMsvAttachment class when using the Attachment API. The Mime header data can be associated with an attachment and stored and restored using the StoreL and RestoreL methods.

Derivation

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

• CMsvMimeHeaders - Utility class to represent commonly used Mime Headers. This object represents a ...

Members

Defined in CMsvMimeHeaders:

• ContainsMimeHeaders(const CMsvAttachment &)Enquire whether a CMsvAttachment has MIME headers without restoring all the head...
• ContentBase()constGets the Content-Base mime header.
• ContentDescription()constGets the Content-Description mime header.
• ContentDisposition()constGets the Content-Disposition mime header.
• ContentDispositionParams()Returns a modifiable descriptor array containing the Content-Disposition paramet...
• ContentDispositionParams()constReturns a non-modifiable descriptor array containing the Content-Disposition par...
• ContentId()constGets the Content-Id mime header.
• ContentLocation()constGets the Content-Location mime header.
• ContentSubType()constGets the Content-SubType mime header.
• ContentTransferEncoding()constGets the Content-Transfer Encoding mime header.
• ContentTransferEncoding(TPtrC8 &)constGets the Content-Transfer Encoding mime header.
• ContentType()constGets the Content-Type mime header.
• ContentTypeParams()Returns a modifiable descriptor array containing the Content-Type parameters.
• ContentTypeParams()constReturns a non-modifiable descriptor array containing the Content-Type parameters...
• EEncodingType7Bit7-bit.
• EEncodingType8Bit8-bit.
• EEncodingTypeBASE64Base64.
• EEncodingTypeBinaryBinary.
• EEncodingTypeNoneNone.
• EEncodingTypeQPQP.
• EEncodingTypeUUUU.
• EEncodingTypeUnknownUnknown.
• GetContentTypeValue(const TDesC8 &)constGets the Content-Type mime header parameter value.
• MimeCharset()constGets the mime charset header.
• NewL()Standard 2-phase construction, creates the mime headers object.
• NewLC()Standard 2-phase construction, creates the mime headers object.
• RelativePath()constGets the relative path mime header.
• Reset()Resets the mime headers.
• RestoreL(CMsvAttachment &)Restores the mime header data.
• SetContentBaseL(const TDesC8 &)Sets the Content-Base mime header.
• SetContentDescriptionL(const TDesC8 &)Sets the Content-Description mime header.
• SetContentDispositionL(const TDesC8 &)Sets the Content-Disposition mime header.
• SetContentIdL(const TDesC8 &)Sets the Content-Id mime header.
• SetContentLocationL(const TDesC16 &)Sets the Content-Location mime header.
• SetContentSubTypeL(const TDesC8 &)Sets the Content-SubType mime header.
• SetContentTransferEncoding(const TDesC8 &)Sets the Content-Transfer Encoding mime header.
• SetContentTypeL(const TDesC8 &)Sets the Content-Type mime header.
• SetMimeCharset(TUint)Sets the mime charset header.
• SetRelativePathL(const TDesC8 &)Sets the relative path header.
• SetSuggestedFilenameL(const TDesC16 &)Sets the suggested filename mime header.
• Size()constReturns the size of all the mime header data.
• StoreL(CMsvAttachment &)constStores the mime header data.
• SuggestedFilename()constGets the suggested filename mime header.
• TMsvEncodingTypeMessaging encoding types.
• XTypeParams()Returns a non-modifiable descriptor array containing the X-Type parameters.
• XTypeParams()constReturns a modifiable descriptor array containing the X-Type parameters.
• ~CMsvMimeHeaders()Standard 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 CMsvMimeHeaders* NewL();

Description

Standard 2-phase construction, creates the mime headers object.

Creates and initailises the mime headers with no data.

Return value

IMPORT_C static CMsvMimeHeaders* NewLC();

Description

Standard 2-phase construction, creates the mime headers object.

Creates and initailises the mime headers with no data. Leaves a pointer on the cleanup stack.

Return value

IMPORT_C ~CMsvMimeHeaders();

Description

Standard destructor.

IMPORT_C void StoreL(CMsvAttachment &aAttachment) const;

Description

Stores the mime header data.

Associated and stores all the mime header data stored in this object as an attribute of an attachment object. The RestoreL method should be used to restore the data from the attachment.

Parameters

IMPORT_C void RestoreL(CMsvAttachment &aAttachment);

Description

Restores the mime header data.

Restores all the mime header data from an existing attachment object. This restores mime headers that was stored using the StoreL method. If the attachment does not contain any mime headers, this object is reset.

Parameters

IMPORT_C void SetContentDescriptionL(const TDesC8 &aContentDescription);

Description

Sets the Content-Description mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC8& ContentDescription() const;

Description

Gets the Content-Description mime header.

Returns a zero length descriptor if mime header not set.

Return value

IMPORT_C void SetContentBaseL(const TDesC8 &aContentBase);

Description

Sets the Content-Base mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC8& ContentBase() const;

Description

Gets the Content-Base mime header.

Returns a zero length descriptor if mime header not set.

Return value

IMPORT_C void SetContentLocationL(const TDesC16 &aContentLocation);

Description

Sets the Content-Location mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC16& ContentLocation() const;

Description

Gets the Content-Location mime header.

Returns a zero length descriptor if mime header not set.

Return value

IMPORT_C void SetContentIdL(const TDesC8 &aContentId);

Description

Sets the Content-Id mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC8& ContentId() const;

Description

Gets the Content-Id mime header.

Returns a zero length descriptor if mime header not set.

Return value

IMPORT_C void SetContentTypeL(const TDesC8 &aContentType);

Description

Sets the Content-Type mime header.

Over-writes any existing data. This mime header contains the beginning part of the mime-type, eg. the 'text' part of 'text/plain'.

Parameters

IMPORT_C const TDesC8& ContentType() const;

Description

Gets the Content-Type mime header.

Returns a zero length descriptor if mime header not set. This mime header contains the beginning part of the mime-type, eg. the 'text' part of 'text/plain'.

Return value

IMPORT_C void SetContentSubTypeL(const TDesC8 &aSubContentType);

Description

Sets the Content-SubType mime header.

Over-writes any existing data. This mime header contains the end part of the mime-type, eg. the 'plain' part of 'text/plain'.

Parameters

IMPORT_C const TDesC8& ContentSubType() const;

Description

Gets the Content-SubType mime header.

Returns a zero length descriptor if mime header not set. This mime header contains the end part of the mime-type, eg. the 'plain' part of 'text/plain'.

Return value

IMPORT_C void SetContentDispositionL(const TDesC8 &aContentDisposition);

Description

Sets the Content-Disposition mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC8& ContentDisposition() const;

Description

Gets the Content-Disposition mime header.

Returns a zero length descriptor if mime header not set.

Return value

IMPORT_C CDesC8Array& ContentTypeParams();

Description

Returns a modifiable descriptor array containing the Content-Type parameters.

Return value

IMPORT_C CDesC8Array& ContentDispositionParams();

Description

Returns a modifiable descriptor array containing the Content-Disposition parameters.

Return value

IMPORT_C CDesC8Array& XTypeParams();

Description

Returns a non-modifiable descriptor array containing the X-Type parameters.

Return value

IMPORT_C const CDesC8Array& ContentTypeParams() const;

Description

Returns a non-modifiable descriptor array containing the Content-Type parameters.

Return value

IMPORT_C const CDesC8Array& ContentDispositionParams() const;

Description

Returns a non-modifiable descriptor array containing the Content-Disposition parameters.

Return value

IMPORT_C const CDesC8Array& XTypeParams() const;

Description

Returns a modifiable descriptor array containing the X-Type parameters.

Return value

IMPORT_C void SetMimeCharset(TUint aMimeCharset);

Description

Sets the mime charset header.

Over-writes any existing data.

Parameters

IMPORT_C TUint MimeCharset() const;

Description

Gets the mime charset header.

Return value

IMPORT_C void SetSuggestedFilenameL(const TDesC16 &aSuggestedFilename);

Description

Sets the suggested filename mime header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC16& SuggestedFilename() const;

Description

Gets the suggested filename mime header.

Returns a zero length descriptor if header is not set.

Return value

IMPORT_C void SetRelativePathL(const TDesC8 &aRelativePath);

Description

Sets the relative path header.

Over-writes any existing data.

Parameters

IMPORT_C const TDesC8& RelativePath() const;

Description

Gets the relative path mime header.

Returns a zero length descriptor if header is not set.

Return value

IMPORT_C void SetContentTransferEncoding(const TDesC8 &aEncodingType);

Description

Sets the Content-Transfer Encoding mime header.

Over-writes any existing data.

Parameters

IMPORT_C TMsvEncodingType ContentTransferEncoding() const;

Description

Gets the Content-Transfer Encoding mime header.

Return value

See also:

• CMsvMimeHeaders::TMsvEncodingTypeMessaging encoding types.

IMPORT_C TMsvEncodingType ContentTransferEncoding(TPtrC8 &aEncodingType) const;

Description

Gets the Content-Transfer Encoding mime header.

Also provides a descriptor that contains a textual representation of the content-transfer encoding header.

Parameters

Return value

See also:

• CMsvMimeHeaders::TMsvEncodingTypeMessaging encoding types.

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

Description

Gets the Content-Type mime header parameter value.

This method finds the specifed parameter and extracts the value for it.

Parameters

Return value

IMPORT_C void Reset();

Description

Resets the mime headers.

Resets and removes all the mime headers and data that has been set.

IMPORT_C TInt Size() const;

Description

Returns the size of all the mime header data.

Returns the approximate size in bytes of all the mime header data stored by this object. The returned value is a sum of the lengths of all the string data and the size of an integer for each integer type data.

Return value

IMPORT_C TBool ContainsMimeHeaders(const CMsvAttachment &aAttachment);

Description

Enquire whether a CMsvAttachment has MIME headers without restoring all the headers.

Parameters

Return value

TMsvEncodingType

Description

Messaging encoding types.