Collapse all Symbian^3 Product Developer Library

CMmsHeaders Class Reference

class CMmsHeaders : public CBase

This class provides access to MMS specific header data. The class can be used from both Client MTM and Server MTM.

Inherits from

CMmsHeaders
- CBase

Public Member Functions
	~CMmsHeaders()
TInt	AdaptationAllowed()
IMPORT_C void	AddTypedAddresseeL(const TDesC &, TMmsRecipients)
IMPORT_C void	AppendPreviouslySentItemL(TInt64, const TDesC &)
IMPORT_C TPtrC16	ApplicId()
IMPORT_C TPtrC8	AuxApplicInfo()
const CDesCArray &	BccRecipients()
TInt	CancelStatus()
const CDesCArray &	CcRecipients()
TInt	ContentClass()
IMPORT_C TPtrC8	ContentLocation()
IMPORT_C CMmsHeaders *	CopyL(TMsvPartList, TBool)
IMPORT_C CMmsHeaders *	CopyL(TMsvPartList, TBool, RFs &)
IMPORT_C void	CreateContentId(TDes8 &)
TInt64	Date()
const RPointerArray< CMmsDeleteResultArray > &	DeleteResultArray()
IMPORT_C TInt64	DeliveryDate()
TInt	DeliveryReport()
IMPORT_C TInt	DeliveryTimeInterval()
TInt	DistributionIndicator()
TInt	DrmContent()
IMPORT_C CMmsElementDescriptor &	ElementDescriptorL()
IMPORT_C TInt64	ExpiryDate()
IMPORT_C TInt	ExpiryInterval()
IMPORT_C TPtrC	ExtendedNotification()
IMPORT_C void	GetMaximumImage(TInt &, TInt &)
IMPORT_C void	InsertDeleteContentLocationL(TUint, const TDesC8 &)
IMPORT_C void	InsertDeleteResponseTextL(TUint, const TDesC &)
IMPORT_C void	InsertDeleteStatusL(TUint, const TInt32)
IMPORT_C void	InsertPreviouslySentByL(TInt, const TDesC &)
IMPORT_C void	InsertPreviouslySentDateL(TInt, TInt64)
IMPORT_C CMmsMMBoxMessageHeaders &	MMBoxMessageHeadersL()
IMPORT_C CMmsMMBoxViewHeaders &	MMBoxViewHeadersL()
TInt	MessageClass()
TInt	MessageComplete()
IMPORT_C TPtrC8	MessageId()
TInt	MessagePriority()
TMsvAttachmentId	MessageRoot()
TInt	MessageSize()
TInt	MessageType()
TInt16	MmsVersion()
TInt	MultipartType()
IMPORT_C CMmsHeaders *	NewL()
IMPORT_C CMmsHeaders *	NewL(TInt16)
const RPointerArray< CMmsSendingChain > &	PreviouslySentList()
const CMmsElementDescriptor *	ReadOnlyElementDescriptor()
const CMmsMMBoxMessageHeaders *	ReadOnlyMMBoxMessageHeaders()
const CMmsMMBoxViewHeaders *	ReadOnlyMMBoxViewHeaders()
TInt	ReadReply()
TInt	ReadStatus()
TTime	ReceivingTime()
TInt	RecommendedRetrievalMode()
IMPORT_C TPtrC16	RecommendedRetrievalModeText()
TMsvId	RelatedEntry()
IMPORT_C TBool	RemoveAddressee(const TDesC &)
IMPORT_C TPtrC8	ReplaceCancelId()
IMPORT_C TPtrC16	ReplyApplicId()
TInt	ReplyCharging()
IMPORT_C TInt64	ReplyChargingDate()
IMPORT_C TPtrC8	ReplyChargingId()
IMPORT_C TInt	ReplyChargingInterval()
TInt	ReplyChargingSize()
TInt32	ReportAllowed()
IMPORT_C void	Reset(CMmsSettings *)
TInt32	ResponseStatus()
IMPORT_C TPtrC	ResponseText()
IMPORT_C void	RestoreL(CMsvStore &)
IMPORT_C TPtrC8	RootContentId()
IMPORT_C TPtrC	Sender()
TInt	SenderVisibility()
void	SetAdaptationAllowed(TInt)
IMPORT_C void	SetApplicIdL(const TDesC16 &)
IMPORT_C void	SetAuxApplicInfoL(const TDesC8 &)
void	SetCancelStatus(TInt)
void	SetContentClass(TInt)
IMPORT_C void	SetContentLocationL(const TDesC8 &)
void	SetDate(TInt64)
IMPORT_C void	SetDeliveryDate(TInt64)
void	SetDeliveryReport(TInt)
IMPORT_C void	SetDeliveryTimeInterval(TInt)
void	SetDistributionIndicator(const TInt)
void	SetDrmContent(TInt)
IMPORT_C void	SetExpiryDate(TInt64)
IMPORT_C void	SetExpiryInterval(TInt)
IMPORT_C void	SetExtendedNotificationL(const TDesC &)
IMPORT_C void	SetMaximumImage(TInt, TInt)
void	SetMessageClass(TInt)
void	SetMessageComplete(TInt)
IMPORT_C void	SetMessageIdL(const TDesC8 &)
void	SetMessagePriority(TInt)
void	SetMessageRoot(const TMsvAttachmentId)
void	SetMessageSize(TInt)
void	SetMessageType(TInt)
void	SetMmsVersion(TInt16)
void	SetMultipartType(const TInt)
void	SetReadReply(TInt)
void	SetReadStatus(const TInt)
void	SetReceivingTime(TTime)
void	SetRecommendedRetrievalMode(TInt)
IMPORT_C void	SetRecommendedRetrievalModeTextL(const TDesC16 &)
void	SetRelatedEntry(const TMsvId)
IMPORT_C void	SetReplaceCancelIdL(const TDesC8 &)
IMPORT_C void	SetReplyApplicIdL(const TDesC16 &)
void	SetReplyCharging(const TInt)
IMPORT_C void	SetReplyChargingDate(TInt64)
IMPORT_C void	SetReplyChargingIdL(const TDesC8 &)
IMPORT_C void	SetReplyChargingInterval(TInt)
void	SetReplyChargingSize(const TInt)
void	SetReportAllowed(TInt32)
void	SetResponseStatus(TInt32)
IMPORT_C void	SetResponseTextL(const TDesC &)
IMPORT_C void	SetRootContentIdL(const TDesC8 &)
IMPORT_C void	SetSenderL(const TDesC &)
void	SetSenderVisibility(TInt)
IMPORT_C void	SetSettings(CMmsSettings *)
void	SetStatus(const TInt)
IMPORT_C void	SetSubjectL(const TDesC &)
IMPORT_C void	SetTidL(const TDesC8 &)
IMPORT_C TInt	Size()
TInt	Status()
IMPORT_C void	StoreL(CMsvStore &)
IMPORT_C TPtrC	Subject()
IMPORT_C TPtrC8	Tid()
const CDesCArray &	ToRecipients()
IMPORT_C const CDesCArray &	TypedAddresseeList(TMmsRecipients)

