CMmsSettings Class Reference

class CMmsSettings : public CBase

CMmsSettings contains all Mms Engine's settings. Loading and Saving methods are offered as well as accessors for all setting values. Mutators are offered to most of the settings, but there are a few 'read-only' settings. mmsserversettings.lib 3.0

Inherits from

Public Member Functions
~CMmsSettings()
TBool AcceptAdvertisementMessages()
TBool AcceptAnonymousMessages()
TBool AcceptInformationalMessages()
TBool AcceptPersonalMessages()
IMPORT_C TInt32AccessPoint(TInt)
TInt AccessPointCount()
IMPORT_C voidAddAccessPointL(TUint32, TInt)
TMsvId ApplicationFolder()
IMPORT_C voidCopyL(const CMmsSettings &)
IMPORT_C TIntCreateFolderEntryL(CMsvSession &, TMsvId, const TDesC &, TMsvId &)
IMPORT_C voidCreateNewServiceL(CMsvSession &)
TInt32 CreationMode()
IMPORT_C voidDeleteAccessPointL(TInt)
TInt32 DeliveryReportSendingAllowed()
TInt32 DeliveryReportWanted()
TInt32 ExpiryInterval()
TInt ExpiryOvershoot()
TBool FetchOverride()
IMPORT_C TMsvIdFolderEntryL(CMsvSession &, TMsvId, const TDesC &)
TInt32 ImageHeight()
TInt32 ImageWidth()
IMPORT_C voidLoadSettingsL()
TBool LocalMode()
const TDesC &LocalModeIn()
const TDesC &LocalModeOut()
TBool LogEmailRecipients()
TMsvId MMBoxFolder()
TInt32 MaximumReceiveSize()
TInt32 MaximumSendSize()
TInt32 MessageClass()
TInt32 MessagePriority()
TInt16 MmsVersion()
TBool MoveToSent()
IMPORT_C CMmsSettings *NewL()
TMsvId NotificationFolder()
TBool ReadReplyReportSendingAllowed()
TInt32 ReadReplyReportWanted()
TMmsReceivingModeReceivingModeForeign()
TMmsReceivingModeReceivingModeHome()
IMPORT_C voidReset()
IMPORT_C voidRestoreFactorySettingsL(CMsvSession &, TMmsFactorySettingsLevel)
IMPORT_C voidSaveSettingsL()
TInt32 SenderVisibility()
TMsvId Service()
voidSetAcceptAdvertisementMessages(TBool)
voidSetAcceptAnonymousMessages(TBool)
voidSetAcceptInformationalMessages(TBool)
voidSetAcceptPersonalMessages(TBool)
voidSetCreationMode(TMmsCreationMode)
voidSetDeliveryReportSendingAllowed(TInt32)
voidSetDeliveryReportWanted(TInt32)
voidSetExpiryInterval(TInt32)
voidSetFetchOverride(TBool)
voidSetImageHeight(TInt32)
voidSetImageWidth(TInt32)
voidSetLocalMode(TBool)
voidSetLocalModeIn(const TDesC &)
voidSetLocalModeOut(const TDesC &)
voidSetLogEmailRecipients(TBool)
voidSetMessageClass(TMmsMessageClass)
voidSetMessagePriority(TMmsMessagePriority)
voidSetReadReplyReportSendingAllowed(TBool)
voidSetReadReplyReportWanted(TInt32)
voidSetReceivingModeForeign(TMmsReceivingMode)
voidSetReceivingModeHome(TMmsReceivingMode)
voidSetSenderVisibility(TMmsMessageSenderVisibility)
TInt32 SettingsVersion()
TBool ShowSentTime()
IMPORT_C TIntValidateSettings()
Private Member Functions
CMmsSettings()
CRepository *ConnectCenRepL(const TUid)
voidConstructL()
voidSaveAccesspointArrayL()
voidSaveSetting(TUint32, TInt)
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
TBool iAcceptAdvertisement
TBool iAcceptAnonymous
TBool iAcceptInformational
TBool iAcceptPersonal
RArray< TUint32 >iAccesspointArray
TMsvId iApplicationFolderId
TInt32 iCreationMode
TMsvId iDefaultServiceId
TInt32 iDeliveryReportAllowed
TInt32 iDeliveryReportWanted
TInt32 iExpiryInterval
TInt iExpiryOvershoot
TBool iFetchOverride
TInt32 iImageHeight
TInt32 iImageWidth
TBool iLocalMode
HBufC *iLocalModeDir
TBool iLogEmailRecipients
TMsvId iMMBoxFolderId
TInt32 iMaxReceiveSize
TInt32 iMaxSendSize
TInt32 iMessageClass
TInt32 iMessagePriority
CRepository *iMmsRepository
TInt16 iMmsVersion
TBool iMoveToSent
TMsvId iNotificationFolderId
TBool iReadReplyReportAllowed
TInt32 iReadReplyReportWanted
TInt32 iReceivingModeForeign
TInt32 iReceivingModeHome
TInt32 iSenderVisibility
TInt32 iSettingsVersion
TBool iShowSentTime

