CImImap4GetMail Class Reference

class CImImap4GetMail : public CMsvOperation

Encapsulates an operation to copy, move, and populate (i.e. download the full message body) IMAP4 emails from the remote inbox to any local folder.

Note that the same operations are available by calling CImap4ClientMtm::InvokeAsyncFunctionL() with a suitable command.

Inherits from

Public Member Functions
~CImImap4GetMail ()
void DoCancel ()
const TDesC8 & FinalProgress ()
IMPORT_C CMsvOperation * GetMailL ( TInt , CImap4ClientMtm &, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)
const TDesC8 & ProgressL ()
void RunL ()
Private Member Functions
CImImap4GetMail ( CMsvSession &, CImap4ClientMtm &, TRequestStatus &)
void ChangeStateL ()
void Complete ()
void ConnectToMailboxL ()
void ConstructL ( TInt , const CMsvEntrySelection &, TDes8 &)
void CopyMoveAllMessagesL ( TBool )
void CopyMoveMessageSelectionL ( TBool )
void CopyMoveNewMessagesL ( TBool )
void DisconnectFromMailboxL ()
void PopulateAllMessagesL ()
void PopulateMessageSelectionL ()
void PopulateNewMessagesL ()
void RequestComplete ( TInt )
void ResetProgress ()
void SelectAndChangeToNextStateL ()
void SelectNextStateL ()
void StoreProgressL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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()
CMsvOperation::CMsvOperation(CMsvSession &,TInt,TRequestStatus &)
CMsvOperation::Extension_(TUint,TAny *&,TAny *)
CMsvOperation::Id()const
CMsvOperation::Mtm()const
CMsvOperation::Service()const
CMsvOperation::SystemProgress(TMsvSystemProgress &)
CMsvOperation::~CMsvOperation()
Private Member Enumerations
enum TImImap4GetMailState {
EConnectToMailbox , ECopyNewMessages , EMoveNewMessages , EPopulateNewMessages , ECopyMessageSelection , EMoveMessageSelection , EPopulateMessageSelection , ECopyAllMessages , EMoveAllMessages , EPopulateAllMessages , EDisconnectFromMailbox , EFinished
}
Inherited Enumerations
CActive:TPriority
Private Attributes
TInt iCommand
TImap4GenericProgress iErrorProgress
CImap4ClientMtm & iImap4ClientMtm
TPckgBuf < TImImap4GetPartialMailInfo > iImap4GetPartialMailInfo
CMsvEntrySelection * iMsvEntrySelection
CMsvOperation * iMsvOperation
TImap4GenericProgress iProgress
TPckgBuf < TImap4GenericProgress > iProgressBuf
TImImap4GetMailState iState
Inherited Attributes
CActive::iStatus
CMsvOperation::iMsvSession
CMsvOperation::iMtm
CMsvOperation::iObserverRequestStatus
CMsvOperation::iService

Constructor & Destructor Documentation

CImImap4GetMail(CMsvSession &, CImap4ClientMtm &, TRequestStatus &)

CImImap4GetMail ( CMsvSession & aMsvSession,
CImap4ClientMtm & aImap4ClientMtm,
TRequestStatus & aObserverRequestStatus
) [private]

Parameters

CMsvSession & aMsvSession
CImap4ClientMtm & aImap4ClientMtm
TRequestStatus & aObserverRequestStatus

~CImImap4GetMail()

~CImImap4GetMail ( )

Destructor.

Member Functions Documentation

ChangeStateL()

void ChangeStateL ( ) [private]

Complete()

void Complete ( ) [private]

ConnectToMailboxL()

void ConnectToMailboxL ( ) [private]

ConstructL(TInt, const CMsvEntrySelection &, TDes8 &)

void ConstructL ( TInt aFunctionId,
const CMsvEntrySelection & aMsvEntrySelection,
TDes8 & aImap4GetMailInfo
) [private]

Parameters

TInt aFunctionId
const CMsvEntrySelection & aMsvEntrySelection
TDes8 & aImap4GetMailInfo

CopyMoveAllMessagesL(TBool)

void CopyMoveAllMessagesL ( TBool aCopy ) [private]

Parameters

TBool aCopy

CopyMoveMessageSelectionL(TBool)

void CopyMoveMessageSelectionL ( TBool aCopy ) [private]

Parameters

TBool aCopy

CopyMoveNewMessagesL(TBool)

void CopyMoveNewMessagesL ( TBool aCopy ) [private]

Parameters

TBool aCopy

DisconnectFromMailboxL()

void DisconnectFromMailboxL ( ) [private]

DoCancel()