Private Member Functions
	CMmsHeaders()
HBufC *	AliasedAddressL(const TDesC &, RFs &)
CDesCArray *	AliasedAddressL(const CDesCArray &, RFs &)
void	ConstructL(TInt16)
void	CopyAddresseeListL(const CDesCArray &, TMmsRecipients, const TPtrC &, RFs &)
void	ExternalizeArrayL(CDesC16Array &, RWriteStream &)
IMPORT_C void	ExternalizeL(RMsvWriteStream &)
void	InternalizeArrayL(CDesC16Array &, RReadStream &)
IMPORT_C void	InternalizeL(RMsvReadStream &)
TPtrC8	LimitStringSize(const TPtrC8 &, TInt)
TPtrC16	LimitStringSize(const TPtrC16 &, TInt)
TBool	RemoveAddressee(CDesCArray &, const TDesC &)

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

Private Attributes
TInt32	iAdaptationAllowed
HBufC *	iApplicationId
HBufC8 *	iApplicationInfo
CDesCArray *	iBccArray
TInt32	iCancelStatus
CDesCArray *	iCcArray
TInt32	iContentClass
HBufC8 *	iContentLocation
TInt64	iDate
RPointerArray< CMmsDeleteResultArray >	iDeleteResultArray
TLinearOrder< CMmsDeleteResultArray >	iDeleteResultOrder
TInt32	iDelivReport
TInt64	iDelivery
TBool	iDeliveryAbs
TInt32	iDistributionIndicator
TInt32	iDrmContent
CMmsElementDescriptor *	iElementDescriptor
TInt64	iExpiry
TBool	iExpiryAbs
HBufC *	iExtendedNotificationText
TInt	iExtensionStatus
TLinearOrder< CMmsSendingChain >	iLinearOrder
TInt32	iMaxImageHeight
TInt32	iMaxImageWidth
HBufC8 *	iMessageId
TUint32	iMessageSize
CMmsMMBoxMessageHeaders *	iMmBoxMessageHeaders
CMmsMMBoxViewHeaders *	iMmBoxViewHeaders
TInt16	iMmsDefaultVersion
TInt32	iMsgClass
TInt32	iMsgType
TInt32	iMultipartType
HBufC *	iOperatorResponseText
RPointerArray< CMmsSendingChain >	iPreviouslySentArray
TInt32	iPriority
TInt32	iReadReply
TInt32	iReadStatus
TTime	iReceivingTime
TInt32	iRecommendedRetrievalMode
HBufC *	iRecommendedRetrievalModeText
TMsvId	iRelatedEntry
HBufC8 *	iReplaceCancelId
TInt32	iReplyCharging
TBool	iReplyChargingAbs
TInt64	iReplyChargingDeadline
HBufC8 *	iReplyChargingId
TInt32	iReplyChargingSize
HBufC *	iReplyToApplicationId
TInt32	iReportAllowed
TInt32	iResponseStatus
HBufC8 *	iRootContentID
HBufC *	iSender
TInt32	iSenderVisi
TMsvAttachmentId	iStart
TInt32	iStatus
HBufC *	iSubject
HBufC8 *	iTID
CDesCArray *	iToArray
TInt16	iVersion

Constructor & Destructor Documentation

CMmsHeaders()

CMmsHeaders

(

)

[private]

C++ default constructor.

~CMmsHeaders()

~CMmsHeaders

(

)

[virtual]

Destructor.

Member Functions Documentation

AdaptationAllowed()

TInt

AdaptationAllowed

(

)

const [inline]

Get header that tells if MMSC is allowed to alter the message (make it smaller).

AddTypedAddresseeL(const TDesC &, TMmsRecipients)

IMPORT_C void	AddTypedAddresseeL	(	const TDesC &	aRealAddress,
			TMmsRecipients	aType
		)

Adds recipient with specified type (To, Cc, Bcc). This function also adds all recipients into the internal list that contains all addressees regardless of addressee type.

Parameters

const TDesC & aRealAddress	recipient address.
TMmsRecipients aType	specifies recipient type (types defined in MMSCONST.H)