Constructor & Destructor Documentation

CMmsSettings()

CMmsSettings()[private]

C++ default constructor.

~CMmsSettings()

~CMmsSettings()[virtual]

Destructor.

Member Functions Documentation

AcceptAdvertisementMessages()

TBool AcceptAdvertisementMessages()const [inline]

Get accept advertisement messages flag. ETrue if advertisements accepted

AcceptAnonymousMessages()

TBool AcceptAnonymousMessages()const [inline]

Get accept anonymous messages flag (anonymous message == message without From: field). ETrue if anonymous messages accepted.

AcceptInformationalMessages()

TBool AcceptInformationalMessages()const [inline]

Get accept informational messages flag. ETrue if informational messages accepted

AcceptPersonalMessages()

TBool AcceptPersonalMessages()const [inline]

Get accept personal messages flag. ETrue if personal messages accepted

AccessPoint(TInt)

IMPORT_C TInt32AccessPoint(TIntaIndex)const

AccessPoint is accessor for accesspoint array accesspoint reference to commdb or KErrNotFound if given index is incorrect

Parameters

TInt aIndex

AccessPointCount()

TInt AccessPointCount()const [inline]

AccessPointCount number of accesspoints in the accesspoint array

AddAccessPointL(TUint32, TInt)

IMPORT_C voidAddAccessPointL(TUint32aAccessPointId,
TIntaIndex
)

Adds an accesspoint id to a specific index in the array

Parameters

TUint32 aAccessPointIdspecifies the accesspoint id
TInt aIndexspecifies the array index

ApplicationFolder()

TMsvId ApplicationFolder()const [inline]

Gets application folder id TMsvId of the application folder

ConnectCenRepL(const TUid)

CRepository *ConnectCenRepL(const TUidaRepositoryId)[private]

Utility to connect to a particular CenRep

Parameters

const TUid aRepositoryId

ConstructL()

voidConstructL()[private]

By default EPOC constructor is private. void

CopyL(const CMmsSettings &)

IMPORT_C voidCopyL(const CMmsSettings &aMmsSettings)

CopyL copies the contents (member values) from aMmsSettings.

Parameters

const CMmsSettings & aMmsSettingsrefernce to another CMmsSettings object

CreateFolderEntryL(CMsvSession &, TMsvId, const TDesC &, TMsvId &)

IMPORT_C TIntCreateFolderEntryL(CMsvSession &aSession,
TMsvIdaParentFolder,
const TDesC &aFolderName,
TMsvId &aFolderId
)

CreateFolderEntryL creates a new folder entry under a given folder with 'aFolderName' name. KErrNone if successful. KErrAlreadyExists, if a folder with same name exists under aParentFoder

Parameters

CMsvSession & aSessionmessageserver session
TMsvId aParentFoldera folder, under which the new folder is created.
const TDesC & aFolderName
TMsvId & aFolderIdentry id of the new folder or if the folder already exists, the folder id of the existing folder

