Location:
popcmtm.h
Link against:
CImPop3GetMail
Support
Supported from 5.0
Description
Provides the means to copy and move email from the remote inbox to
any local folder. Functionality is provided to:
-
copy or move any new email in the remote inbox to any local
folder
-
copy or move a selection of email in the remote inbox to any
local folder
-
copy or move all email in the remote inbox to any local
folder.
When copying or moving email from the remote inbox to a local
folder, there are three possibilities to handle:
-
the user is connected to the account so email is just copied or
moved.
-
the user is not connected to the account so the user is first
connected, email moved or copied and then the user disconnected.
-
the user is not connected to the account so the user is first
connected, email moved or copied and then the user left online.
Derivation
CActive | The core class of the active object abstraction |
CBase | Base class for all classes to be instantiated on the heap |
CImPop3GetMail | Provides the means to copy and move email from the remote inbox to any local folder |
CMsvOperation | Defines an interface for use by objects which control asynchronous commands in the messaging system |
|
Defined in CImPop3GetMail:
EConnectAndCopyAllMailAndDisconnect, EConnectAndCopyAllMailAndStayOnline, EConnectAndCopyMailSelectionAndDisconnect, EConnectAndCopyMailSelectionAndStayOnline, EConnectAndCopyNewMailAndDisconnect, EConnectAndCopyNewMailAndStayOnline, EConnectAndMoveAllMailAndDisconnect, EConnectAndMoveAllMailAndStayOnline, EConnectAndMoveMailSelectionAndDisconnect, EConnectAndMoveMailSelectionAndStayOnline, EConnectAndMoveNewMailAndDisconnect, EConnectAndMoveNewMailAndStayOnline, GetMailL(), TImPOP3GetMailType
Inherited from CActive:
Cancel(),
Deque(),
DoCancel(),
EPriorityHigh,
EPriorityIdle,
EPriorityLow,
EPriorityStandard,
EPriorityUserInput,
IsActive(),
IsAdded(),
Priority(),
RunError(),
RunL(),
SetActive(),
SetPriority(),
TPriority,
iStatus
Inherited from CBase:
operator new()
Inherited from CMsvOperation:
FinalProgress(),
Id(),
Mtm(),
ProgressL(),
Service(),
iMsvSession,
iMtm,
iObserverRequestStatus,
iService
CMsvOperation* GetMailL(CPop3ClientMtm& aPop3ClientMtm, TRequestStatus& aObserverRequestStatus, const CMsvEntrySelection& aMsvEntrySelection, TDes8& aPop3GetMailInfo, TImPOP3GetMailType aPOP3GetMailType);
Description
Get mail
Parameters
CPop3ClientMtm& aPop3ClientMtm |
A reference to the POP3 Client MTM that wants to perform the Get
Mail operation. |
TRequestStatus& aObserverRequestStatus |
The status that is completed when the get mail operation has
completed |
const CMsvEntrySelection& aMsvEntrySelection |
The selection of messages that need to be copied or moved to a
local folder. The first entry in this selection MUST be the service. |
TDes8& aPop3GetMailInfo |
Stores the maximum message size and the destination folder id.
|
TImPOP3GetMailType aPOP3GetMailType |
The type of get mail operation to be performed. |
|
Return value
CMsvOperation* |
If successful, this is an asynchronously completing operation.
If failed, this is a completed operation, with status set to the relevant error
code. |
|
TImPOP3GetMailType
Description
Type of getmail operation
EConnectAndCopyNewMailAndStayOnline |
Connect to mail server, copy new mail and then stay
online.
|
EConnectAndCopyNewMailAndDisconnect |
Connect to mail server, copy new mail and then disconnect.
|
EConnectAndMoveNewMailAndStayOnline |
Connect to mail server, move any new mail and then stay online.
|
EConnectAndMoveNewMailAndDisconnect |
Connect to mail server, move any new mail and then disconnect.
|
EConnectAndCopyMailSelectionAndStayOnline |
Connect to mail server, copy selected mail and then stay
online.
|
EConnectAndCopyMailSelectionAndDisconnect |
Connect to mail server, copy selected mail and then disconnect.
|
EConnectAndMoveMailSelectionAndStayOnline |
Connect to mail server, move selected mail and then stay online.
|
EConnectAndMoveMailSelectionAndDisconnect |
Connect to mail server, move selected mail and then disconnect.
|
EConnectAndCopyAllMailAndStayOnline |
Connect to mail server, copy all mail and then stay online.
|
EConnectAndCopyAllMailAndDisconnect |
Connect to mail server, copy all mail and then disconnect.
|
EConnectAndMoveAllMailAndStayOnline |
Connect to mail server, move all mail and then stay online.
|
EConnectAndMoveAllMailAndDisconnect |
Connect to mail server, move all mail and then disconnect.
|
|
![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
![[Top]](../../../stock/arrow_up.gif){kind=icon}