AliasedAddressL(const TDesC &, RFs &)

HBufC *	AliasedAddressL	(	const TDesC &	aOriginalAddress,
			RFs &	aFs
		)	[private]

Generate aliased address from an address that may be pure or not Caller must free buffer when no lenger needed

Parameters

const TDesC & aOriginalAddress	original address may be pure or not
RFs & aFs	file system handle

AliasedAddressL(const CDesCArray &, RFs &)

CDesCArray *	AliasedAddressL	(	const CDesCArray &	aOriginalAddress,
			RFs &	aFs
		)	[private]

Generate array of aliased addresses from an arrays of addresses that may be pure or not Caller must free the array when no lenger needed

Parameters

const CDesCArray & aOriginalAddress	array of original addresses, may be pure or not
RFs & aFs

AppendPreviouslySentItemL(TInt64, const TDesC &)

IMPORT_C void	AppendPreviouslySentItemL	(	TInt64	aDate,
			const TDesC &	aSender
		)

Parameters

TInt64 aDate
const TDesC & aSender

ApplicId()

IMPORT_C TPtrC16

ApplicId

(

)

const

Identification of the destination application accessor.

AuxApplicInfo()

IMPORT_C TPtrC8

AuxApplicInfo

(

)

const

Auxiliary application information for internal use of the destination application accessor.

BccRecipients()

const CDesCArray &

BccRecipients

(

)

const [inline]

Give const access to the "Bcc" recipient list

CancelStatus()

TInt

CancelStatus

(

)

const [inline]

Get status of cancel operation

CcRecipients()

const CDesCArray &

CcRecipients

(

)

const [inline]

Give const access to the "Cc" recipient list

ConstructL(TInt16)

void

ConstructL

(

TInt16

aMmsDefaultVersion

)

[private]

By default Symbian OS constructor is private.

Parameters

TInt16 aMmsDefaultVersion

ContentClass()

TInt

ContentClass

(

)

const [inline]

Return the content class value as specified in MMS encapsulation 1.3.

ContentLocation()

IMPORT_C TPtrC8

ContentLocation

(

)

const

Content-Location accessor. Used in a Message Notification.

CopyAddresseeListL(const CDesCArray &, TMmsRecipients, const TPtrC &, RFs &)

void	CopyAddresseeListL	(	const CDesCArray &	aArray,
			TMmsRecipients	aType,
			const TPtrC &	aExclude,
			RFs &	aFs
		)	[private]

Copy addressee list from source headers

Parameters

const CDesCArray & aArray	addressee list
TMmsRecipients aType	recipient lins type
const TPtrC & aExclude	Address to be excluded from the list (sender)
RFs & aFs	file system handle

CopyL(TMsvPartList, TBool)

IMPORT_C CMmsHeaders *	CopyL	(	TMsvPartList	aParts,
			TBool	aReply
		)

Make a copy of MmsHeaders

Parameters

TMsvPartList aParts	message part list
TBool aReply	if the new message is a reply message. This has meaning for recipient handling.

CopyL(TMsvPartList, TBool, RFs &)

IMPORT_C CMmsHeaders *	CopyL	(	TMsvPartList	aParts,
			TBool	aReply,
			RFs &	aFs
		)

Make a copy of MmsHeaders

Since: 3.1

Parameters

TMsvPartList aParts	message part list
TBool aReply	if the new message is a reply message. This has meaning for recipient handling.
RFs & aFs	file system handle. Needed for alias handling

CreateContentId(TDes8 &)

IMPORT_C void

CreateContentId

(

TDes8 &

aCid

)

[static]

Creates a ContentId to be used in mime headers

Parameters

TDes8 & aCid

the created contentId (OUT) The caller must reserve a buffer that is at least 12 bytes long ( 10 bytes for a 32 bit integer converted to a string + angle brackets )

Date()

TInt64

Date

(

)

[inline]

Get Date

DeleteResultArray()

const RPointerArray< CMmsDeleteResultArray > &

DeleteResultArray

(

)

[inline]

Accessor to delete result array for looking at the content. The items should normally be accessed in sequential order by outsiders.

DeliveryDate()

IMPORT_C TInt64

DeliveryDate

(

)

Delivery date accessor.

DeliveryReport()

TInt

DeliveryReport

(

)

[inline]

Delivery Report Request accessor.

DeliveryTimeInterval()

IMPORT_C TInt

DeliveryTimeInterval

(

)

Delivery time interval accessor.

DistributionIndicator()

TInt

DistributionIndicator

(

)

const [inline]

Distribution indicator accessor

Since: 2.6

DrmContent()

TInt

DrmContent

(

)

const [inline]

Get DRM content indicator (encapsulation 1.3)

ElementDescriptorL()

IMPORT_C CMmsElementDescriptor &

ElementDescriptorL

(

)

Element descriptor accessor for edit usage.

Since: 2.6

ExpiryDate()

IMPORT_C TInt64

ExpiryDate

(

)

Expiration date accessor.

ExpiryInterval()

IMPORT_C TInt

ExpiryInterval

(

)

Expiration interval accessor.

ExtendedNotification()

IMPORT_C TPtrC

ExtendedNotification

(

)

const

Extended Notification accessor.

Since: 2.6

ExternalizeArrayL(CDesC16Array &, RWriteStream &)

void	ExternalizeArrayL	(	CDesC16Array &	anArray,
			RWriteStream &	aStream
		)	const [private]

Externalize Array.

Parameters

CDesC16Array & anArray	the array to be externalized
RWriteStream & aStream	stream where to write.

ExternalizeL(RMsvWriteStream &)

