epoc32/include/imapconnectionobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/imapconnectionobserver.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/imapconnectionobserver.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,67 @@
-imapconnectionobserver.h
+// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#if !defined(__IMAPCONNECTIONOBSERVER_H__)
+#define __IMAPCONNECTIONOBSERVER_H__
+
+/** IMAP4 connection observer events.
+
+@see MMsvImapConnectionObserver 
+@publishedAll
+@released
+*/
+enum TImapConnectionEvent
+	{
+	/** Connecting to server. */
+	EConnectingToServer,
+	/** Synchronising folder list. */
+	ESynchronisingFolderList,
+	/** Synchronising inbox. */
+	ESynchronisingInbox,
+	/** Synchronising folders. */
+	ESynchronisingFolders,
+	/** Synchronisation complete. */
+	ESynchronisationComplete,
+	/** Disconnecting. */
+	EDisconnecting,
+	/** Connection completed. */
+	EConnectionCompleted
+	};
+
+//	Mix-in class to allow observation of the stages of an IMAP operation
+//
+class MMsvImapConnectionObserver
+/** Abstract base class used for IMAP4 connection observation. 
+
+A derived class to handle IMAP4 connection events should override the HandleImapConnectionEvent() 
+member function. 
+
+Objects that implement this interface are passed as a packaged parameter 
+to CImap4ClientMtm::InvokeAsyncFunctionL() when a connection command is issued.
+ 
+@publishedAll
+@released
+
+@see TImap4Cmds
+*/
+	{
+public:
+	/** Called when a connection event occurs.
+	
+	@param aConnectionState Connection event */
+	virtual void HandleImapConnectionEvent(TImapConnectionEvent aConnectionState)=0;
+	};
+
+#endif