epoc32/include/app/imapconnectionobserver.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
equal deleted inserted replaced
2:2fe1408b6811 3:e1b950c65cb4
       
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // 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
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #if !defined(__IMAPCONNECTIONOBSERVER_H__)
       
    17 #define __IMAPCONNECTIONOBSERVER_H__
       
    18 
       
    19 /** IMAP4 connection observer events.
       
    20 
       
    21 @see MMsvImapConnectionObserver 
       
    22 @publishedAll
       
    23 @released
       
    24 */
       
    25 enum TImapConnectionEvent
       
    26 	{
       
    27 	/** Connecting to server. */
       
    28 	EConnectingToServer,
       
    29 	/** Synchronising folder list. */
       
    30 	ESynchronisingFolderList,
       
    31 	/** Synchronising inbox. */
       
    32 	ESynchronisingInbox,
       
    33 	/** Synchronising folders. */
       
    34 	ESynchronisingFolders,
       
    35 	/** Synchronisation complete. */
       
    36 	ESynchronisationComplete,
       
    37 	/** Disconnecting. */
       
    38 	EDisconnecting,
       
    39 	/** Connection completed. */
       
    40 	EConnectionCompleted
       
    41 	};
       
    42 
       
    43 //	Mix-in class to allow observation of the stages of an IMAP operation
       
    44 //
       
    45 class MMsvImapConnectionObserver
       
    46 /** Abstract base class used for IMAP4 connection observation. 
       
    47 
       
    48 A derived class to handle IMAP4 connection events should override the HandleImapConnectionEvent() 
       
    49 member function. 
       
    50 
       
    51 Objects that implement this interface are passed as a packaged parameter 
       
    52 to CImap4ClientMtm::InvokeAsyncFunctionL() when a connection command is issued.
       
    53  
       
    54 @publishedAll
       
    55 @released
       
    56 
       
    57 @see TImap4Cmds
       
    58 */
       
    59 	{
       
    60 public:
       
    61 	/** Called when a connection event occurs.
       
    62 	
       
    63 	@param aConnectionState Connection event */
       
    64 	virtual void HandleImapConnectionEvent(TImapConnectionEvent aConnectionState)=0;
       
    65 	};
       
    66 
       
    67 #endif