IMPORT_C void

ExternalizeL

(

RMsvWriteStream &

aStream

)

const [private]

Externalize.

Parameters

RMsvWriteStream & aStream

write stream

GetMaximumImage(TInt &, TInt &)

IMPORT_C void	GetMaximumImage	(	TInt &	aWidth,
			TInt &	aHeight
		)	const

Maximum image size accessor.

Parameters

TInt & aWidth	image width (OUT)
TInt & aHeight	image height (OUT)

InsertDeleteContentLocationL(TUint, const TDesC8 &)

IMPORT_C void	InsertDeleteContentLocationL	(	TUint	aOrder,
			const TDesC8 &	aContentLocation
		)

Insert delete result content location. If corresponding entry is found, just insert content location to entry, otherwise create new CMmsDeleteResultArray item and insert it into array

Parameters

TUint aOrder	the order number of the not deleted entry
const TDesC8 & aContentLocation

InsertDeleteResponseTextL(TUint, const TDesC &)

IMPORT_C void	InsertDeleteResponseTextL	(	TUint	aOrder,
			const TDesC &	aResposeText
		)

Insert delete result response text. If corresponding entry is found, just insert response text to entry, otherwise create new CMmsDeleteResultArray item and insert it into array

Parameters

TUint aOrder	the order number of the not deleted entry
const TDesC & aResposeText

InsertDeleteStatusL(TUint, const TInt32)

IMPORT_C void	InsertDeleteStatusL	(	TUint	aOrder,
			const TInt32	aStatus
		)

Insert delete status. If corresponding entry is found, just insert delete status to entry, otherwise create new CMmsDeleteResultArray item and insert it into array

Parameters

TUint aOrder	the order number of the not deleted entry
const TInt32 aStatus	the previous sender.

InsertPreviouslySentByL(TInt, const TDesC &)

IMPORT_C void	InsertPreviouslySentByL	(	TInt	aOrder,
			const TDesC &	aSender
		)

Parameters

TInt aOrder
const TDesC & aSender

InsertPreviouslySentDateL(TInt, TInt64)

IMPORT_C void	InsertPreviouslySentDateL	(	TInt	aOrder,
			TInt64	aDate
		)

Parameters

TInt aOrder
TInt64 aDate

InternalizeArrayL(CDesC16Array &, RReadStream &)

void	InternalizeArrayL	(	CDesC16Array &	anArray,
			RReadStream &	aStream
		)	[private]

Internalize Array.

Parameters

CDesC16Array & anArray	the array where to write data
RReadStream & aStream	a stream where to read data from

InternalizeL(RMsvReadStream &)

IMPORT_C void

InternalizeL

(

RMsvReadStream &

aStream

)

[private]

Internalize.

Parameters

RMsvReadStream & aStream

read stream

LimitStringSize(const TPtrC8 &, TInt)

TPtrC8	LimitStringSize	(	const TPtrC8 &	aString,
			TInt	aMaxSize
		)	[private, static]

Limit string size to maximum length

Parameters

const TPtrC8 & aString	input string
TInt aMaxSize	maximum length of the string

LimitStringSize(const TPtrC16 &, TInt)

TPtrC16	LimitStringSize	(	const TPtrC16 &	aString,
			TInt	aMaxSize
		)	[private, static]

Limit string size to maximum length

Parameters

const TPtrC16 & aString	input string
TInt aMaxSize	maximum length of the string

MMBoxMessageHeadersL()

IMPORT_C CMmsMMBoxMessageHeaders &

MMBoxMessageHeadersL

(

)

MMBox message headers accessor for edit usage

Since: 2.6

MMBoxViewHeadersL()

IMPORT_C CMmsMMBoxViewHeaders &

MMBoxViewHeadersL

(

)

MMBox view headers accessor for edit usage

Since: 2.6

MessageClass()

TInt

MessageClass

(

)

const [inline]

Message class accessor

MessageComplete()

TInt

MessageComplete

(

)

[inline]

Message complete indicator accessor.

Since: 2.6

MessageId()

IMPORT_C TPtrC8

MessageId

(

)

const

Message-ID accessor

MessagePriority()

TInt

MessagePriority

(

)

const [inline]

Message priority accessor.

MessageRoot()

TMsvAttachmentId

MessageRoot

(

)

const [inline]

Message root part accessor.

MessageSize()

TInt

MessageSize

(

)

const [inline]

Get Message-Size. Used in a Message Notification.

MessageType()

TInt

MessageType

(

)

[inline]

Get Message-Type

MmsVersion()

TInt16

MmsVersion

(

)

[inline]

Get MMS-Version

MultipartType()

TInt

MultipartType

(

)

const [inline]

Multipart type accessor

Since: 2.6

NewL()

IMPORT_C CMmsHeaders *

NewL

(

)

[static]

Two-phased constructor. This is a legacy function and sets the default mms version to a hard coded value. All client should use the NewL version that gives the version as parameter. The version value should come form CMmsSettings class

NewL(TInt16)

IMPORT_C CMmsHeaders *

NewL

(

TInt16

aMmsVersion

)

[static]

Two-phased constructor.

Parameters

TInt16 aMmsVersion

The version of MMS encapsulation that should be used unless the actual message contains some other value

PreviouslySentList()

const RPointerArray< CMmsSendingChain > &

PreviouslySentList

(

)

[inline]

ReadOnlyElementDescriptor()

const CMmsElementDescriptor *

ReadOnlyElementDescriptor

(

)

const [inline]

Element descriptor accessor for read only usage.

Since: 2.6

