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