email/pop3andsmtpmtm/clientmtms/inc/IMAPCMDS.H
changeset 76 60a8a215b0ec
parent 0 72b543305e3a
--- a/email/pop3andsmtpmtm/clientmtms/inc/IMAPCMDS.H	Tue Oct 05 13:58:47 2010 +0530
+++ b/email/pop3andsmtpmtm/clientmtms/inc/IMAPCMDS.H	Tue Oct 19 11:30:16 2010 +0530
@@ -48,6 +48,7 @@
 - Connect and logon to remote server:
   - #KIMAP4MTMConnect
   - #KIMAP4MTMDisconnect
+  - #KIMAP4MTMSilentConnect
 - Synchronise headers:
   - #KIMAP4MTMCancelBackgroundSynchronise
   - #KIMAP4MTMConnectAndSyncCompleteAfterConnect
@@ -59,6 +60,8 @@
   - #KIMAP4MTMInboxNewSync
   - #KIMAP4MTMSynchronise
   - #KIMAP4MTMWaitForBackground
+  - #KIMAP4MTMSilentConnectAndSynchronise
+  - #KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync
 - Subscribe to mailboxes:
   - #KIMAP4MTMLocalSubscribe
   - #KIMAP4MTMLocalUnsubscribe
@@ -153,6 +156,8 @@
 	This makes a network connection and logs on the IMAP server specified 
 	in the settings for the service. 
 	
+	Command KIMAP4MTMSilentConnect is also available to silently connect to the network.
+	
 	@c aSelection: @c aSelection[0] should contain the entry ID of the service 
 	to connect to.
 	 
@@ -175,6 +180,8 @@
 	The call completes when the connection occurs and the synchronisation starts. See
 	CImap4ClientMtm for a description of a background synchronisation.
 	
+	Command KIMAP4MTMSilentConnectAndSynchronise is also available to silently connect to the network.
+	
 	@c aSelection: @c aSelection[0] should contain the entry ID of the service 
 	to connect to.
 	 
@@ -491,6 +498,9 @@
 	This is similar to KIMAP4MTMConnectAndSynchronise, except that the operation
 	does not complete until synchronisation is complete.  
 	
+	Command KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync is also available to 
+	silently connect to the network.
+	
 	@c aSelection: @c aSelection[0] should contain the entry ID of the service 
 	to connect to.
 	 
@@ -1076,7 +1086,72 @@
 	The operation object returned is a CImEmailOperation. Final progress information 
 	from this contains the ID of the newly created message.
 	*/
-	KIMAP4MTMCreateReceiptEmailMessage
+	KIMAP4MTMCreateReceiptEmailMessage,
+	
+	/** Connects to the specified IMAP service.
+
+    This makes a network connection and logs on the IMAP server specified 
+    in the settings for the service. 
+    
+    This differs from KIMAP4MTMConnect by connecting to the network silently, without prompting the user.
+    
+    @c aSelection: @c aSelection[0] should contain the entry ID of the service 
+    to connect to.
+     
+    @c aParameter: packages a pointer to an implementation of the connection observer 
+    interface, MMsvImapConnectionObserver. Callbacks are made to this interface
+    to notify the client of the stages of connection.
+    
+    Completion: KErrBusy if the device is already connected to the specified server.
+
+    Example:
+    @code
+    TBuf8<1> parameter;
+    iOperation = iClientMtm->InvokeAsyncFunctionL(KIMAP4MTMSilentConnect, *iServiceSelection, parameter, iStatus);    
+    @endcode	  
+	 */
+	KIMAP4MTMSilentConnect,
+	
+	/** Connects to the specified IMAP service, and starts a background synchronisation.
+
+    The call completes when the connection occurs and the synchronisation starts. See
+    CImap4ClientMtm for a description of a background synchronisation.
+    
+    This differs from KIMAP4MTMConnectAndSynchronise by connecting to the network silently, without prompting the user.
+    
+    @c aSelection: @c aSelection[0] should contain the entry ID of the service 
+    to connect to.
+     
+    @c aParameter: packages a pointer to an implementation of the connection observer 
+    interface, MMsvImapConnectionObserver. Callbacks are made to this interface
+    to notify the client of the stages of connection and synchronisation.
+    
+    Completion: KErrBusy if the device is already connected to the specified server. 
+    
+    Example:
+    @code
+    TPckg<MMsvImapConnectionObserver*> parameter(this); 
+    iOperation = iClientMtm->InvokeAsyncFunctionL(KIMAP4MTMSilentConnectAndSynchronise, *iServiceSelection, parameter, iStatus);
+    @endcode 
+	 */
+	KIMAP4MTMSilentConnectAndSynchronise,
+
+	/** Connect and synchronise the specified service, and complete after synchronisation. 
+    
+    This is similar to KIMAP4MTMConnectAndSyncCompleteAfterFullSync except that it will not
+    prompt the user while connecting.
+    
+    @c aSelection: @c aSelection[0] should contain the entry ID of the service 
+    to connect to.
+     
+    @c aParameter: packages a pointer to an implementation of the connection observer 
+    interface, MMsvImapConnectionObserver. Callbacks are made to this interface
+    to notify the client of the stages of connection and synchronisation.
+    
+    Completion: KErrBusy if a connected session already exists. 
+	*/
+	KIMAP4MTMSilentConnectAndSyncCompleteAfterFullSync
+
 };
 
 #endif