#include <CMsvAttachment.h>
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class `CMsvAttachment`

class CMsvAttachment : public CBase;

Description

Represents a single attachment and information about the attachment.

This object is used to represent all types of attachments (file, linked file or message entry). Note that some APIs may not be valid for particular attachment types. This is described under each method. It is the responsibility of the client to ensure that the data about the attachment is set such as its mime-type or size.

Derivation

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

CMsvAttachment - Represents a single attachment and information about the attachment.

Members

Defined in CMsvAttachment:

AttachmentName()constReturns the attachment name.
Complete()constIndicates whether attachment is complete or not.
EMsvFileFile attachment. This is a file attachment that is copied into the message store...
EMsvLinkedFileLinked file attachment. This is an attachment that is linked to using its file p...
EMsvMessageEntryMessage entry attachment. This is a message entry that is registered as an attac...
EntryAttachmentId()constReturns the message entry Id for message entry attachment. This is only valid if...
FilePath()constReturns the full path specification for file attachments.
GetDesC8Attribute(TUid,TPtrC8 &)constGets an 8-bit descriptor attribute.
GetIntAttribute(TUid,TInt &)constGets an integer attribute.
Id()constReturns the attachment Id.
MimeType()constThe mime-type of the attachment.
NewL(TMsvAttachmentType)Standard 2-phase construction, creates the attachment object.
NewL(TMsvAttachmentType,TInt,HBufC8 *,HBufC *)Standard 2-phase construction, creates the attachment object.
NewL(const CMsvAttachment &)
RemoveDesC8Attribute(TUid)Removes an 8-bit descriptor attribute.
RemoveIntAttribute(TUid)Removes an integer attribute.
SetAttachmentNameL(const TDesC &)
SetComplete(TBool)Sets whether the attachment is complete or not.
SetDesC8AttributeL(TUid,const TDesC8 &)Sets an 8-bit descriptor attribute for the attachment.
SetId(TMsvAttachmentId)Sets the attachment Id.
SetIntAttributeL(TUid,TInt)Sets an integer attribute for the attachment.
SetMimeTypeL(const TDesC8 &)Sets the mime-type of the attachment.
SetSize(TInt)Sets the attachment size.
Size()constSize of the attachment.
TMsvAttachmentTypeEnum to define the different types of attachments supported by messaging.
Type()constReturns the attachment type.
~CMsvAttachment()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...

Construction and destruction

`NewL(TMsvAttachmentType)`

IMPORT_C static CMsvAttachment* NewL(TMsvAttachmentType aType);

Description

Standard 2-phase construction, creates the attachment object.

The object should then be initialised with information about the attachment.

Parameters


                                 						CMsvAttachment::TMsvAttachmentType aType

The attachment type.

Return value

CMsvAttachment *

Pointer to the created attachment object.

`NewL(TMsvAttachmentType,TInt,HBufC8 ,HBufC )`

IMPORT_C static CMsvAttachment* NewL(TMsvAttachmentType aType, TInt aSize, HBufC8 *aMimeType, HBufC *aAttachmentName);

Description

Standard 2-phase construction, creates the attachment object.

The object should then be initialised with information about the attachment. This allows the caller to pass in commonly used attributes to initialise them on construction to save the caller from having to call the relavant Set... methods. The attributes that can be initialised are Mime-Type, attachment name and size. Callers should pass in NULL for any attributes that are not required to be set.

Parameters

`CMsvAttachment::TMsvAttachmentType aType`	The attachment type.
`TInt aSize`	The size of the attachment. For file attachments this should be the file size and for message entry attachments this should be the message size.
`HBufC8 *aMimeType`	The Mime-Type of the attachment.
`HBufC16 *aAttachmentName`	The attachment name to identify the attachment.

Return value

CMsvAttachment *

Pointer to the created attachment object.

`NewL(const CMsvAttachment &)`

IMPORT_C static CMsvAttachment* NewL(const CMsvAttachment &aAttachment);

Description

Parameters

const CMsvAttachment &aAttachment

Return value

CMsvAttachment *

`~CMsvAttachment()`

IMPORT_C ~CMsvAttachment();

Description

Standard destructor.

Member functions

`Id()const`

IMPORT_C TMsvAttachmentId Id() const;

Description

Returns the attachment Id.

The attachment Id is unique on a per message entry basis.

Return value

TMsvAttachmentId

The attachment Id.

