Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/_internet_email_engine_8cpp_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/ForumNokia/InternetEmail/src/InternetEmailEngine.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/ForumNokia/InternetEmail/src/InternetEmailEngine.cpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright © 2008 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> */</span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005
<a name="l00006"></a>00006 <span class="preprocessor">#include "InternetEmailEngine.h"</span>
<a name="l00007"></a>00007
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">// ================= MEMBER FUNCTIONS =======================</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011
<a name="l00012"></a>00012 <span class="comment">// -------------------------------------------------</span>
<a name="l00013"></a>00013 <span class="comment">// CInternetEmailEngine* CInternetEmailEngine::NewL(</span>
<a name="l00014"></a>00014 <span class="comment">// MInternetEmailEngineObserver& aObserver )</span>
<a name="l00015"></a>00015 <span class="comment">// static creation</span>
<a name="l00016"></a>00016 <span class="comment">// --------------------------------------------------</span>
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <a class="code" href="class_c_internet_email_engine.html">CInternetEmailEngine</a>* CInternetEmailEngine::NewL( <a class="code" href="class_m_internet_email_engine_observer.html">MInternetEmailEngineObserver</a>& aObserver )
<a name="l00019"></a>00019 {
<a name="l00020"></a>00020 <a class="code" href="class_c_internet_email_engine.html">CInternetEmailEngine</a>* engine=<span class="keyword">new</span>(ELeave) <a class="code" href="class_c_internet_email_engine.html">CInternetEmailEngine</a>( aObserver );
<a name="l00021"></a>00021 CleanupStack::PushL(engine);
<a name="l00022"></a>00022 engine->ConstructL();
<a name="l00023"></a>00023 CleanupStack::Pop(engine);
<a name="l00024"></a>00024 <span class="keywordflow">return</span> engine;
<a name="l00025"></a>00025 }
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00028"></a>00028 <span class="comment">// CInternetEmailEngine::CInternetEmailEngine(</span>
<a name="l00029"></a>00029 <span class="comment">// MInternetEmailEngineObserver& aObserver )</span>
<a name="l00030"></a>00030 <span class="comment">// : CActive(CActive::EPriorityStandard), iObserver( aObserver )</span>
<a name="l00031"></a>00031 <span class="comment">// actual constructor. Creates ao with standard prioritory</span>
<a name="l00032"></a>00032 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00033"></a>00033 <span class="comment">//</span>
<a name="l00034"></a>00034 CInternetEmailEngine::CInternetEmailEngine( <a class="code" href="class_m_internet_email_engine_observer.html">MInternetEmailEngineObserver</a>& aObserver )
<a name="l00035"></a>00035 : CActive(CActive::EPriorityStandard), iObserver( aObserver )
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="comment">// add this object to the active scheduler</span>
<a name="l00038"></a>00038 CActiveScheduler::Add(<span class="keyword">this</span>);
<a name="l00039"></a>00039 }
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">// ---------------------------------------------</span>
<a name="l00042"></a>00042 <span class="comment">// CInternetEmailEngine::~CInternetEmailEngine()</span>
<a name="l00043"></a>00043 <span class="comment">// Frees reserved resources</span>
<a name="l00044"></a>00044 <span class="comment">// ---------------------------------------------</span>
<a name="l00045"></a>00045 <span class="comment">//</span>
<a name="l00046"></a>00046 CInternetEmailEngine::~CInternetEmailEngine()
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keywordflow">if</span>( IsActive() )
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 Cancel();
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052 <span class="keywordflow">if</span>(iMsvOp)
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 iMsvOp->Cancel();
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056 <span class="keyword">delete</span> iMsvOp;
<a name="l00057"></a>00057 iMsvOp = NULL;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">delete</span> iEntry;
<a name="l00060"></a>00060 iEntry = NULL;
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">delete</span> iMtm;
<a name="l00063"></a>00063 iMtm = NULL;
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">delete</span> iRemoteEntries;
<a name="l00066"></a>00066 iRemoteEntries = NULL;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">delete</span> iUiReg;
<a name="l00069"></a>00069 iUiReg = NULL;
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="keyword">delete</span> iClientReg;
<a name="l00072"></a>00072 iClientReg = NULL;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keyword">delete</span> iMsvSession; <span class="comment">//Session must be deleted last</span>
<a name="l00075"></a>00075 iMsvSession = NULL;
<a name="l00076"></a>00076 }
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">// ----------------------------------</span>
<a name="l00079"></a>00079 <span class="comment">// CInternetEmailEngine::ConstructL()</span>
<a name="l00080"></a>00080 <span class="comment">// EPOC two phased constructor</span>
<a name="l00081"></a>00081 <span class="comment">// ----------------------------------</span>
<a name="l00082"></a>00082 <span class="comment">//</span>
<a name="l00083"></a>00083 <span class="keywordtype">void</span> CInternetEmailEngine::ConstructL()
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="comment">// create and open a session towards messaging</span>
<a name="l00086"></a>00086 <span class="comment">// the open operation is asynchronous and HandleSessionEventL</span>
<a name="l00087"></a>00087 <span class="comment">// will be called when the open is complete</span>
<a name="l00088"></a>00088 iMsvSession=CMsvSession::OpenAsyncL(*<span class="keyword">this</span>);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">// Default protocol values</span>
<a name="l00091"></a>00091 iProtocolType=EProtocolNULL;
<a name="l00092"></a>00092 iProtocolUid=KUidMsgTypeSMTP;
<a name="l00093"></a>00093 iIsProtocolSet=EFalse;
<a name="l00094"></a>00094 iHasImapInbox=EFalse;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">//for message handling</span>
<a name="l00097"></a>00097 iServiceId=KMsvRootIndexEntryId;
<a name="l00098"></a>00098 iId=KMsvRootIndexEntryId;
<a name="l00099"></a>00099 iRemoteEntries = <span class="keyword">new</span>(ELeave) CMsvEntrySelection();
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="comment">// other member initalization</span>
<a name="l00102"></a>00102 iState=EInitialising;
<a name="l00103"></a>00103 }
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment">// ------------------------------------------</span>
<a name="l00106"></a>00106 <span class="comment">// CInternetEmailEngine::CompleteConstructL()</span>
<a name="l00107"></a>00107 <span class="comment">// Called when MsvServer session is ready</span>
<a name="l00108"></a>00108 <span class="comment">// ------------------------------------------</span>
<a name="l00109"></a>00109 <span class="comment">//</span>
<a name="l00110"></a>00110 <span class="keywordtype">void</span> CInternetEmailEngine::CompleteConstructL()
<a name="l00111"></a>00111 {
<a name="l00112"></a>00112 iClientReg = CClientMtmRegistry::NewL( *iMsvSession );
<a name="l00113"></a>00113 iUiReg = CMtmUiRegistry::NewL( *iMsvSession );
<a name="l00114"></a>00114 }
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="comment">// --------------------------------------------------------</span>
<a name="l00117"></a>00117 <span class="comment">// void CInternetEmailEngine::RunL()</span>
<a name="l00118"></a>00118 <span class="comment">// The main statemachine</span>
<a name="l00119"></a>00119 <span class="comment">//</span>
<a name="l00120"></a>00120 <span class="comment">// Cornerstone i of this module.</span>
<a name="l00121"></a>00121 <span class="comment">// --------------------------------------------------------</span>
<a name="l00122"></a>00122 <span class="comment">//</span>
<a name="l00123"></a>00123 <span class="keywordtype">void</span> CInternetEmailEngine::RunL()
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125
<a name="l00126"></a>00126 TBuf8<1> null;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keywordflow">switch</span>( iState ) <span class="comment">// separation between states</span>
<a name="l00129"></a>00129 {
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// ------------------------------------</span>
<a name="l00132"></a>00132 <span class="comment">// STATE: EConnecting</span>
<a name="l00133"></a>00133 <span class="comment">// usually opens internet connection</span>
<a name="l00134"></a>00134 <span class="comment">// ------------------------------------</span>
<a name="l00135"></a>00135 <span class="keywordflow">case</span> EConnecting:
<a name="l00136"></a>00136 {
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="keywordflow">if</span>( iProtocolType==EProtocolPop3 )
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 MailCommandL(KPOP3MTMConnect, null);
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142 <span class="keywordflow">else</span>
<a name="l00143"></a>00143 {
<a name="l00144"></a>00144 <span class="comment">//As KIMAP4MTMConnect, but, after connection to</span>
<a name="l00145"></a>00145 <span class="comment">//the IMAP service, starts a background synchronisation.</span>
<a name="l00146"></a>00146 <span class="comment">//The call completes when the connection occurs</span>
<a name="l00147"></a>00147 <span class="comment">//and the synchronisation starts.</span>
<a name="l00148"></a>00148 MailCommandL(KIMAP4MTMConnectAndSynchronise, null);
<a name="l00149"></a>00149 }
<a name="l00150"></a>00150
<a name="l00151"></a>00151 iState=EFetching;
<a name="l00152"></a>00152 SetActive(); <span class="comment">//returns to active scheduler which waits for our request</span>
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154 <span class="keywordflow">break</span>;
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <span class="comment">// ------------------------------------</span>
<a name="l00157"></a>00157 <span class="comment">// STATE: EFetching</span>
<a name="l00158"></a>00158 <span class="comment">// handles the remote mail fetch</span>
<a name="l00159"></a>00159 <span class="comment">// ------------------------------------</span>
<a name="l00160"></a>00160 <span class="keywordflow">case</span> EFetching:
<a name="l00161"></a>00161 {
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="comment">// SEPARATION BETWEEN IMAP AND POP</span>
<a name="l00164"></a>00164 <span class="keywordflow">if</span>( iProtocolType==EProtocolPop3 )
<a name="l00165"></a>00165 {
<a name="l00166"></a>00166 TImPop3GetMailInfo Pop3GetMailInfo; <span class="comment">// setup a mail info buffer</span>
<a name="l00167"></a>00167 <span class="comment">// setting iMaxEmailSize to KMaxTUint tells messaging to get the headers only</span>
<a name="l00168"></a>00168 Pop3GetMailInfo.iMaxEmailSize = KMaxTUint;
<a name="l00169"></a>00169 <span class="comment">// setup which service to download the messages from</span>
<a name="l00170"></a>00170 Pop3GetMailInfo.iDestinationFolder = iServiceId;
<a name="l00171"></a>00171 <span class="comment">// package up the information</span>
<a name="l00172"></a>00172 TPckgBuf<TImPop3GetMailInfo> package(Pop3GetMailInfo);
<a name="l00173"></a>00173 <span class="comment">// execute a pop3 copy mail command</span>
<a name="l00174"></a>00174 MailCommandL(KPOP3MTMCopyAllMailWhenAlreadyConnected,package);
<a name="l00175"></a>00175 }
<a name="l00176"></a>00176 <span class="keywordflow">else</span>
<a name="l00177"></a>00177 {
<a name="l00178"></a>00178 <span class="comment">//Completes (with KErrNone) only when the background synchronisation</span>
<a name="l00179"></a>00179 <span class="comment">//has finished. It is used to ensure that no UI-initiated</span>
<a name="l00180"></a>00180 <span class="comment">//folder syncing is performed during the background synchronisation.</span>
<a name="l00181"></a>00181 MailCommandL(KIMAP4MTMWaitForBackground,null);
<a name="l00182"></a>00182 }
<a name="l00183"></a>00183
<a name="l00184"></a>00184 iState=EDisconnecting;
<a name="l00185"></a>00185 SetActive(); <span class="comment">//returns to active scheduler which waits for our request</span>
<a name="l00186"></a>00186 }
<a name="l00187"></a>00187 <span class="keywordflow">break</span>;
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">// ------------------------------------</span>
<a name="l00190"></a>00190 <span class="comment">// STATE: EDisconnecting</span>
<a name="l00191"></a>00191 <span class="comment">// Disconnects from remote mailbox</span>
<a name="l00192"></a>00192 <span class="comment">// note: state only for pop as</span>
<a name="l00193"></a>00193 <span class="comment">// it is only offline mode protocol</span>
<a name="l00194"></a>00194 <span class="comment">// ------------------------------------</span>
<a name="l00195"></a>00195 <span class="keywordflow">case</span> EDisconnecting:
<a name="l00196"></a>00196 {
<a name="l00197"></a>00197 <span class="comment">// SEPARATION BETWEEN IMAP AND POP</span>
<a name="l00198"></a>00198 <span class="keywordflow">if</span>( iProtocolType==EProtocolPop3 )
<a name="l00199"></a>00199 {
<a name="l00200"></a>00200 MailCommandL(KPOP3MTMDisconnect,null); <span class="comment">// execute a disconnect from service command</span>
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202 <span class="keywordflow">else</span>
<a name="l00203"></a>00203 {
<a name="l00204"></a>00204 <span class="comment">//Cancels any operations in progress</span>
<a name="l00205"></a>00205 <span class="comment">//and sends logout messages to server.</span>
<a name="l00206"></a>00206 <span class="comment">//As long as the background synchronisation,</span>
<a name="l00207"></a>00207 <span class="comment">//this will also run any pending delete operations queued while offline.</span>
<a name="l00208"></a>00208 MailCommandL(KIMAP4MTMDisconnect,null);
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210
<a name="l00211"></a>00211 iState=EDone;
<a name="l00212"></a>00212 SetActive();
<a name="l00213"></a>00213 }
<a name="l00214"></a>00214 <span class="keywordflow">break</span>;
<a name="l00215"></a>00215
<a name="l00216"></a>00216 <span class="comment">// ------------------------------------</span>
<a name="l00217"></a>00217 <span class="comment">// STATE: EDone</span>
<a name="l00218"></a>00218 <span class="comment">// Returns our machine to ready state</span>
<a name="l00219"></a>00219 <span class="comment">// ------------------------------------</span>
<a name="l00220"></a>00220 <span class="keywordflow">case</span> EDone:
<a name="l00221"></a>00221 {
<a name="l00222"></a>00222 UpdateRemoteCountL(); <span class="comment">// updates model and informs observers</span>
<a name="l00223"></a>00223 iState = EReady;
<a name="l00224"></a>00224 <span class="keywordflow">if</span>(iMsvOp)
<a name="l00225"></a>00225 {
<a name="l00226"></a>00226 iMsvOp->Cancel();
<a name="l00227"></a>00227 }
<a name="l00228"></a>00228 <span class="keyword">delete</span> iMsvOp;
<a name="l00229"></a>00229 iMsvOp=NULL;
<a name="l00230"></a>00230 }
<a name="l00231"></a>00231 <span class="keywordflow">break</span>;
<a name="l00232"></a>00232
<a name="l00233"></a>00233 <span class="comment">// ------------------------------------</span>
<a name="l00234"></a>00234 <span class="comment">// STATE: ECanceling</span>
<a name="l00235"></a>00235 <span class="comment">// waits for mailcommands to cancel</span>
<a name="l00236"></a>00236 <span class="comment">// ------------------------------------</span>
<a name="l00237"></a>00237 <span class="keywordflow">case</span> ECanceling:
<a name="l00238"></a>00238 {
<a name="l00239"></a>00239 UpdateRemoteCountL(); <span class="comment">// updates model and informs observers</span>
<a name="l00240"></a>00240 iState= EReady;
<a name="l00241"></a>00241 <span class="keyword">delete</span> iMsvOp;
<a name="l00242"></a>00242 iMsvOp=NULL;
<a name="l00243"></a>00243 }
<a name="l00244"></a>00244 <span class="keywordflow">break</span>;
<a name="l00245"></a>00245
<a name="l00246"></a>00246 <span class="keywordflow">default</span>:
<a name="l00247"></a>00247 <span class="comment">//EReady is default, EInitialising, EReadyButNeedsProtocol</span>
<a name="l00248"></a>00248 <span class="comment">//handled elsewhere</span>
<a name="l00249"></a>00249 <span class="keywordflow">break</span>;
<a name="l00250"></a>00250 }
<a name="l00251"></a>00251 }
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00254"></a>00254 <span class="comment">// void CInternetEmailEngine::MailCommandL( const TInt aCommand,TDes8& aParams)</span>
<a name="l00255"></a>00255 <span class="comment">// Excecutes asynchronous calls for both protocols. Note the specific</span>
<a name="l00256"></a>00256 <span class="comment">// aSelection and aParams given to InvokeAsyncFunctionL (and later to</span>
<a name="l00257"></a>00257 <span class="comment">// TransferCommandL) define the functioncall.</span>
<a name="l00258"></a>00258 <span class="comment">//</span>
<a name="l00259"></a>00259 <span class="comment">// Cornerstone ii of this module.</span>
<a name="l00260"></a>00260 <span class="comment">// ----------------------------------------------------------------------------</span>
<a name="l00261"></a>00261 <span class="keywordtype">void</span> CInternetEmailEngine::MailCommandL( <span class="keyword">const</span> TInt aCommand, TDes8& aParams)
<a name="l00262"></a>00262 {
<a name="l00263"></a>00263 <span class="comment">// make sure iServiceId is a remote type service</span>
<a name="l00264"></a>00264 <span class="keywordflow">if</span>( iServiceId != KMsvLocalServiceIndexEntryId )
<a name="l00265"></a>00265 {
<a name="l00266"></a>00266 iRemoteEntries->Reset();
<a name="l00267"></a>00267 iRemoteEntries->AppendL(iServiceId); <span class="comment">//aSelection[0] is used in many mtm commands</span>
<a name="l00268"></a>00268
<a name="l00269"></a>00269 <span class="comment">// get the msventry for the service id</span>
<a name="l00270"></a>00270 CMsvEntry* service = iMsvSession->GetEntryL(iServiceId);
<a name="l00271"></a>00271 CleanupStack::PushL(service);
<a name="l00272"></a>00272
<a name="l00273"></a>00273 <span class="comment">// make sure the mtm for the service is of approriate type</span>
<a name="l00274"></a>00274 <span class="keywordflow">if</span>(service->Entry().iMtm == iProtocolUid)
<a name="l00275"></a>00275 {
<a name="l00276"></a>00276 <span class="comment">// delete and reset any outstanding operation</span>
<a name="l00277"></a>00277 <span class="keywordflow">if</span>(iMsvOp)
<a name="l00278"></a>00278 {
<a name="l00279"></a>00279 iMsvOp->Cancel();
<a name="l00280"></a>00280 }
<a name="l00281"></a>00281 <span class="keyword">delete</span> iMsvOp;
<a name="l00282"></a>00282 iMsvOp=NULL;
<a name="l00283"></a>00283 iMsvOp=iMtm->InvokeAsyncFunctionL(aCommand,*iRemoteEntries,aParams<span class="comment">/*ptr*/</span>,iStatus);
<a name="l00284"></a>00284 <span class="keywordflow">if</span>( iStatus != KRequestPending )
<a name="l00285"></a>00285 {
<a name="l00286"></a>00286 User::Leave( iStatus.Int() ); <span class="comment">//leave if error</span>
<a name="l00287"></a>00287 }
<a name="l00288"></a>00288 }
<a name="l00289"></a>00289 CleanupStack::PopAndDestroy(service);
<a name="l00290"></a>00290 }
<a name="l00291"></a>00291 <span class="keywordflow">else</span>
<a name="l00292"></a>00292 {
<a name="l00293"></a>00293 User::Leave(KErrNotFound);
<a name="l00294"></a>00294 }
<a name="l00295"></a>00295 }
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00298"></a>00298 <span class="comment">// void CInternetEmailEngine::HandleSessionEventL(TMsvSessionEvent aEvent,</span>
<a name="l00299"></a>00299 <span class="comment">// TAny* /*aArg1*/,TAny* /*aArg2*/,TAny* /*aArg3*/ )</span>
<a name="l00300"></a>00300 <span class="comment">// Messaging callback from MMsvSessionObserver</span>
<a name="l00301"></a>00301 <span class="comment">//</span>
<a name="l00302"></a>00302 <span class="comment">// Cornerstone iii of this module.</span>
<a name="l00303"></a>00303 <span class="comment">// -----------------------------------------------------------------------</span>
<a name="l00304"></a>00304 <span class="keywordtype">void</span> CInternetEmailEngine::HandleSessionEventL(TMsvSessionEvent aEvent,
<a name="l00305"></a>00305 TAny* <span class="comment">/*aArg1*/</span>,TAny* <span class="comment">/*aArg2*/</span>,TAny* <span class="comment">/*aArg3*/</span> )
<a name="l00306"></a>00306 {
<a name="l00307"></a>00307 <span class="keywordflow">switch</span>(aEvent)
<a name="l00308"></a>00308 {
<a name="l00309"></a>00309 <span class="comment">// the messaging server is ready</span>
<a name="l00310"></a>00310 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvServerReady:
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 <span class="comment">// ---------------------------------------------</span>
<a name="l00313"></a>00313 <span class="comment">// STATE: EInitialising</span>
<a name="l00314"></a>00314 <span class="comment">// Completes constructs and changes state when</span>
<a name="l00315"></a>00315 <span class="comment">// MsvServer session is ready</span>
<a name="l00316"></a>00316 <span class="comment">// ---------------------------------------------</span>
<a name="l00317"></a>00317 <span class="keywordflow">if</span>(iState==EInitialising)
<a name="l00318"></a>00318 {
<a name="l00319"></a>00319 iState=EReadyButNeedsProtocol;
<a name="l00320"></a>00320 CompleteConstructL();
<a name="l00321"></a>00321 }
<a name="l00322"></a>00322 }
<a name="l00323"></a>00323 <span class="keywordflow">break</span>;
<a name="l00324"></a>00324
<a name="l00325"></a>00325 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvEntriesCreated:
<a name="l00326"></a>00326 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvEntriesChanged:
<a name="l00327"></a>00327 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvEntriesDeleted:
<a name="l00328"></a>00328 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvEntriesMoved:
<a name="l00329"></a>00329 <span class="comment">//note: we could notify observers here to redraw if entry</span>
<a name="l00330"></a>00330 <span class="comment">//would be approriate type and we would need more robust ui</span>
<a name="l00331"></a>00331 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMtmGroupInstalled:
<a name="l00332"></a>00332 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMtmGroupDeInstalled:
<a name="l00333"></a>00333 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvGeneralError:
<a name="l00334"></a>00334 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvServerFailedToStart:
<a name="l00335"></a>00335 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvCorruptedIndexRebuilt:
<a name="l00336"></a>00336 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvCloseSession:
<a name="l00337"></a>00337 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvServerTerminated:
<a name="l00338"></a>00338 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMediaChanged:
<a name="l00339"></a>00339 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMediaUnavailable:
<a name="l00340"></a>00340 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMediaAvailable:
<a name="l00341"></a>00341 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvMediaIncorrect:
<a name="l00342"></a>00342 <span class="keywordflow">case</span> MMsvSessionObserver::EMsvCorruptedIndexRebuilding:
<a name="l00343"></a>00343 <span class="keywordflow">break</span>;
<a name="l00344"></a>00344 }
<a name="l00345"></a>00345 }
<a name="l00346"></a>00346
<a name="l00347"></a>00347 <span class="comment">// ---------------------------------------------------------------</span>
<a name="l00348"></a>00348 <span class="comment">// void CInternetEmailEngine::DisplayMessageL( const TMsvId &aId )</span>
<a name="l00349"></a>00349 <span class="comment">// here we use the generic mtm ui (view) architecture</span>
<a name="l00350"></a>00350 <span class="comment">// and its views and dialogs to display messages in standard way.</span>
<a name="l00351"></a>00351 <span class="comment">//</span>
<a name="l00352"></a>00352 <span class="comment">// cornerstone iv: of this module.</span>
<a name="l00353"></a>00353 <span class="comment">// ---------------------------------------------------------------</span>
<a name="l00354"></a>00354 <span class="comment">//</span>
<a name="l00355"></a>00355 <span class="keywordtype">void</span> CInternetEmailEngine::DisplayMessageL( <span class="keyword">const</span> TMsvId &aId )
<a name="l00356"></a>00356 {
<a name="l00357"></a>00357 <span class="comment">// 1. construct the client MTM</span>
<a name="l00358"></a>00358 TMsvEntry indexEntry;
<a name="l00359"></a>00359 TMsvId serviceId;
<a name="l00360"></a>00360 User::LeaveIfError( iMsvSession->GetEntry(aId, serviceId, indexEntry));
<a name="l00361"></a>00361 CBaseMtm* mtm = iClientReg->NewMtmL(indexEntry.iMtm);
<a name="l00362"></a>00362 CleanupStack::PushL(mtm);
<a name="l00363"></a>00363
<a name="l00364"></a>00364 <span class="comment">// 2. construct the user interface MTM</span>
<a name="l00365"></a>00365 CBaseMtmUi* uiMtm = iUiReg->NewMtmUiL(*mtm);
<a name="l00366"></a>00366 CleanupStack::PushL(uiMtm);
<a name="l00367"></a>00367
<a name="l00368"></a>00368 <span class="comment">// 3. display the message</span>
<a name="l00369"></a>00369 uiMtm->BaseMtm().SwitchCurrentEntryL(indexEntry.Id());
<a name="l00370"></a>00370 CMsvOperationWait* waiter=CMsvOperationWait::NewLC();
<a name="l00371"></a>00371 waiter->Start(); <span class="comment">//we use synchronous waiter</span>
<a name="l00372"></a>00372 CMsvOperation* op = uiMtm->OpenL(waiter->iStatus); <span class="comment">//the main "async-sync" call</span>
<a name="l00373"></a>00373 CleanupStack::PushL(op);
<a name="l00374"></a>00374 CActiveScheduler::Start(); <span class="comment">//notice! nested active scheduler for modal operation</span>
<a name="l00375"></a>00375
<a name="l00376"></a>00376 <span class="comment">// 4. cleanup for example even members</span>
<a name="l00377"></a>00377 CleanupStack::PopAndDestroy(4); <span class="comment">// op,waiter, mtm, uimtm</span>
<a name="l00378"></a>00378 }
<a name="l00379"></a>00379
<a name="l00380"></a>00380
<a name="l00381"></a>00381 <span class="comment">// ---------------------------------------------</span>
<a name="l00382"></a>00382 <span class="comment">// void CInternetEmailEngine::CancelOperation()</span>
<a name="l00383"></a>00383 <span class="comment">// public interface method for user initiated</span>
<a name="l00384"></a>00384 <span class="comment">// cancelling of email operations.</span>
<a name="l00385"></a>00385 <span class="comment">// ---------------------------------------------</span>
<a name="l00386"></a>00386 <span class="comment">//</span>
<a name="l00387"></a>00387 <span class="keywordtype">void</span> CInternetEmailEngine::CancelOperation()
<a name="l00388"></a>00388 {
<a name="l00389"></a>00389 iState= ECanceling; <span class="comment">//we switch state and wait for op to cancel</span>
<a name="l00390"></a>00390
<a name="l00391"></a>00391 <span class="keywordflow">if</span>( iMsvOp )
<a name="l00392"></a>00392 {
<a name="l00393"></a>00393 iMsvOp->Cancel(); <span class="comment">//iStatus now KErrCancel (-3)</span>
<a name="l00394"></a>00394 }
<a name="l00395"></a>00395 }
<a name="l00396"></a>00396
<a name="l00397"></a>00397 <span class="comment">// ---------------------------------------------</span>
<a name="l00398"></a>00398 <span class="comment">// void CInternetEmailEngine::DoCancel()</span>
<a name="l00399"></a>00399 <span class="comment">// framework cancel method, no implemented here</span>
<a name="l00400"></a>00400 <span class="comment">// ---------------------------------------------</span>
<a name="l00401"></a>00401 <span class="comment">//</span>
<a name="l00402"></a>00402 <span class="keywordtype">void</span> CInternetEmailEngine::DoCancel()
<a name="l00403"></a>00403 {
<a name="l00404"></a>00404 <span class="comment">// no implementation required</span>
<a name="l00405"></a>00405 }
<a name="l00406"></a>00406
<a name="l00407"></a>00407 <span class="comment">// -------------------------------------------------------</span>
<a name="l00408"></a>00408 <span class="comment">// TInt CInternetEmailEngine::RunError( const TInt aError)</span>
<a name="l00409"></a>00409 <span class="comment">// simply return error value</span>
<a name="l00410"></a>00410 <span class="comment">// -------------------------------------------------------</span>
<a name="l00411"></a>00411 <span class="comment">//</span>
<a name="l00412"></a>00412 TInt CInternetEmailEngine::RunError( <span class="keyword">const</span> TInt aError)
<a name="l00413"></a>00413 {
<a name="l00414"></a>00414 <span class="keywordflow">return</span> aError;
<a name="l00415"></a>00415 }
<a name="l00416"></a>00416
<a name="l00417"></a>00417 <span class="comment">// -------------------------------------</span>
<a name="l00418"></a>00418 <span class="comment">// void CInternetEmailEngine::LoadMtmL()</span>
<a name="l00419"></a>00419 <span class="comment">// common helper to load mtm context</span>
<a name="l00420"></a>00420 <span class="comment">// -------------------------------------</span>
<a name="l00421"></a>00421 <span class="comment">//</span>
<a name="l00422"></a>00422 <span class="keywordtype">void</span> CInternetEmailEngine::LoadMtmL()
<a name="l00423"></a>00423 {
<a name="l00424"></a>00424 <span class="keywordflow">if</span>(iId == KMsvRootIndexEntryId)
<a name="l00425"></a>00425 {
<a name="l00426"></a>00426 User::Leave(KErrNotFound);
<a name="l00427"></a>00427 }
<a name="l00428"></a>00428
<a name="l00429"></a>00429 TMsvEntry tmp;
<a name="l00430"></a>00430 User::LeaveIfError(iMsvSession->GetEntry(iId,iServiceId,tmp));
<a name="l00431"></a>00431 iMtm =InstantiateClientMtmL(iServiceId,iProtocolUid);
<a name="l00432"></a>00432 }
<a name="l00433"></a>00433
<a name="l00434"></a>00434 <span class="comment">// ------------------------------------------------------</span>
<a name="l00435"></a>00435 <span class="comment">// CBaseMtm* CInternetEmailEngine::InstantiateClientMtmL(</span>
<a name="l00436"></a>00436 <span class="comment">// TMsvId aService, const TUid aType)</span>
<a name="l00437"></a>00437 <span class="comment">// Helper to load either imap/pop mtm using base class</span>
<a name="l00438"></a>00438 <span class="comment">// ------------------------------------------------------</span>
<a name="l00439"></a>00439 <span class="comment">//</span>
<a name="l00440"></a>00440 CBaseMtm* CInternetEmailEngine::InstantiateClientMtmL(TMsvId aService, <span class="keyword">const</span> TUid aType)
<a name="l00441"></a>00441 {
<a name="l00442"></a>00442 <span class="comment">// create a client mtm</span>
<a name="l00443"></a>00443 CBaseMtm* newMtm = iClientReg->NewMtmL(aType);
<a name="l00444"></a>00444 CleanupStack::PushL(newMtm);
<a name="l00445"></a>00445 <span class="comment">// get the entry associated with the given servive ID</span>
<a name="l00446"></a>00446 CMsvEntry* entry = iMsvSession->GetEntryL(aService);
<a name="l00447"></a>00447 CleanupStack::PushL(entry);
<a name="l00448"></a>00448 <span class="comment">// set the entry as the current entry</span>
<a name="l00449"></a>00449 <span class="comment">// mtm takes ownership of the entry</span>
<a name="l00450"></a>00450 newMtm->SetCurrentEntryL(entry);
<a name="l00451"></a>00451 CleanupStack::Pop(2); <span class="comment">//newMtm, entry</span>
<a name="l00452"></a>00452 <span class="keywordflow">return</span> newMtm;
<a name="l00453"></a>00453 }
<a name="l00454"></a>00454
<a name="l00455"></a>00455 <span class="comment">// -------------------------------------------------------------------</span>
<a name="l00456"></a>00456 <span class="comment">// void CInternetEmailEngine::Queue()</span>
<a name="l00457"></a>00457 <span class="comment">// SetActive() or complete our own status.</span>
<a name="l00458"></a>00458 <span class="comment">// this allows the active scheduler chance to</span>
<a name="l00459"></a>00459 <span class="comment">// service other active objects before return back to our RunL</span>
<a name="l00460"></a>00460 <span class="comment">// -------------------------------------------------------------------</span>
<a name="l00461"></a>00461 <span class="comment">//</span>
<a name="l00462"></a>00462 <span class="keywordtype">void</span> CInternetEmailEngine::Queue()
<a name="l00463"></a>00463 {
<a name="l00464"></a>00464 <span class="keywordflow">if</span>(!IsActive())
<a name="l00465"></a>00465 {
<a name="l00466"></a>00466 SetActive();
<a name="l00467"></a>00467 }
<a name="l00468"></a>00468
<a name="l00469"></a>00469 TRequestStatus* st= &iStatus;
<a name="l00470"></a>00470 User::RequestComplete(st,KErrNone);
<a name="l00471"></a>00471 }
<a name="l00472"></a>00472
<a name="l00473"></a>00473 <span class="comment">// -----------------------------------------------------------------</span>
<a name="l00474"></a>00474 <span class="comment">// TBool CInternetEmailEngine::CheckIfExistsL( const TInt typeenum )</span>
<a name="l00475"></a>00475 <span class="comment">// returns ETrue if given type protocol type exists</span>
<a name="l00476"></a>00476 <span class="comment">// -----------------------------------------------------------------</span>
<a name="l00477"></a>00477 <span class="comment">//</span>
<a name="l00478"></a>00478 TBool CInternetEmailEngine::CheckIfExistsL( <span class="keyword">const</span> TInt aTypeEnum )
<a name="l00479"></a>00479 {
<a name="l00480"></a>00480 TUid temp = ( aTypeEnum == EProtocolImap4 ) ? KUidMsgTypeIMAP4 : KUidMsgTypePOP3;
<a name="l00481"></a>00481 TMsvId <span class="keywordtype">id</span>=FindServiceL(temp);
<a name="l00482"></a>00482 <span class="keywordflow">return</span> ( <span class="keywordtype">id</span> == KMsvRootIndexEntryId ) ? EFalse : ETrue;
<a name="l00483"></a>00483 }
<a name="l00484"></a>00484
<a name="l00485"></a>00485
<a name="l00486"></a>00486 <span class="comment">// ---------------------------------------------------------------</span>
<a name="l00487"></a>00487 <span class="comment">// TPtrC CInternetEmailEngine::RemoteEmailTextL(const TInt aIndex)</span>
<a name="l00488"></a>00488 <span class="comment">// Get the subject of the email from message header</span>
<a name="l00489"></a>00489 <span class="comment">// ---------------------------------------------------------------</span>
<a name="l00490"></a>00490 <span class="comment">//</span>
<a name="l00491"></a>00491 TPtrC CInternetEmailEngine::RemoteEmailTextL( <span class="keyword">const</span> TInt aIndex )
<a name="l00492"></a>00492 {
<a name="l00493"></a>00493 <span class="keywordflow">if</span>( iState == ECanceling )
<a name="l00494"></a>00494 {
<a name="l00495"></a>00495 User::Leave( KErrCancel );
<a name="l00496"></a>00496 }
<a name="l00497"></a>00497
<a name="l00498"></a>00498 TMsvId entryId=(*iRemoteEntries)[aIndex];
<a name="l00499"></a>00499 <span class="keywordflow">if</span>(iEntry==NULL || iEntry->Entry().Id()!=entryId)
<a name="l00500"></a>00500 {
<a name="l00501"></a>00501 <span class="keyword">delete</span> iEntry;
<a name="l00502"></a>00502 iEntry=NULL;
<a name="l00503"></a>00503 iEntry=iMsvSession->GetEntryL(entryId);
<a name="l00504"></a>00504 }
<a name="l00505"></a>00505 <span class="keywordflow">return</span> iEntry->Entry().iDescription;
<a name="l00506"></a>00506 }
<a name="l00507"></a>00507
<a name="l00508"></a>00508 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00509"></a>00509 <span class="comment">// TPtrC CInternetEmailEngine::RemoteEmailSenderL( const TInt aIndex)</span>
<a name="l00510"></a>00510 <span class="comment">// Get the sender of the email from message header</span>
<a name="l00511"></a>00511 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00512"></a>00512 <span class="comment">//</span>
<a name="l00513"></a>00513 TPtrC CInternetEmailEngine::RemoteEmailSenderL( <span class="keyword">const</span> TInt aIndex )
<a name="l00514"></a>00514 {
<a name="l00515"></a>00515 <span class="keywordflow">if</span>( iState == ECanceling )
<a name="l00516"></a>00516 {
<a name="l00517"></a>00517 User::Leave( KErrCancel );
<a name="l00518"></a>00518 }
<a name="l00519"></a>00519
<a name="l00520"></a>00520 TMsvId entryId=(*iRemoteEntries)[aIndex];
<a name="l00521"></a>00521 <span class="keywordflow">if</span>(iEntry==NULL || iEntry->Entry().Id()!=entryId)
<a name="l00522"></a>00522 {
<a name="l00523"></a>00523 <span class="keyword">delete</span> iEntry;
<a name="l00524"></a>00524 iEntry=NULL;
<a name="l00525"></a>00525 iEntry=iMsvSession->GetEntryL(entryId);
<a name="l00526"></a>00526 }
<a name="l00527"></a>00527 <span class="keywordflow">return</span> iEntry->Entry().iDetails;
<a name="l00528"></a>00528 }
<a name="l00529"></a>00529
<a name="l00530"></a>00530 <span class="comment">// ---------------------------------------------</span>
<a name="l00531"></a>00531 <span class="comment">// TInt CInternetEmailEngine::RemoteEmailCount()</span>
<a name="l00532"></a>00532 <span class="comment">// get the email count as integer</span>
<a name="l00533"></a>00533 <span class="comment">// ---------------------------------------------</span>
<a name="l00534"></a>00534 <span class="comment">//</span>
<a name="l00535"></a>00535 TInt CInternetEmailEngine::RemoteEmailCount()
<a name="l00536"></a>00536 {
<a name="l00537"></a>00537 <span class="keywordflow">return</span> iRemoteCount;
<a name="l00538"></a>00538 }
<a name="l00539"></a>00539
<a name="l00540"></a>00540 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00541"></a>00541 <span class="comment">// void CInternetEmailEngine::RemoteOpenEmailL( TInt aIndex )</span>
<a name="l00542"></a>00542 <span class="comment">// open remote email. may cause system to go online to retrieve mail</span>
<a name="l00543"></a>00543 <span class="comment">// ------------------------------------------------------------------</span>
<a name="l00544"></a>00544 <span class="comment">//</span>
<a name="l00545"></a>00545 <span class="keywordtype">void</span> CInternetEmailEngine::RemoteOpenEmailL( TInt aIndex )
<a name="l00546"></a>00546 {
<a name="l00547"></a>00547 TMsvId entryId=(*iRemoteEntries)[aIndex];
<a name="l00548"></a>00548 <span class="keywordflow">if</span>(aIndex<0 || aIndex>=iRemoteCount)
<a name="l00549"></a>00549 {
<a name="l00550"></a>00550 User::Leave(KErrGeneral);
<a name="l00551"></a>00551 }
<a name="l00552"></a>00552 iState=EReady;
<a name="l00553"></a>00553 DisplayMessageL(entryId);
<a name="l00554"></a>00554 }
<a name="l00555"></a>00555
<a name="l00556"></a>00556 <span class="comment">// --------------------------------------------------------</span>
<a name="l00557"></a>00557 <span class="comment">// void CInternetEmailEngine::RemoteFetchL()</span>
<a name="l00558"></a>00558 <span class="comment">// enters connect state and queues own request accordingly</span>
<a name="l00559"></a>00559 <span class="comment">// --------------------------------------------------------</span>
<a name="l00560"></a>00560 <span class="comment">//</span>
<a name="l00561"></a>00561 <span class="keywordtype">void</span> CInternetEmailEngine::RemoteFetchL()
<a name="l00562"></a>00562 {
<a name="l00563"></a>00563 iState=EConnecting;
<a name="l00564"></a>00564 Queue();
<a name="l00565"></a>00565 }
<a name="l00566"></a>00566
<a name="l00567"></a>00567 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00568"></a>00568 <span class="comment">// CMsvEntrySelection* CInternetEmailEngine::UpdateEntriesL(</span>
<a name="l00569"></a>00569 <span class="comment">// const TMsvId& aServiceId)</span>
<a name="l00570"></a>00570 <span class="comment">// updates the message entries for viewing</span>
<a name="l00571"></a>00571 <span class="comment">// ---------------------------------------------------------</span>
<a name="l00572"></a>00572 <span class="comment">//</span>
<a name="l00573"></a>00573 CMsvEntrySelection* CInternetEmailEngine::UpdateEntriesL(
<a name="l00574"></a>00574 <span class="keyword">const</span> TMsvId& aServiceId)
<a name="l00575"></a>00575 {
<a name="l00576"></a>00576 CMsvEntry* entry=iMsvSession->GetEntryL(aServiceId); <span class="comment">// get the entry</span>
<a name="l00577"></a>00577 CleanupStack::PushL(entry);
<a name="l00578"></a>00578 CMsvEntrySelection* entries=entry->ChildrenL(); <span class="comment">// get the entry's children</span>
<a name="l00579"></a>00579 CleanupStack::PopAndDestroy(entry);
<a name="l00580"></a>00580 <span class="keywordflow">return</span> entries;
<a name="l00581"></a>00581 }
<a name="l00582"></a>00582
<a name="l00583"></a>00583 <span class="comment">// -----------------------------------------------</span>
<a name="l00584"></a>00584 <span class="comment">// void CInternetEmailEngine::UpdateRemoteCountL()</span>
<a name="l00585"></a>00585 <span class="comment">// update the remote mail count</span>
<a name="l00586"></a>00586 <span class="comment">//</span>
<a name="l00587"></a>00587 <span class="comment">// Note: only method where observers are notified</span>
<a name="l00588"></a>00588 <span class="comment">// -----------------------------------------------</span>
<a name="l00589"></a>00589 <span class="comment">//</span>
<a name="l00590"></a>00590 <span class="keywordtype">void</span> CInternetEmailEngine::UpdateRemoteCountL()
<a name="l00591"></a>00591 {
<a name="l00592"></a>00592 <span class="comment">// reset the remote mail count and entries</span>
<a name="l00593"></a>00593 iRemoteCount=0;
<a name="l00594"></a>00594 <span class="keyword">delete</span> iRemoteEntries;
<a name="l00595"></a>00595 iRemoteEntries=NULL;
<a name="l00596"></a>00596
<a name="l00597"></a>00597 <span class="comment">// SEPARATION BETWEEN IMAP AND POP</span>
<a name="l00598"></a>00598 <span class="keywordflow">if</span>( iProtocolType == EProtocolImap4 && !iHasImapInbox )
<a name="l00599"></a>00599 {
<a name="l00600"></a>00600 iId=FindFolderThenServiceL(iProtocolUid); <span class="comment">//leaves with KErrFound if still no folder set</span>
<a name="l00601"></a>00601 }
<a name="l00602"></a>00602
<a name="l00603"></a>00603 <span class="comment">// get the current entries. Note that iId is normally a remote</span>
<a name="l00604"></a>00604 <span class="comment">// mailbox for pop and first folder( inbox ) for imap. which is</span>
<a name="l00605"></a>00605 <span class="comment">// why we have to check if folders are already sync if protocol</span>
<a name="l00606"></a>00606 <span class="comment">// is imap, so we wont draw the screen with wrong parent and output</span>
<a name="l00607"></a>00607 <span class="comment">// folders to the listbox and not the message entries we want to.</span>
<a name="l00608"></a>00608 iRemoteEntries=UpdateEntriesL(iId);
<a name="l00609"></a>00609
<a name="l00610"></a>00610
<a name="l00611"></a>00611 <span class="comment">// if the nunber has changed then inform the observers</span>
<a name="l00612"></a>00612 <span class="keywordflow">if</span>(iRemoteEntries->Count()!=iRemoteCount)
<a name="l00613"></a>00613 {
<a name="l00614"></a>00614 iRemoteCount=iRemoteEntries->Count();
<a name="l00615"></a>00615 iObserver.HandleEngineChangedEventL(ERemoteCountChanged);
<a name="l00616"></a>00616 }
<a name="l00617"></a>00617 }
<a name="l00618"></a>00618
<a name="l00619"></a>00619 <span class="comment">// -------------------------------------------</span>
<a name="l00620"></a>00620 <span class="comment">// TBool CInternetEmailEngine::IsProtocolSet()</span>
<a name="l00621"></a>00621 <span class="comment">// returns ETrue if protocol is set</span>
<a name="l00622"></a>00622 <span class="comment">// -------------------------------------------</span>
<a name="l00623"></a>00623 <span class="comment">//</span>
<a name="l00624"></a>00624 TBool CInternetEmailEngine::IsProtocolSet()
<a name="l00625"></a>00625 {
<a name="l00626"></a>00626 <span class="keywordflow">return</span> iIsProtocolSet;
<a name="l00627"></a>00627 }
<a name="l00628"></a>00628
<a name="l00629"></a>00629 <span class="comment">// ----------------------------------------------------</span>
<a name="l00630"></a>00630 <span class="comment">// TBool CInternetEmailEngine::IsEngineReady()</span>
<a name="l00631"></a>00631 <span class="comment">// returns ETrue if server is ready thus engine is too</span>
<a name="l00632"></a>00632 <span class="comment">// ----------------------------------------------------</span>
<a name="l00633"></a>00633 <span class="comment">//</span>
<a name="l00634"></a>00634 TBool CInternetEmailEngine::IsEngineReady()
<a name="l00635"></a>00635 {
<a name="l00636"></a>00636 <span class="keywordflow">return</span> (iClientReg!=NULL)?(ETrue):(EFalse);
<a name="l00637"></a>00637 }
<a name="l00638"></a>00638
<a name="l00639"></a>00639 <span class="comment">// --------------------------------------------------------------</span>
<a name="l00640"></a>00640 <span class="comment">// void CInternetEmailEngine::SetProtocolL( const TInt aType )</span>
<a name="l00641"></a>00641 <span class="comment">// sets protocol and loads mtm context for given protocol.</span>
<a name="l00642"></a>00642 <span class="comment">// note that the structure of mailbox is fundamentally different</span>
<a name="l00643"></a>00643 <span class="comment">// between simple POP and better IMAP. IMAP has folders like</span>
<a name="l00644"></a>00644 <span class="comment">// inbox under the service entry so we must the pick different</span>
<a name="l00645"></a>00645 <span class="comment">// nesting level with IMAP than with POP.</span>
<a name="l00646"></a>00646 <span class="comment">// --------------------------------------------------------------</span>
<a name="l00647"></a>00647 <span class="comment">//</span>
<a name="l00648"></a>00648 <span class="keywordtype">void</span> CInternetEmailEngine::SetProtocolL( <span class="keyword">const</span> TInt aType )
<a name="l00649"></a>00649 {
<a name="l00650"></a>00650 iProtocolType=aType;
<a name="l00651"></a>00651 iProtocolUid=(iProtocolType==EProtocolPop3)?KUidMsgTypePOP3:KUidMsgTypeIMAP4;
<a name="l00652"></a>00652 iIsProtocolSet=ETrue;
<a name="l00653"></a>00653 iState=EReady;
<a name="l00654"></a>00654 iId=FindServiceL(iProtocolUid);
<a name="l00655"></a>00655 LoadMtmL();
<a name="l00656"></a>00656
<a name="l00657"></a>00657 <span class="keywordflow">if</span>( iProtocolType!=EProtocolPop3) <span class="comment">//Note IMAP has folders!</span>
<a name="l00658"></a>00658 {
<a name="l00659"></a>00659 TRAPD( err, iId=FindFolderThenServiceL(iProtocolUid));
<a name="l00660"></a>00660 <span class="keywordflow">if</span>( err != KErrNone )
<a name="l00661"></a>00661 {
<a name="l00662"></a>00662 <span class="comment">//now we know we have fresh imap service without any folders</span>
<a name="l00663"></a>00663 <span class="keywordflow">return</span>;
<a name="l00664"></a>00664 }
<a name="l00665"></a>00665 }
<a name="l00666"></a>00666
<a name="l00667"></a>00667 UpdateRemoteCountL(); <span class="comment">//we draw the message entries if any</span>
<a name="l00668"></a>00668
<a name="l00669"></a>00669
<a name="l00670"></a>00670 }
<a name="l00671"></a>00671
<a name="l00672"></a>00672
<a name="l00673"></a>00673
<a name="l00674"></a>00674 <span class="comment">// --------------------------------------------------------------</span>
<a name="l00675"></a>00675 <span class="comment">// TMsvId CInternetEmailEngine::FindServiceL(TUid aType)</span>
<a name="l00676"></a>00676 <span class="comment">// find the message id of a service given a UID</span>
<a name="l00677"></a>00677 <span class="comment">// this function will return the first service id for given type</span>
<a name="l00678"></a>00678 <span class="comment">// --------------------------------------------------------------</span>
<a name="l00679"></a>00679 <span class="comment">//</span>
<a name="l00680"></a>00680 TMsvId CInternetEmailEngine::FindServiceL(TUid aType)
<a name="l00681"></a>00681 {
<a name="l00682"></a>00682 <span class="comment">// select the root index to start the search</span>
<a name="l00683"></a>00683 CMsvEntry* currentEntry = iMsvSession->GetEntryL(KMsvRootIndexEntryId);
<a name="l00684"></a>00684 CleanupStack::PushL(currentEntry);
<a name="l00685"></a>00685
<a name="l00686"></a>00686 <span class="comment">// don't sort the entries</span>
<a name="l00687"></a>00687 currentEntry->SetSortTypeL(TMsvSelectionOrdering(KMsvNoGrouping,EMsvSortByNone, ETrue));
<a name="l00688"></a>00688
<a name="l00689"></a>00689 TMsvId rc = KMsvRootIndexEntryId;
<a name="l00690"></a>00690 TInt count=currentEntry->Count();
<a name="l00691"></a>00691 <span class="comment">// loop for every child entry of the root index</span>
<a name="l00692"></a>00692 <span class="keywordflow">for</span>(TInt i = 0;i<count;i++)
<a name="l00693"></a>00693 {
<a name="l00694"></a>00694 <span class="keyword">const</span> TMsvEntry& child = (*currentEntry)[i];
<a name="l00695"></a>00695
<a name="l00696"></a>00696 <span class="comment">// is the current child the same type as the type we are looking for ?</span>
<a name="l00697"></a>00697 <span class="keywordflow">if</span> (child.iMtm == aType)
<a name="l00698"></a>00698 {
<a name="l00699"></a>00699 rc=child.Id();
<a name="l00700"></a>00700 <span class="keywordflow">break</span>;
<a name="l00701"></a>00701 }
<a name="l00702"></a>00702 }<span class="comment">//for</span>
<a name="l00703"></a>00703
<a name="l00704"></a>00704 CleanupStack::PopAndDestroy(currentEntry);
<a name="l00705"></a>00705 <span class="comment">// return the service id of the type if found.</span>
<a name="l00706"></a>00706 <span class="comment">// otherwise return the root index</span>
<a name="l00707"></a>00707 <span class="keywordflow">return</span> rc;
<a name="l00708"></a>00708 }
<a name="l00709"></a>00709
<a name="l00710"></a>00710 <span class="comment">// ---------------------------------------------------------------</span>
<a name="l00711"></a>00711 <span class="comment">// TMsvId CInternetEmailEngine::FindFolderThenServiceL(TUid aType)</span>
<a name="l00712"></a>00712 <span class="comment">// this function will return the first folder of first</span>
<a name="l00713"></a>00713 <span class="comment">// service of given type or if it doesnt exist then</span>
<a name="l00714"></a>00714 <span class="comment">// this function will leave with KErrNotFound as most of</span>
<a name="l00715"></a>00715 <span class="comment">// the usage sitations couldnt handle mailbox instead of</span>
<a name="l00716"></a>00716 <span class="comment">// folder.</span>
<a name="l00717"></a>00717 <span class="comment">// ----------------------------------------------------------------</span>
<a name="l00718"></a>00718 <span class="comment">//</span>
<a name="l00719"></a>00719 TMsvId CInternetEmailEngine::FindFolderThenServiceL(TUid aType)
<a name="l00720"></a>00720 {
<a name="l00721"></a>00721
<a name="l00722"></a>00722 <span class="comment">// select the root index to start the search</span>
<a name="l00723"></a>00723 CMsvEntry* currentEntry = iMsvSession->GetEntryL(KMsvRootIndexEntryId);
<a name="l00724"></a>00724 CleanupStack::PushL(currentEntry);
<a name="l00725"></a>00725
<a name="l00726"></a>00726 <span class="comment">// don't sort the entries</span>
<a name="l00727"></a>00727 currentEntry->SetSortTypeL(TMsvSelectionOrdering(KMsvNoGrouping,EMsvSortByNone, ETrue));
<a name="l00728"></a>00728
<a name="l00729"></a>00729 TMsvId rc = KMsvRootIndexEntryId;
<a name="l00730"></a>00730 TInt count=currentEntry->Count();
<a name="l00731"></a>00731 <span class="comment">// loop for every child entry of the root index</span>
<a name="l00732"></a>00732 <span class="keywordflow">for</span>(TInt i = 0;i<count;i++)
<a name="l00733"></a>00733 {
<a name="l00734"></a>00734 <span class="keyword">const</span> TMsvEntry& child = (*currentEntry)[i];
<a name="l00735"></a>00735
<a name="l00736"></a>00736 <span class="comment">// is the current child the same type as the type we are looking for ?</span>
<a name="l00737"></a>00737 <span class="keywordflow">if</span> (child.iMtm == aType)
<a name="l00738"></a>00738 {
<a name="l00739"></a>00739 <span class="comment">// selects first entry as index entry</span>
<a name="l00740"></a>00740 CMsvEntry* firstEntry = iMsvSession->GetEntryL(child.Id());
<a name="l00741"></a>00741 CleanupStack::PushL(firstEntry);
<a name="l00742"></a>00742 TInt innercount=firstEntry->Count();
<a name="l00743"></a>00743 <span class="keywordflow">if</span>( innercount )
<a name="l00744"></a>00744 { <span class="comment">//if has childs == folders take first</span>
<a name="l00745"></a>00745 <span class="keyword">const</span> TMsvEntry& folder = (*firstEntry)[0];
<a name="l00746"></a>00746 rc=folder.Id();
<a name="l00747"></a>00747 iHasImapInbox=ETrue;
<a name="l00748"></a>00748 }
<a name="l00749"></a>00749 <span class="keywordflow">else</span>
<a name="l00750"></a>00750 {
<a name="l00751"></a>00751 iHasImapInbox=EFalse;
<a name="l00752"></a>00752 }
<a name="l00753"></a>00753 CleanupStack::PopAndDestroy(firstEntry);
<a name="l00754"></a>00754 <span class="keywordflow">break</span>;
<a name="l00755"></a>00755 }
<a name="l00756"></a>00756 }<span class="comment">//for</span>
<a name="l00757"></a>00757
<a name="l00758"></a>00758 CleanupStack::PopAndDestroy(currentEntry);
<a name="l00759"></a>00759
<a name="l00760"></a>00760 <span class="keywordflow">if</span>( !iHasImapInbox )
<a name="l00761"></a>00761 {
<a name="l00762"></a>00762 User::Leave( KErrNotFound );
<a name="l00763"></a>00763 }
<a name="l00764"></a>00764
<a name="l00765"></a>00765 <span class="comment">// return the service id of the type if found.</span>
<a name="l00766"></a>00766 <span class="keywordflow">return</span> rc;
<a name="l00767"></a>00767 }
<a name="l00768"></a>00768
<a name="l00769"></a>00769 <span class="comment">// End of File</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>