CreateNewServiceL(CMsvSession &)

IMPORT_C voidCreateNewServiceL(CMsvSession &aSession)

Creates a new service entry into messagestore and saves the entryid into CenRep. The invisible Notification folder and MMBox folder will also be created. Before creating new entries, MessageStore is first searched for old entries. If old entries are found, they will be used. Note that the method can be called only from client side of the Messaging architecture.

Parameters

CMsvSession & aSession

CreationMode()

TInt32 CreationMode()const [inline]

Get MMS creation mode MMS creation mode

DeleteAccessPointL(TInt)

IMPORT_C voidDeleteAccessPointL(TIntaIndex)

Deletes an accesspoint id from a specific index in the array

Parameters

TInt aIndexspecifies the array index

DeliveryReportSendingAllowed()

TInt32 DeliveryReportSendingAllowed()const [inline]

Get Delivery report sending allowed delivery report sending allowed code

DeliveryReportWanted()

TInt32 DeliveryReportWanted()const [inline]

Get delivery report wanted code. delivery report code

ExpiryInterval()

TInt32 ExpiryInterval()const [inline]

ExpiryInterval refers to messages expiration interval in the network. message expiration interval in seconds

ExpiryOvershoot()

TInt ExpiryOvershoot()const [inline]

Get the value (in seconds) that the expiry interval can be exceeded and message fetching will still be attempted. expiry overshoot value in seconds

FetchOverride()

TBool FetchOverride()const [inline]

FetchOverride specifies whether message should be retrieved regardless of what has been set to receiving mode value. This setting is not saved in Central Repository, but instead it is handled "on the fly". ETrue if messages are to be fetched even if receivingmode is off or deferred. Default value EFalse.

FolderEntryL(CMsvSession &, TMsvId, const TDesC &)

IMPORT_C TMsvIdFolderEntryL(CMsvSession &aSession,
TMsvIdaParentFolder,
const TDesC &aFolderName
)

Gets a folder entry id under a given folder id with 'aFolderName' name. entry id of the folder

Parameters

CMsvSession & aSessionmessageserver session
TMsvId aParentFoldera folder, under where the folder is searched
const TDesC & aFolderNamename of folder entry

ImageHeight()

TInt32 ImageHeight()const [inline]

Get image height. image height in pixels

ImageWidth()

TInt32 ImageWidth()const [inline]

Get image width. image width in pixels

LoadSettingsL()

IMPORT_C voidLoadSettingsL()

LoadSettingsL loads the settings from Central Repository

LocalMode()

TBool LocalMode()const [inline]

Get MMS local mode (Localmode is for test purposes only) MMS creation mode

LocalModeIn()

const TDesC &LocalModeIn()[inline]

LocalModeIn returns the directory path for incoming localmode messages

LocalModeOut()

const TDesC &LocalModeOut()[inline]

LocalModeOut returns the directory path for outgoing localmode messages

LogEmailRecipients()

TBool LogEmailRecipients()const [inline]

Get logging state of messages to Email recipients ETrue: if sent messages to email recipients are logged EFalse: if messages only to phone numbers are logged

MMBoxFolder()

TMsvId MMBoxFolder()const [inline]

Gets mmbox folder id TMsvId of the mmbox folder

MaximumReceiveSize()

TInt32 MaximumReceiveSize()const [inline]

Get maximum size of messages that can be received in bytes. maximum message size (0 = any size)

MaximumSendSize()

TInt32 MaximumSendSize()const [inline]

Get maximum size of messages that can be sent in bytes. maximum message size (0 = any size)

MessageClass()

TInt32 MessageClass()const [inline]

Get default message class. message class code

MessagePriority()

TInt32 MessagePriority()const [inline]

Get message priority. message priority code

MmsVersion()

TInt16 MmsVersion()const [inline]

Get the current MMS encapsulation versio 3.2

MMS encapsulation version as hex. Value in low byte, low half is minor version, high half is major version 0x10 = 1.0 0x11 = 1.1 0x12 = 1.2 etc.

