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