ReadOnlyMMBoxMessageHeaders()

const CMmsMMBoxMessageHeaders *

ReadOnlyMMBoxMessageHeaders

(

)

const [inline]

MMBox message headers accessor for read only usage

Since: 2.6

ReadOnlyMMBoxViewHeaders()

const CMmsMMBoxViewHeaders *

ReadOnlyMMBoxViewHeaders

(

)

const [inline]

MMBox view headers accessor for read only usage

Since: 2.6

ReadReply()

TInt

ReadReply

(

)

[inline]

Read Reply Request accessor.

ReadStatus()

TInt

ReadStatus

(

)

const [inline]

Read status accessor.

ReceivingTime()

TTime

ReceivingTime

(

)

const [inline]

The time the message was received in the terminal.

RecommendedRetrievalMode()

TInt

RecommendedRetrievalMode

(

)

const [inline]

Get recommended retrieval mode This header appears in a notification and may recommend manual retrieval.

RecommendedRetrievalModeText()

IMPORT_C TPtrC16

RecommendedRetrievalModeText

(

)

const

Get explanation why retrival mode is recommended

RelatedEntry()

TMsvId

(

)

const [inline]

Related entry accessor

Since: 2.6

RemoveAddressee(const TDesC &)

IMPORT_C TBool

RemoveAddressee

(

const TDesC &

aRealAddress

)

Remove a given address from the right typed list.

Parameters

const TDesC & aRealAddress

recipient address.

RemoveAddressee(CDesCArray &, const TDesC &)

TBool	RemoveAddressee	(	CDesCArray &	aList,
			const TDesC &	aAddress
		)	[private]

Remove a addressee from a given addressee list.

Parameters

CDesCArray & aList	addressee list
const TDesC & aAddress	addressee to match

ReplaceCancelId()

IMPORT_C TPtrC8

ReplaceCancelId

(

)

const

Get id of message to be replaced or cancelled

ReplyApplicId()

IMPORT_C TPtrC16

ReplyApplicId

(

)

const

Identification of an application to which replies are addressed accessor.

ReplyCharging()

TInt

ReplyCharging

(

)

const [inline]

ReplyCharging accessor.

ReplyChargingDate()

IMPORT_C TInt64

ReplyChargingDate

(

)

ReplyCharging date accessor.

ReplyChargingId()

IMPORT_C TPtrC8

ReplyChargingId

(

)

const

ReplyChargingId accessor.

ReplyChargingInterval()

IMPORT_C TInt

ReplyChargingInterval

(

)

ReplyCharging interval accessor.

ReplyChargingSize()

TInt

ReplyChargingSize

(

)

const [inline]

ReplyChargingSize accessor.

ReportAllowed()

TInt32

ReportAllowed

(

)

const [inline]

Report-Allowed accessor

Reset(CMmsSettings *)

IMPORT_C void

Reset

(

CMmsSettings *

aSettings = NULL

)

Reset.

Parameters

CMmsSettings * aSettings = NULL

MMS settings to be used for initial values. Can be NULL.

ResponseStatus()

TInt32

ResponseStatus

(

)

const [inline]

Response-Status accessor

ResponseText()

IMPORT_C TPtrC

ResponseText

(

)

const

Response text accessor. Same string is used for Response text, Retrieve text and Status text as all strings are information messages coming in from the MMSC and only one of them can be present in any PDU

RestoreL(CMsvStore &)

IMPORT_C void

RestoreL

(

CMsvStore &

aStore

)

Internalize the headers.

Parameters

CMsvStore & aStore

CMsvStore

RootContentId()

IMPORT_C TPtrC8

RootContentId

(

)

const

Root Content-ID accessor.

Sender()

IMPORT_C TPtrC

Sender

(

)

const

Sender accessor

SenderVisibility()

TInt

SenderVisibility

(

)

[inline]

Sender visibility accessor.

SetAdaptationAllowed(TInt)

void

SetAdaptationAllowed

(

TInt

aAdaptationAllowed

)

[inline]

Set the header that tells if MMSC is allowed to alter the message (make it smaller).

Parameters

TInt aAdaptationAllowed

Adaptation allowed header. Possible values:KMmsYesKMmsNo

SetApplicIdL(const TDesC16 &)

IMPORT_C void

SetApplicIdL

(

const TDesC16 &

aApplicId

)

Identification of the destination application mutator.

Parameters

const TDesC16 & aApplicId

application ID

SetAuxApplicInfoL(const TDesC8 &)

IMPORT_C void

SetAuxApplicInfoL

(

const TDesC8 &

aAuxApplicInfo

)

Auxiliary application information for internal use of the destination application mutator.

Parameters

const TDesC8 & aAuxApplicInfo

auxiliary application info

SetCancelStatus(TInt)

void

SetCancelStatus

(

TInt

aCancelStatus

)

[inline]

Set status of cancel operation

Parameters

TInt aCancelStatus

Status of cancel operation. Possible values:KMmsCancelRequestSuccessfullyReceivedKMmsCancelRequestCorrupted

SetContentClass(TInt)

void

SetContentClass

(

TInt

aContentClass

)

[inline]

Set the content class of the message as specified in MMS encapsulation 1.3-

Parameters

TInt aContentClass

content class value from mmsconst.hKMmsContentClassTextKMmsContentClassImageBasicKMmsContentClassImageRichKMmsContentClassVideoBasicKMmsContentClassVideoRichKMmsContentClassMegaPixelKMmsContentClassContentBasicKMmsContentClassContentRich

SetContentLocationL(const TDesC8 &)

IMPORT_C void

SetContentLocationL