MoveToSent()

TBool MoveToSent()const [inline]

MoveToSent returns a boolean specifying whether messages are moved to sent folder after they have been successfully sent. If not, the message will be deleted. This setting is common to all messaging types. ETrue, if messages are moved, EFalse, if they are deleted.

NewL()

IMPORT_C CMmsSettings *NewL()[static]

Two-phased constructor.

NotificationFolder()

TMsvId NotificationFolder()const [inline]

Gets notification folder id TMsvId of the notification folder

ReadReplyReportSendingAllowed()

TBool ReadReplyReportSendingAllowed()const [inline]

Get read report sending allowed value. Specifies if the terminal is allowed to send a read report when the message is opened the first time and the sender has requested a read report read reply report allowed value. Possible values: ETrue EFalse (default)

ReadReplyReportWanted()

TInt32 ReadReplyReportWanted()const [inline]

Get Read report wanted setting. Specifies if the user wants a report for each message when the recipient opens the message the first time read report wanted value. Possible values: KMmsYes KMmsNo (default)

ReceivingModeForeign()

TMmsReceivingModeReceivingModeForeign()const [inline]

ReceivingModeForeign enumerated value representing receiving mode in foreign network Possible values as in ReceivingModeHome

ReceivingModeHome()

TMmsReceivingModeReceivingModeHome()const [inline]

ReceivingModeHome enumerated value representing receiving mode in home network Possible values: EMmsReceivingAutomatic (default), EMmsReceivingManual, EMmsReceivingPostpone, EMmsReceivingReject

Reset()

IMPORT_C voidReset()

Reset clears the member variables representing Mms settings (the method does not modify data in CenRep).

RestoreFactorySettingsL(CMsvSession &, TMmsFactorySettingsLevel)

IMPORT_C voidRestoreFactorySettingsL(CMsvSession &aSession,
TMmsFactorySettingsLevelaLevel
)

Parameters

CMsvSession & aSession
TMmsFactorySettingsLevel aLevel

SaveAccesspointArrayL()

voidSaveAccesspointArrayL()[private]

Handles saving of AP array The method assumes that connection to CenRep has been already created.

SaveSetting(TUint32, TInt)

voidSaveSetting(TUint32aKey,
TIntaValue
)[private]

Handles saving of one integer value to CenRep. First, settings tried to be set normally, but if it turns out that such key does not exist, it will be created. The method assumes that connection to CenRep has been already created.

Parameters

TUint32 aKeyrefers to CenRep key
TInt aValuecontains the value to be saved

SaveSettingsL()

IMPORT_C voidSaveSettingsL()

SaveSettingsL saves the settings to Central Repository

SenderVisibility()

TInt32 SenderVisibility()const [inline]

SenderVisibility sender visibility code

Service()

TMsvId Service()const [inline]

Gets default service for MMS TMsvId of the default MMS service entry. If no service defined KMsvNullIndexEntryId is returned.

SetAcceptAdvertisementMessages(TBool)

voidSetAcceptAdvertisementMessages(TBoolaAdvertisementsAllowed = ETrue)[inline]

Set acceptance flag for advertisement messages.

Parameters

TBool aAdvertisementsAllowed = ETrue

SetAcceptAnonymousMessages(TBool)

voidSetAcceptAnonymousMessages(TBoolaAnonymousAllowed = ETrue)[inline]

Set acceptance flag for anonymous messages

Parameters

TBool aAnonymousAllowed = ETrue

SetAcceptInformationalMessages(TBool)

voidSetAcceptInformationalMessages(TBoolaInformationalAllowed = ETrue)[inline]

Set acceptance flag for informational messages

Parameters

TBool aInformationalAllowed = ETrue

SetAcceptPersonalMessages(TBool)

voidSetAcceptPersonalMessages(TBoolaPersonalAllowed = ETrue)[inline]

Set acceptance flag for personal messages.

Parameters

TBool aPersonalAllowed = ETrue