`SetId(TMsvAttachmentId)`

IMPORT_C void SetId(TMsvAttachmentId aId);

Description

Sets the attachment Id.

The attachment Id is automatically set when passed to the Attachment Manager. This method allows the Id to be over-ridden or set by different implementations of attachment managers.

Parameters


                                 						TMsvAttachmentId aId

The attachment Id to set.

`Type()const`

IMPORT_C TMsvAttachmentType Type() const;

Description

Returns the attachment type.

The attachment types can be a file, a linked file or a message entry attachment.

Return value

CMsvAttachment::TMsvAttachmentType

The attachment type.

`EntryAttachmentId()const`

IMPORT_C TMsvId EntryAttachmentId() const;

Description

Returns the message entry Id for message entry attachment. This is only valid if the attachment type is EMessageEntry.

Return value

TMsvId

The message entry Id for the entry attachment.

`AttachmentName()const`

IMPORT_C const TDesC& AttachmentName() const;

Description

Returns the attachment name.

The attachment name is a readable text attribute to identify the attachment.

Return value

const TDesC16 &

Descriptor containing attachment name. Zero-length descriptor if attachment name is not set.

`SetAttachmentNameL(const TDesC &)`

IMPORT_C void SetAttachmentNameL(const TDesC &aAttachmentName);

Description

Parameters

const TDesC16 &aAttachmentName

`FilePath()const`

IMPORT_C const TDesC& FilePath() const;

Description

Returns the full path specification for file attachments.

This is only valid for file attachments where the attachment type is EMsvFile or EMsvLinkedFile.

Return value

const TDesC16 &

Descriptor containing full file path of the file attachment.

`Size()const`

IMPORT_C TInt Size() const;

Description

Size of the attachment.

Return the size of the attachment in bytes.

Return value

TInt

The size of the attachment.

`SetSize(TInt)`

IMPORT_C void SetSize(TInt aSize);

Description

Sets the attachment size.

When initialising or updating the attachment, this method should be used to set the size in bytes.

Parameters


                                 						TInt aSize

The size of the attachment in bytes.

`MimeType()const`

IMPORT_C const TDesC8& MimeType() const;

Description

The mime-type of the attachment.

Return value

const TDesC8 &

Descriptor containing mime-type. Zero-length descriptor if mime-type is not set.

`SetMimeTypeL(const TDesC8 &)`

IMPORT_C void SetMimeTypeL(const TDesC8 &aMimeType);

Description

Sets the mime-type of the attachment.

Parameters

const TDesC8 &aMimeType

Descriptor containing the mime-type.

`Complete()const`

IMPORT_C TBool Complete() const;

Description

Indicates whether attachment is complete or not.

This allows support for incomplete or pending attachments.

Return value

TBool

ETrue if the attachment is complete, EFalse otherwise.

`SetComplete(TBool)`

IMPORT_C void SetComplete(TBool aComplete);

Description

Sets whether the attachment is complete or not.

This allows support for incomplete or pending attachments.

Parameters


                                 						TBool aComplete

ETrue if the attachment is complete, EFalse otherwise.

`SetDesC8AttributeL(TUid,const TDesC8 &)`

IMPORT_C void SetDesC8AttributeL(TUid aAttributeId, const TDesC8 &aAttribute);

Description

Sets an 8-bit descriptor attribute for the attachment.

A UID identifier uniquely identifies the attribute. If an attibute already exists with the same identifier, the old attribute is over-written.

This can be used to store an attribute as an 8-bit descriptor or binary data.

Parameters

`TUid aAttributeId`	The unique identifier for the attribute.
`const TDesC8 &aAttribute`	The attribute data to store. The descriptor is copied internally.

`GetDesC8Attribute(TUid,TPtrC8 &)const`

IMPORT_C TInt GetDesC8Attribute(TUid aAttributeId, TPtrC8 &aAttribute) const;

Description

Gets an 8-bit descriptor attribute.

Gets the attribute uniquely identified by the UID identifer set using the SetDesC8AttributeL method.

Parameters

`TUid aAttributeId`	The unique identifier for the attribute.
`TPtrC8 &aAttribute`	If attribute is found, this will be set to point to the attribute data.

Return value

TInt

KErrNone is successful, KErrNotFound if the attribute cannot be found.

`RemoveDesC8Attribute(TUid)`

IMPORT_C void RemoveDesC8Attribute(TUid aAttributeId);