(

const TDesC8 &

aURL

)

Content-Location mutator. Used in a Message Notification.

Parameters

const TDesC8 & aURL

URL of the message.

SetDate(TInt64)

void

SetDate

(

TInt64

aTime

)

[inline]

Set Date

Parameters

TInt64 aTime

seconds from 1.1. 1970 Date must be in UTC time zone

SetDeliveryDate(TInt64)

IMPORT_C void

SetDeliveryDate

(

TInt64

aDate

)

Delivery date mutator.

Parameters

TInt64 aDate

The date and time the message will be delivered to the recipient by the MMSC in seconds from 1970-01-01. Date must be in UTC time zone

SetDeliveryReport(TInt)

void

SetDeliveryReport

(

TInt

aRequest

)

[inline]

Delivery Report Request mutator.

Parameters

TInt aRequest

Yes or No (values defined in MMSCONST.H)

SetDeliveryTimeInterval(TInt)

IMPORT_C void

SetDeliveryTimeInterval

(

TInt

aInterval

)

Delivery time interval mutator.

Parameters

TInt aInterval

The length of time after which the message will be delivered to the recipient by the MMSC. Expressed in seconds.

SetDistributionIndicator(const TInt)

void

SetDistributionIndicator

(

const TInt

aDistributionIndicator

)

[inline]

Distribution indicator mutator

Since: 2.6

Parameters

const TInt aDistributionIndicator

X-Mms-DistributionIndicator value KMmsYes/KMmsNo

SetDrmContent(TInt)

void

SetDrmContent

(

TInt

aDrmContent

)

[inline]

Set DRM Content indicator header.

Parameters

TInt aDrmContent

Messag has DRM content. Possible values:KMmsYesKMmsNo

SetExpiryDate(TInt64)

IMPORT_C void

SetExpiryDate

(

TInt64

aDate

)

Expiration date mutator.

Parameters

TInt64 aDate

The date and time the message will expire in seconds from 1970-01-01. Date must be in UTC time zone

SetExpiryInterval(TInt)

IMPORT_C void

SetExpiryInterval

(

TInt

aInterval

)

Expiration interval mutator

Parameters

TInt aInterval

The length of time after which the message is discarded by MMSC. Expressed in seconds.

SetExtendedNotificationL(const TDesC &)

IMPORT_C void

SetExtendedNotificationL

(

const TDesC &

aText

)

Extended Notification mutator.

Since: 2.6

Parameters

const TDesC & aText

Extended notification text.

SetMaximumImage(TInt, TInt)

IMPORT_C void	SetMaximumImage	(	TInt	aWidth,
			TInt	aHeight
		)

Maximum image size mutator.

Parameters

TInt aWidth	image width
TInt aHeight	image height

SetMessageClass(TInt)

void

SetMessageClass

(

TInt

aClass

)

[inline]

Message class mutator values defined in MMSCONST.H

Parameters

TInt aClass

SetMessageComplete(TInt)

void

SetMessageComplete

(

TInt

aExtensionStatus

)

[inline]

Message complete indicator mutator

Since: 2.6

Parameters

TInt aExtensionStatus

indicator that tells if the whole message fits into extension text string. 0x20 = Message body size > text, message retrieval uncomplete 0x30 = Message retrieval complete (whole message body in IExtendedNotificationText) other values reserved.

SetMessageIdL(const TDesC8 &)

IMPORT_C void

SetMessageIdL

(

const TDesC8 &

aId

)

Message-ID mutator

Parameters

const TDesC8 & aId

SetMessagePriority(TInt)

void

SetMessagePriority

(

TInt

aPriority

)

[inline]

Message priority mutator (Low/Normal/High). Default: Normal.

Parameters

TInt aPriority

Message priority, values defined in MMSCONST.H

SetMessageRoot(const TMsvAttachmentId)

void

SetMessageRoot

(

const TMsvAttachmentId

aId

)

[inline]

Message root part mutator.

Parameters

const TMsvAttachmentId aId

Id of the message part that should be displayed first. Should point to the SMIL part that starts the message display.

SetMessageSize(TInt)

void

SetMessageSize

(

TInt

aSize

)

[inline]

Set Message-Size header.

Parameters

TInt aSize

Message-Size in bytes. Used in a Message Notification.

SetMessageType(TInt)

void

SetMessageType

(

TInt

aType

)

[inline]

Set Message-Type

Parameters

TInt aType

message type

SetMmsVersion(TInt16)

void

SetMmsVersion

(

TInt16

aVersion

)

[inline]

Set MMS-Version

Parameters

TInt16 aVersion

MMS version

SetMultipartType(const TInt)

void

SetMultipartType

(

const TInt

aMultipartType

)

[inline]

Multipart type mutator

Since: 2.6

Parameters

const TInt aMultipartType

type of multipart data saved to this entry (WSP assigned number)

SetReadReply(TInt)

void

SetReadReply

(

TInt

aRequest

)

[inline]

Read Reply Request mutator.

Parameters

TInt aRequest

Yes or No (values defined in MMSCONST.H)

SetReadStatus(const TInt)

void

SetReadStatus

(

const TInt

aReadStatus

)

[inline]

Read status mutator.

Parameters

const TInt aReadStatus

status value. See mmsconst.h.

SetReceivingTime(TTime)

void

SetReceivingTime

(

TTime

aTime

)

[inline]

Save the time when the message was received. This header allows the iDate field in TMsvEntry to contain either the receiving time or the sending time. If the TMsvEntry shows the sending time, the receiving time can be accessed through this field.

Parameters

TTime aTime

time in UTC time zone when the message has been received.