SetCreationMode(TMmsCreationMode)

voidSetCreationMode(TMmsCreationModeaCreationMode)[inline]

Set MMS Creation Mode

Parameters

TMmsCreationMode aCreationModePossible values: EMmsCreationModeRestricted, EMmsCreationModeWarning (default), EMmsCreationModeFree

SetDeliveryReportSendingAllowed(TInt32)

voidSetDeliveryReportSendingAllowed(TInt32aDeliveryReportSendingAllowed)[inline]

Set Delivery report sending allowed

Parameters

TInt32 aDeliveryReportSendingAllowed

SetDeliveryReportWanted(TInt32)

voidSetDeliveryReportWanted(TInt32aDeliveryReportWanted)[inline]

Set delivery report wanted

Parameters

TInt32 aDeliveryReportWanted

SetExpiryInterval(TInt32)

voidSetExpiryInterval(TInt32aExpiryInterval)[inline]

SetExpiryInterval

Parameters

TInt32 aExpiryIntervalmessage expiration interval in seconds Recommended values: 0 ( = maximum allowed by MMSC ) 1 * 3600( 1 hour ) 6 * 3600( 6 hours ) 24 * 3600( 24 hours ) 72 * 3600( 3 days = 72 hours ) 168 * 3600 ( 1 week = 168 hours ) Default value 0

SetFetchOverride(TBool)

voidSetFetchOverride(TBoolaOverride)[inline]

SetFetchOverride

Parameters

TBool aOverride

SetImageHeight(TInt32)

voidSetImageHeight(TInt32aImageHeight)[inline]

Set image height.

Parameters

TInt32 aImageHeightimage height in pixels

SetImageWidth(TInt32)

voidSetImageWidth(TInt32aImageWidth)[inline]

Set image width.

Parameters

TInt32 aImageWidthimage width in pixels

SetLocalMode(TBool)

voidSetLocalMode(TBoolaLocalMode)[inline]

Set MMS local mode (Localmode is for test purposes only)

Parameters

TBool aLocalModespecifying whether normal or local mode is in use.

SetLocalModeIn(const TDesC &)

voidSetLocalModeIn(const TDesC &aPath)[inline]

SetLocalModeIn sets the directory path for incoming localmode messages

Parameters

const TDesC & aPath

SetLocalModeOut(const TDesC &)

voidSetLocalModeOut(const TDesC &aPath)[inline]

SetLocalModeOut sets the directory path for incoming localmode messages

Parameters

const TDesC & aPath

SetLogEmailRecipients(TBool)

voidSetLogEmailRecipients(TBoolaEmailLogging)[inline]

Set logging state of messages to Email recipients

Parameters

TBool aEmailLogging

SetMessageClass(TMmsMessageClass)

voidSetMessageClass(TMmsMessageClassaMessageClass)[inline]

Set default message class.

Parameters

TMmsMessageClass aMessageClassmessage class code Possible values: EMmsClassPersonal (default), EMmsClassAdvertisement, EMmsClassInformational

SetMessagePriority(TMmsMessagePriority)

voidSetMessagePriority(TMmsMessagePriorityaMessagePriority)[inline]

Set message priority

Parameters

TMmsMessagePriority aMessagePriority

SetReadReplyReportSendingAllowed(TBool)

voidSetReadReplyReportSendingAllowed(TBoolaReadReplyReportSendingAllowed)[inline]

Set read report sending allowed code. Specifies if the terminal is allowed to send a read report when the message is opened the first time and the sender has requested a read report

Parameters

TBool aReadReplyReportSendingAllowedread report sending allowed value (ETrue or EFalse).

SetReadReplyReportWanted(TInt32)

voidSetReadReplyReportWanted(TInt32aReadReplyReportWanted)[inline]

Set Read report wanted setting. Specifies if the user wants a report for each message when the recipient opens the message the first time

Parameters

TInt32 aReadReplyReportWantedread report wanted code Possible values: KMmsYes, KMmsNo

SetReceivingModeForeign(TMmsReceivingMode)