Description

Removes an 8-bit descriptor attribute.

Removes the attribute identified by its UID identifer. This methods has no effect if the attribute does not exist.

Parameters


                                 						TUid aAttributeId

The unique identifier for the attribute.

`SetIntAttributeL(TUid,TInt)`

IMPORT_C void SetIntAttributeL(TUid aAttributeId, TInt aAttribute);

Description

Sets an integer attribute for the attachment.

A UID identifier uniquely identifies the attribute. If an attibute already exists with the same identifier, the old attribute is over-written.

Parameters

`TUid aAttributeId`	The unique identifier for the attribute.
`TInt aAttribute`	The attribute data to store.

`GetIntAttribute(TUid,TInt &)const`

IMPORT_C TInt GetIntAttribute(TUid aAttributeId, TInt &aAttribute) const;

Description

Gets an integer attribute.

Gets the attribute uniquely identified by the UID identifer set using the SetIntAttributeL method.

Parameters

`TUid aAttributeId`	The unique identifier for the attribute.
`TInt &aAttribute`	If attribute is found, this will be set to the attribute data.

Return value

TInt

KErrNone is successful, KErrNotFound if the attribute cannot be found.

`RemoveIntAttribute(TUid)`

IMPORT_C void RemoveIntAttribute(TUid aAttributeId);

Description

Removes an integer attribute.

Removes the attribute identified by its UID identifer. This methods has no effect if the attribute does not exist.

Parameters


                                 						TUid aAttributeId

The unique identifier for the attribute.

Member enumerations

Enum `TMsvAttachmentType`

TMsvAttachmentType

Description

Enum to define the different types of attachments supported by messaging.

`EMsvFile`	File attachment. This is a file attachment that is copied into the message store.
`EMsvLinkedFile`	Linked file attachment. This is an attachment that is linked to using its file path, this is not copied into the message store.
`EMsvMessageEntry`	Message entry attachment. This is a message entry that is registered as an attachment.

Class CMsvAttachment

Description

Derivation

Members

Construction and destruction

NewL(TMsvAttachmentType)

Description

Parameters

Return value

NewL(TMsvAttachmentType,TInt,HBufC8 *,HBufC *)

Description

Parameters

Return value

NewL(const CMsvAttachment &)

Description

Parameters

Return value

~CMsvAttachment()

Description

Member functions

Id()const

Description

Return value

SetId(TMsvAttachmentId)

Description

Parameters

Type()const

Description

Return value

See also:

EntryAttachmentId()const

Description

Return value

AttachmentName()const

Description

Return value

SetAttachmentNameL(const TDesC &)

Description

Parameters

FilePath()const

Description

Return value

Size()const

Description

Return value

SetSize(TInt)

Description

Parameters

MimeType()const

Description

Return value

SetMimeTypeL(const TDesC8 &)

Description

Parameters

Complete()const

Description

Return value

SetComplete(TBool)

Description

Parameters

SetDesC8AttributeL(TUid,const TDesC8 &)

Description

Parameters

GetDesC8Attribute(TUid,TPtrC8 &)const

Description

Parameters

Return value

RemoveDesC8Attribute(TUid)

Description

Parameters

SetIntAttributeL(TUid,TInt)

Description

Parameters

GetIntAttribute(TUid,TInt &)const

Description

Parameters

Return value

RemoveIntAttribute(TUid)

Description

Parameters

Class `CMsvAttachment`

`NewL(TMsvAttachmentType)`

`NewL(TMsvAttachmentType,TInt,HBufC8 ,HBufC )`

`NewL(const CMsvAttachment &)`

`~CMsvAttachment()`

`Id()const`

`SetId(TMsvAttachmentId)`

`Type()const`

`EntryAttachmentId()const`

`AttachmentName()const`

`SetAttachmentNameL(const TDesC &)`

`FilePath()const`

`Size()const`

`SetSize(TInt)`

`MimeType()const`

`SetMimeTypeL(const TDesC8 &)`

`Complete()const`

`SetComplete(TBool)`

`SetDesC8AttributeL(TUid,const TDesC8 &)`

`GetDesC8Attribute(TUid,TPtrC8 &)const`

`RemoveDesC8Attribute(TUid)`

`SetIntAttributeL(TUid,TInt)`

`GetIntAttribute(TUid,TInt &)const`

`RemoveIntAttribute(TUid)`

Enum `TMsvAttachmentType`