SetRecommendedRetrievalMode(TInt)

void

SetRecommendedRetrievalMode

(

TInt

aRetrievalMode

)

[inline]

Set recommended retrieval mode. This header appears in a notification and may recommend manual retrieval.

Parameters

TInt aRetrievalMode

Suggested retrieval mode. Possible valuesKMmsRecommendedRetrievalModeManual

SetRecommendedRetrievalModeTextL(const TDesC16 &)

IMPORT_C void

SetRecommendedRetrievalModeTextL

(

const TDesC16 &

aRecommendedRetrievalModeText

)

Set explanation why retrival mode is recommended

Parameters

const TDesC16 & aRecommendedRetrievalModeText

SetRelatedEntry(const TMsvId)

void

SetRelatedEntry

(

const TMsvId

aRelatedEntry

)

[inline]

Related entry mutator

Since: 2.6

Parameters

const TMsvId aRelatedEntry

Id of an entry that is connected to this one by some relationship

SetReplaceCancelIdL(const TDesC8 &)

IMPORT_C void

SetReplaceCancelIdL

(

const TDesC8 &

aReplaceCancelId

)

Set id of message to be replaced or cancelled

Parameters

const TDesC8 & aReplaceCancelId

SetReplyApplicIdL(const TDesC16 &)

IMPORT_C void

SetReplyApplicIdL

(

const TDesC16 &

aApplicId

)

Identification of an application to which replies are addressed mutator.

Parameters

const TDesC16 & aApplicId

reply to application ID

SetReplyCharging(const TInt)

void

SetReplyCharging

(

const TInt

aReplyCharging

)

[inline]

ReplyCharging mutator.

Parameters

const TInt aReplyCharging

value. See mmsconst.h

SetReplyChargingDate(TInt64)

IMPORT_C void

SetReplyChargingDate

(

TInt64

aDate

)

ReplyCharging date mutator.

Parameters

TInt64 aDate

The date and time until which the sender pays charges for reply in seconds from 1970-01-01. Date must be in UTC time zone

SetReplyChargingIdL(const TDesC8 &)

IMPORT_C void

SetReplyChargingIdL

(

const TDesC8 &

aId

)

ReplyChargingID mutator.

Parameters

const TDesC8 & aId

original message ID to which this is a reply to

SetReplyChargingInterval(TInt)

IMPORT_C void

SetReplyChargingInterval

(

TInt

aInterval

)

ReplyCharging interval mutator.

Parameters

TInt aInterval

The length of time during which the sender pays charges for reply. Expressed in seconds.

SetReplyChargingSize(const TInt)

void

SetReplyChargingSize

(

const TInt

aReplyChargingSize

)

[inline]

ReplyChargingSize mutator.

Parameters

const TInt aReplyChargingSize

maximum size of message for which reply charging applies.

SetReportAllowed(TInt32)

void

SetReportAllowed

(

TInt32

aValue

)

[inline]

Report-Allowed mutator

Parameters

TInt32 aValue

Report-Allowed value

SetResponseStatus(TInt32)

void

SetResponseStatus

(

TInt32

aValue

)

[inline]

Response-Status mutator

Parameters

TInt32 aValue

Response-Status value

SetResponseTextL(const TDesC &)

IMPORT_C void

SetResponseTextL

(

const TDesC &

aText

)

Response text mutator. Same string is used for Response text, Retrieve text and Status text as all strings are information messages coming in from the MMSC and only one of them can be present in any PDU

Parameters

const TDesC & aText

Response text string

SetRootContentIdL(const TDesC8 &)

IMPORT_C void

SetRootContentIdL

(

const TDesC8 &

aId

)

Root Content-ID mutator.

Parameters

const TDesC8 & aId

SetSenderL(const TDesC &)

IMPORT_C void

SetSenderL

(

const TDesC &

aAlias

)

Sender mutator

Parameters

const TDesC & aAlias

SetSenderVisibility(TInt)

void

SetSenderVisibility

(

TInt

aVisibility

)

[inline]

Sender visibility mutator.

Parameters

TInt aVisibility

Hide or Show (values defined in MMSCONST.H)

SetSettings(CMmsSettings *)

IMPORT_C void

SetSettings

(

CMmsSettings *

aSettings

)

Set initial setting values from service settings

Parameters

CMmsSettings * aSettings

MMS service settings. Optional.

SetStatus(const TInt)

void

SetStatus

(

const TInt

aStatus

)

[inline]

Status mutator

Parameters

const TInt aStatus

status value. See mmsconst.h.

SetSubjectL(const TDesC &)

IMPORT_C void

SetSubjectL

(

const TDesC &

aSubject

)

Subject mutator. Note that Client MTM should update explicitly TMsvEntry.iDescription too.

Parameters

const TDesC & aSubject

subject string,

SetTidL(const TDesC8 &)

IMPORT_C void

SetTidL

(

const TDesC8 &

aCid

)

Set Transaction-ID

Parameters

const TDesC8 & aCid

transaction ID

Size()

IMPORT_C TInt

Size

(

)

const

Size of the MMS headers object in memory. The multipart objet size is not included.

Status()

TInt

Status

(

)

const [inline]

Status accessor

StoreL(CMsvStore &)

IMPORT_C void

StoreL

(

CMsvStore &

aStore

)

Externalize the headers. Caller must commit the store to allow several store operations before committing the store

Parameters

CMsvStore & aStore

CMsvStore in edit mode.

Subject()

IMPORT_C TPtrC

Subject

(

)

const

Subject accessor.

Tid()

IMPORT_C TPtrC8

Tid

(

)