void DoCancel ( ) [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

FinalProgress()

const TDesC8 & FinalProgress ( ) [virtual]

Gets information about a completed operation.

panic
IMCM 30 Operation has not completed
TImap4GenericProgress

GetMailL(TInt, CImap4ClientMtm &, const CMsvEntrySelection &, TDes8 &, TRequestStatus &)

IMPORT_C CMsvOperation * GetMailL ( TInt aFunctionId,
CImap4ClientMtm & aImap4ClientMtm,
const CMsvEntrySelection & aMsvEntrySelection,
TDes8 & aImap4GetMailInfo,
TRequestStatus & aObserverRequestStatus
)

Creates and begins a new IMAP4 get mail operation.

Note that the function should be, though is not, marked as static. The workaround is to call the function using a NULL CImImap4GetMail pointer:
         CImImap4GetMail* gm = NULL;
CMsvOperation* gmOp = gm->GetMailL(id, mtm, sel, info, status);
        

Alternatively, instead of using this class, call CImap4ClientMtm::InvokeAsyncFunctionL() directly. Any functionality accessible through this class can also be accessed through that function.

Copy commands:

  • KIMAP4MTMConnectAndCopyNewMailAndStayOnline

  • KIMAP4MTMConnectAndCopyNewMailAndDisconnect

  • KIMAP4MTMConnectAndCopyAllMailAndStayOnline

  • KIMAP4MTMConnectAndCopyAllMailAndDisconnect

  • KIMAP4MTMConnectAndCopyMailSelectionAndStayOnline

  • KIMAP4MTMConnectAndCopyMailSelectionAndDisconnect

Move commands:

  • KIMAP4MTMConnectAndMoveNewMailAndStayOnline

  • KIMAP4MTMConnectAndMoveNewMailAndDisconnect

  • KIMAP4MTMConnectAndMoveAllMailAndStayOnline

  • KIMAP4MTMConnectAndMoveAllMailAndDisconnect

  • KIMAP4MTMConnectAndMoveMailSelectionAndStayOnline

  • KIMAP4MTMConnectAndMoveMailSelectionAndDisconnect

Populate commands:

  • KIMAP4MTMConnectAndPopulateNewMailAndStayOnline

  • KIMAP4MTMConnectAndPopulateNewMailAndDisconnect

  • KIMAP4MTMConnectAndPopulateAllMailAndStayOnline

  • KIMAP4MTMConnectAndPopulateAllMailAndDisconnect

  • KIMAP4MTMConnectAndPopulateMailSelectionAndStayOnline

  • KIMAP4MTMConnectAndPopulateMailSelectionAndDisconnect

TImap4Cmds TImImap4GetMailInfo TImImap4GetPartialMailInfo

Parameters

TInt aFunctionId Type of operation to perform, a TImap4Cmds value. Permitted commands are:
CImap4ClientMtm & aImap4ClientMtm A reference to the IMAP4 Client MTM that wants to perform the Get Mail operation.
const CMsvEntrySelection & aMsvEntrySelection A selection of messages that need to be copied/moved to a local folder. The first entry in this selection MUST be the service. Other IDs can be appended to the selection depending on which operation is to be performed. For the 'copy new', 'copy all', 'move new', 'move all', 'populate new', 'populate all' situations, the folder from which the messages are to be copied, moved or populated should be appended after the service ID. For all the other situations (i.e. copying, moving or populating a selection of messages), the selection of messages should be appended after the service ID. Please note that the selection of messages MUST have the same parent i.e. MUST be in the same folder.
TDes8 & aImap4GetMailInfo A packaged TImImap4GetMailInfo object storing the maximum message size, the destination folder ID, and what message parts are required. For populate commands, this can be a packaged TImImap4GetPartialMailInfo object, specifying separate size limits for body text and attachments.
TRequestStatus & aObserverRequestStatus The status to be completed when the get mail operation has completed.

PopulateAllMessagesL()

void PopulateAllMessagesL ( ) [private]

PopulateMessageSelectionL()

void PopulateMessageSelectionL ( ) [private]

PopulateNewMessagesL()

void PopulateNewMessagesL ( ) [private]

ProgressL()

const TDesC8 & ProgressL ( ) [virtual]

Gets information on the progress of the operation.

TImap4GenericProgress

RequestComplete(TInt)

void RequestComplete ( TInt aError ) [private]

Parameters

TInt aError

ResetProgress()

void ResetProgress ( ) [private]

RunL()

void RunL ( ) [virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

SelectAndChangeToNextStateL()

void SelectAndChangeToNextStateL ( ) [private]

SelectNextStateL()

void SelectNextStateL ( ) [private]

StoreProgressL()

void StoreProgressL ( ) [private]

Member Enumerations Documentation

Enum TImImap4GetMailState

Enumerators

EConnectToMailbox
ECopyNewMessages
EMoveNewMessages
EPopulateNewMessages
ECopyMessageSelection
EMoveMessageSelection
EPopulateMessageSelection
ECopyAllMessages
EMoveAllMessages
EPopulateAllMessages
EDisconnectFromMailbox
EFinished

Member Data Documentation

TInt iCommand

TInt iCommand [private]

TImap4GenericProgress iErrorProgress

TImap4GenericProgress iErrorProgress [private]

CImap4ClientMtm & iImap4ClientMtm

CImap4ClientMtm & iImap4ClientMtm [private]

TPckgBuf< TImImap4GetPartialMailInfo > iImap4GetPartialMailInfo

TPckgBuf < TImImap4GetPartialMailInfo > iImap4GetPartialMailInfo [private]

CMsvEntrySelection * iMsvEntrySelection

CMsvEntrySelection * iMsvEntrySelection [private]

CMsvOperation * iMsvOperation

CMsvOperation * iMsvOperation [private]

TImap4GenericProgress iProgress

TImap4GenericProgress iProgress [private]

TPckgBuf< TImap4GenericProgress > iProgressBuf

TPckgBuf < TImap4GenericProgress > iProgressBuf [private]

TImImap4GetMailState iState

TImImap4GetMailState iState [private]