CImPruneMessage Class Reference

class CImPruneMessage : public CMsgActive

Deletes the body text and attachment data from an individually specified message.

Example uses of this class are:

1. to cleanup after a populating operation has failed

2. to remove body text and attachment data from remote messages, while preserving the message structure

Inherits from

Constructor & Destructor Documentation

CImPruneMessage(CMsvEntry &, RFs &)

CImPruneMessage(CMsvEntry &aEntry,
RFs &aFs
)[private]

Parameters

CMsvEntry & aEntry
RFs & aFs

~CImPruneMessage()

~CImPruneMessage()

Destructor.

Member Functions Documentation

ConstructL()

voidConstructL()[private]

DoCancel()

voidDoCancel()[private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

CActive::Cancel

DoComplete(TInt &)

voidDoComplete(TInt &)[private, virtual]

Parameters

TInt &

DoRunL()

voidDoRunL()[private, virtual]

NewL(CMsvEntry &, RFs &)

IMPORT_C CImPruneMessage *NewL(CMsvEntry &aEntry,
RFs &aFs
)[static]

Allocates and constructs a new CImPruneMessage object.

Parameters

CMsvEntry & aEntryCMsvEntry for use by the object in performing the delete operations. It does not need to be set to any particular message context. The caller retains ownership.
RFs & aFsOpen file server session handle

NewLC(CMsvEntry &, RFs &)

IMPORT_C CImPruneMessage *NewLC(CMsvEntry &aEntry,
RFs &aFs
)[static]

Allocates and constructs a new CImPruneMessage object, leaving the object on the cleanup stack.

Parameters

CMsvEntry & aEntryCMsvEntry for use by the object in performing the delete operations. It does not need to be set to any particular message context. The caller retains ownership.
RFs & aFsOpen file server session handle

PruneEntryL()

voidPruneEntryL()[private]

ResetStoreL()

voidResetStoreL()[private]

StartL(TMsvId, TRequestStatus &)

IMPORT_C voidStartL(TMsvIdaMessageEntry,
TRequestStatus &aStatus
)

Starts the asynchronous message clean operation.

Parameters

TMsvId aMessageEntryThe ID of the entry from which to delete the body text and attachment data
TRequestStatus & aStatusAsynchronous status word that completes with KErrNone when the body text and all of the attachments have been deleted.

Member Enumerations Documentation

Enum TImPruningState

Enumerators

EImPruneUpdatingEntry
EImPruneUpdatingFirstEntry
EImPruneFindingEntry
EImPruneFindFirstEntry
EImPruneFindNextEntry

Member Data Documentation

CMsvOperation * iChangeOperation

CMsvOperation *iChangeOperation[private]

CMsvEntry & iCurrentEntry

CMsvEntry &iCurrentEntry[private]

CImEntryFinder * iEntryFinder

CImEntryFinder *iEntryFinder[private]

CFileMan * iFileManager

CFileMan *iFileManager[private]

RFs & iFs

RFs &iFs[private]

TMsvId iRootEntryId

TMsvId iRootEntryId[private]

TImPruningState iState

TImPruningState iState[private]

CMsvStore * iStore

CMsvStore *iStore[private]