voidSetReceivingModeForeign(TMmsReceivingModeaMode)[inline]

SetReceivingModeForeign sets the receiving mode in foreign network

Parameters

TMmsReceivingMode aModePossible values as in ReceivingModeHome

SetReceivingModeHome(TMmsReceivingMode)

voidSetReceivingModeHome(TMmsReceivingModeaMode)[inline]

SetReceivingModeHome sets the receiving mode in home network

Parameters

TMmsReceivingMode aModePossible values as in ReceivingModeHome

SetSenderVisibility(TMmsMessageSenderVisibility)

voidSetSenderVisibility(TMmsMessageSenderVisibilityaSenderVisibility)[inline]

Set sender visibility code

Parameters

TMmsMessageSenderVisibility aSenderVisibility

SettingsVersion()

TInt32 SettingsVersion()const [inline]

SettingsVersion returns the version information of the settings.

ShowSentTime()

TBool ShowSentTime()const [inline]

ShowSentTime returns the value that tells if sending time or receiving time should be shown for incoming messages This value is stored in iDate member in TMsvEntry ETrue = show sending time EFalse = show time the message arrived at the terminal (default)

ValidateSettings()

IMPORT_C TIntValidateSettings()

Validate current MMS settings Checks that access points point to valid entries in commsdb error code

Member Data Documentation

TBool iAcceptAdvertisement

TBool iAcceptAdvertisement[private]

TBool iAcceptAnonymous

TBool iAcceptAnonymous[private]

TBool iAcceptInformational

TBool iAcceptInformational[private]

TBool iAcceptPersonal

TBool iAcceptPersonal[private]

RArray< TUint32 > iAccesspointArray

RArray< TUint32 >iAccesspointArray[private]

TMsvId iApplicationFolderId

TMsvId iApplicationFolderId[private]

TInt32 iCreationMode

TInt32 iCreationMode[private]

TMsvId iDefaultServiceId

TMsvId iDefaultServiceId[private]

TInt32 iDeliveryReportAllowed

TInt32 iDeliveryReportAllowed[private]

TInt32 iDeliveryReportWanted

TInt32 iDeliveryReportWanted[private]

TInt32 iExpiryInterval

TInt32 iExpiryInterval[private]

TInt iExpiryOvershoot

TInt iExpiryOvershoot[private]

TBool iFetchOverride

TBool iFetchOverride[private]

TInt32 iImageHeight

TInt32 iImageHeight[private]

TInt32 iImageWidth

TInt32 iImageWidth[private]

TBool iLocalMode

TBool iLocalMode[private]

HBufC * iLocalModeDir

HBufC *iLocalModeDir[private]

TBool iLogEmailRecipients

TBool iLogEmailRecipients[private]

TMsvId iMMBoxFolderId

TMsvId iMMBoxFolderId[private]

TInt32 iMaxReceiveSize

TInt32 iMaxReceiveSize[private]

TInt32 iMaxSendSize

TInt32 iMaxSendSize[private]

TInt32 iMessageClass

TInt32 iMessageClass[private]

TInt32 iMessagePriority

TInt32 iMessagePriority[private]

CRepository * iMmsRepository

CRepository *iMmsRepository[private]

TInt16 iMmsVersion

TInt16 iMmsVersion[private]

TBool iMoveToSent

TBool iMoveToSent[private]

TMsvId iNotificationFolderId

TMsvId iNotificationFolderId[private]

TBool iReadReplyReportAllowed

TBool iReadReplyReportAllowed[private]

TInt32 iReadReplyReportWanted

TInt32 iReadReplyReportWanted[private]

TInt32 iReceivingModeForeign

TInt32 iReceivingModeForeign[private]

TInt32 iReceivingModeHome

TInt32 iReceivingModeHome[private]

TInt32 iSenderVisibility

TInt32 iSenderVisibility[private]

TInt32 iSettingsVersion

TInt32 iSettingsVersion[private]

TBool iShowSentTime

TBool iShowSentTime[private]