const

Get Transcation-ID

ToRecipients()

const CDesCArray &

ToRecipients

(

)

const [inline]

Give const access to the "To" recipient list

TypedAddresseeList(TMmsRecipients)

IMPORT_C const CDesCArray &

TypedAddresseeList

(

TMmsRecipients

aType

)

Returns recipients that are of specified type (To, Cc, Bcc).

Parameters

TMmsRecipients aType

specifies recipient type (types defined in MMSCONST.H)

Member Data Documentation

TInt32 iAdaptationAllowed

TInt32

iAdaptationAllowed

[private]

HBufC * iApplicationId

HBufC *

iApplicationId

[private]

HBufC8 * iApplicationInfo

HBufC8 *

iApplicationInfo

[private]

CDesCArray * iBccArray

CDesCArray *

iBccArray

[private]

TInt32 iCancelStatus

TInt32

iCancelStatus

[private]

CDesCArray * iCcArray

CDesCArray *

iCcArray

[private]

TInt32 iContentClass

TInt32

iContentClass

[private]

HBufC8 * iContentLocation

HBufC8 *

iContentLocation

[private]

TInt64 iDate

TInt64

iDate

[private]

RPointerArray< CMmsDeleteResultArray > iDeleteResultArray

RPointerArray< CMmsDeleteResultArray >

iDeleteResultArray

[private]

TLinearOrder< CMmsDeleteResultArray > iDeleteResultOrder

TLinearOrder< CMmsDeleteResultArray >

iDeleteResultOrder

[private]

TInt32 iDelivReport

TInt32

iDelivReport

[private]

TInt64 iDelivery

TInt64

iDelivery

[private]

TBool iDeliveryAbs

TBool

iDeliveryAbs

[private]

TInt32 iDistributionIndicator

TInt32

iDistributionIndicator

[private]

TInt32 iDrmContent

TInt32

iDrmContent

[private]

CMmsElementDescriptor * iElementDescriptor

CMmsElementDescriptor *

iElementDescriptor

[private]

TInt64 iExpiry

TInt64

iExpiry

[private]

TBool iExpiryAbs

TBool

iExpiryAbs

[private]

HBufC * iExtendedNotificationText

HBufC *

iExtendedNotificationText

[private]

TInt iExtensionStatus

TInt

iExtensionStatus

[private]

TLinearOrder< CMmsSendingChain > iLinearOrder

TLinearOrder< CMmsSendingChain >

iLinearOrder

[private]

TInt32 iMaxImageHeight

TInt32

iMaxImageHeight

[private]

TInt32 iMaxImageWidth

TInt32

iMaxImageWidth

[private]

HBufC8 * iMessageId

HBufC8 *

iMessageId

[private]

TUint32 iMessageSize

TUint32

iMessageSize

[private]

CMmsMMBoxMessageHeaders * iMmBoxMessageHeaders

CMmsMMBoxMessageHeaders *

iMmBoxMessageHeaders

[private]

CMmsMMBoxViewHeaders * iMmBoxViewHeaders

CMmsMMBoxViewHeaders *

iMmBoxViewHeaders

[private]

TInt16 iMmsDefaultVersion

TInt16

iMmsDefaultVersion

[private]

TInt32 iMsgClass

TInt32

iMsgClass

[private]

TInt32 iMsgType

TInt32

iMsgType

[private]

TInt32 iMultipartType

TInt32

iMultipartType

[private]

HBufC * iOperatorResponseText

HBufC *

iOperatorResponseText

[private]

RPointerArray< CMmsSendingChain > iPreviouslySentArray

RPointerArray< CMmsSendingChain >

iPreviouslySentArray

[private]

TInt32 iPriority

TInt32

iPriority

[private]

TInt32 iReadReply

TInt32

iReadReply

[private]

TInt32 iReadStatus

TInt32

iReadStatus

[private]

TTime iReceivingTime

TTime

iReceivingTime

[private]

TInt32 iRecommendedRetrievalMode

TInt32

iRecommendedRetrievalMode

[private]

HBufC * iRecommendedRetrievalModeText

HBufC *

iRecommendedRetrievalModeText

[private]

TMsvId iRelatedEntry

TMsvId

iRelatedEntry

[private]

HBufC8 * iReplaceCancelId

HBufC8 *

iReplaceCancelId

[private]

TInt32 iReplyCharging

TInt32

iReplyCharging

[private]

TBool iReplyChargingAbs

TBool

iReplyChargingAbs

[private]

TInt64 iReplyChargingDeadline

TInt64

iReplyChargingDeadline

[private]

HBufC8 * iReplyChargingId

HBufC8 *

iReplyChargingId

[private]

TInt32 iReplyChargingSize

TInt32

iReplyChargingSize

[private]

HBufC * iReplyToApplicationId

HBufC *

iReplyToApplicationId

[private]

TInt32 iReportAllowed

TInt32

iReportAllowed

[private]

TInt32 iResponseStatus

TInt32

iResponseStatus

[private]

HBufC8 * iRootContentID

HBufC8 *

iRootContentID

[private]

HBufC * iSender

HBufC *

iSender

[private]

TInt32 iSenderVisi

TInt32

iSenderVisi

[private]

TMsvAttachmentId iStart

TMsvAttachmentId

iStart

[private]

TInt32 iStatus

TInt32

iStatus

[private]

HBufC * iSubject

HBufC *

iSubject

[private]

HBufC8 * iTID

HBufC8 *

iTID

[private]

CDesCArray * iToArray

CDesCArray *

iToArray

[private]

TInt16 iVersion

TInt16

iVersion

[private]