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.
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 () |
Private Member Enumerations | |
---|---|
enum |
TImImap4GetMailState
{
EConnectToMailbox , ECopyNewMessages , EMoveNewMessages , EPopulateNewMessages , ECopyMessageSelection , EMoveMessageSelection , EPopulateMessageSelection , ECopyAllMessages , EMoveAllMessages , EPopulateAllMessages , EDisconnectFromMailbox , EFinished } |
Inherited Enumerations | |
---|---|
CActive:TPriority |
Inherited Attributes | |
---|---|
CActive::iStatus | |
CMsvOperation::iMsvSession | |
CMsvOperation::iMtm | |
CMsvOperation::iObserverRequestStatus | |
CMsvOperation::iService |
CImImap4GetMail | ( | CMsvSession & | aMsvSession, |
CImap4ClientMtm & | aImap4ClientMtm, | ||
TRequestStatus & | aObserverRequestStatus | ||
) | [private] |
CMsvSession & aMsvSession | |
CImap4ClientMtm & aImap4ClientMtm | |
TRequestStatus & aObserverRequestStatus |
void | ConstructL | ( | TInt | aFunctionId, |
const CMsvEntrySelection & | aMsvEntrySelection, | |||
TDes8 & | aImap4GetMailInfo | |||
) | [private] |
TInt aFunctionId | |
const CMsvEntrySelection & aMsvEntrySelection | |
TDes8 & aImap4GetMailInfo |
void | CopyMoveAllMessagesL | ( | TBool | aCopy | ) | [private] |
TBool aCopy |
void | CopyMoveMessageSelectionL | ( | TBool | aCopy | ) | [private] |
TBool aCopy |
void | CopyMoveNewMessagesL | ( | TBool | aCopy | ) | [private] |
TBool aCopy |
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() .
const TDesC8 & | FinalProgress | ( | ) | [virtual] |
Gets information about a completed operation.
IMPORT_C CMsvOperation * | GetMailL | ( | TInt | aFunctionId, |
CImap4ClientMtm & | aImap4ClientMtm, | |||
const CMsvEntrySelection & | aMsvEntrySelection, | |||
TDes8 & | aImap4GetMailInfo, | |||
TRequestStatus & | aObserverRequestStatus | |||
) |
Creates and begins a new IMAP4 get mail operation.
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
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. |
const TDesC8 & | ProgressL | ( | ) | [virtual] |
Gets information on the progress of the operation.
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
EConnectToMailbox | |
ECopyNewMessages | |
EMoveNewMessages | |
EPopulateNewMessages | |
ECopyMessageSelection | |
EMoveMessageSelection | |
EPopulateMessageSelection | |
ECopyAllMessages | |
EMoveAllMessages | |
EPopulateAllMessages | |
EDisconnectFromMailbox | |
EFinished |
TPckgBuf < TImImap4GetPartialMailInfo > | iImap4GetPartialMailInfo | [private] |
TPckgBuf < TImap4GenericProgress > | iProgressBuf | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.