Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: popsmtm.h
Link against: pops.lib

Class CImppServerMtm

CImppServerMtm

Support

Supported from 5.0

Description

Implements generic POP3 MTM operations.

Not all generic operations are meaningful in the context of the POP3 mail protocol and, therefore, a number of the generic operations return KErrNotSupported when called.

Derivation

CActiveThe core class of the active object abstraction
CBaseBase class for all classes to be instantiated on the heap
CBaseServerMtm(No abstract)
CImppServerMtmImplements generic POP3 MTM operations

Defined in CImppServerMtm:
ChangeL(), CopyFromLocalL(), CopyToLocalL(), CopyWithinServiceL(), CreateL(), DeleteAllL(), MoveFromLocalL(), MoveToLocalL(), MoveWithinServiceL()

Inherited from CActive:
Cancel(), Deque(), DoCancel(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), RunError(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
operator new()

Inherited from CBaseServerMtm:
CommandExpected(), DoComplete(), DoRunL(), Progress(), RunL(), SetInitialEntry(), StartCommandL(), iServerEntry


Create, change, delete


CreateL()

virtual void CreateL(TMsvEntry aNewEntry, TRequestStatus& aStatus);

Description

Not supported, leaves with KErrNotSuported.


ChangeL()

virtual void ChangeL(TMsvEntry aNewEntry, TRequestStatus& aStatus);

Description

Not supported, leaves with KErrNotSuported.


DeleteAllL()

virtual void DeleteAllL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);

Description

Deletes all identified messages from the remote server.

This command can be stored as an offlline operation if the MTM is running in disconnected mode.

When running in disconnected mode any delete commands are issued during the disconnecting stage, this allows unwanted delete operations to be cancelled if required.

Parameters

const CMsvEntrySelection& aSelection

The collection of entries that are to be deleted.

TRequestStatus& aStatus

Asynchronous completion object.

[Top]


Copy and move from remote


CopyToLocalL()

virtual void CopyToLocalL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Downloads a copy of each of the messages in the selection and stores them in the specified local folder.

If a message is already populated under the remote service entry then it is not downloaded again; it is simply copied to the new destination.

Parameters

const CMsvEntrySelection& aSelection

The collection of message index entries for which the copy/moving is required.

TMsvId aDestination

The entry ID identifying the local folder

TRequestStatus& aStatus

Asynchronous completion word for the operation


MoveToLocalL()

virtual void MoveToLocalL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Moves each of the messages in the selection from the remote mail server into the specified local folder.

If a message is already populated under the remote service entry, then it is not downloaded again; it is simply moved to the new destination and then deleted from the remote host.

Parameters

const CMsvEntrySelection& aSelection

The collection of message index entries for which the moving is required.

TMsvId aDestination

The entry ID identifying the local folder

TRequestStatus& aStatus

Asynchronous completion word for the operation

[Top]


Copy and move to remote


CopyFromLocalL()

virtual void CopyFromLocalL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Not supported, leaves with KErrNotSuported.


MoveFromLocalL()

virtual void MoveFromLocalL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Not supported, leaves with KErrNotSuported.

[Top]


Copy and move within remote


CopyWithinServiceL()

virtual void CopyWithinServiceL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Populates the specified messages.

The MTM must be running in disconnected mode.

Parameters

const CMsvEntrySelection& aSelection

The collection of message index entries for which the copy is required

TMsvId aDestination

The service Id

TRequestStatus& aStatus

Asynchronous completion word for the operation


MoveWithinServiceL()

virtual void MoveWithinServiceL(const CMsvEntrySelection& aSelection, TMsvId aDestination, TRequestStatus& aStatus);

Description

Not supported, leaves with KErrNotSuported.