1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/app/imapconnectionobserver.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,67 @@
1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#if !defined(__IMAPCONNECTIONOBSERVER_H__)
1.20 +#define __IMAPCONNECTIONOBSERVER_H__
1.21 +
1.22 +/** IMAP4 connection observer events.
1.23 +
1.24 +@see MMsvImapConnectionObserver
1.25 +@publishedAll
1.26 +@released
1.27 +*/
1.28 +enum TImapConnectionEvent
1.29 + {
1.30 + /** Connecting to server. */
1.31 + EConnectingToServer,
1.32 + /** Synchronising folder list. */
1.33 + ESynchronisingFolderList,
1.34 + /** Synchronising inbox. */
1.35 + ESynchronisingInbox,
1.36 + /** Synchronising folders. */
1.37 + ESynchronisingFolders,
1.38 + /** Synchronisation complete. */
1.39 + ESynchronisationComplete,
1.40 + /** Disconnecting. */
1.41 + EDisconnecting,
1.42 + /** Connection completed. */
1.43 + EConnectionCompleted
1.44 + };
1.45 +
1.46 +// Mix-in class to allow observation of the stages of an IMAP operation
1.47 +//
1.48 +class MMsvImapConnectionObserver
1.49 +/** Abstract base class used for IMAP4 connection observation.
1.50 +
1.51 +A derived class to handle IMAP4 connection events should override the HandleImapConnectionEvent()
1.52 +member function.
1.53 +
1.54 +Objects that implement this interface are passed as a packaged parameter
1.55 +to CImap4ClientMtm::InvokeAsyncFunctionL() when a connection command is issued.
1.56 +
1.57 +@publishedAll
1.58 +@released
1.59 +
1.60 +@see TImap4Cmds
1.61 +*/
1.62 + {
1.63 +public:
1.64 + /** Called when a connection event occurs.
1.65 +
1.66 + @param aConnectionState Connection event */
1.67 + virtual void HandleImapConnectionEvent(TImapConnectionEvent aConnectionState)=0;
1.68 + };
1.69 +
1.70 +#endif