/*

* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:  Email Interface base implementation header file.

*

*/

#ifndef __BASEPLUGIN_H__

#define __BASEPLUGIN_H__

#include <e32std.h>

#include <e32base.h>

#include "mmrorganizer.h"

//<cmail>

//</cmail>

class CMsgStore;

class CBaseMrInfoProcessor;

class TDayOfWeekFtor;

class CFetchRequester;

class CMailboxInfo;

class CSearchHandler;

class HMailIterator;

class CDelayedOpsManager;

class MDelayedOpsManager;

/**

 * Notes for derived classes:

 * GetPluginId - you must override this to return the ECOM id of the plugin.

 */

class CBasePlugin :

    public CFSMailPlugin,

    public MMsgStoreObserver,

    protected MMsgStoreMailBoxObserver

    {

    friend class HMailIterator;

    friend class CBaseMrInfoProcessor;

    friend class CMailboxInfo;

    friend class CSearchHandler;

    //there is a need for a better way to access internal plugin state by

    //private components.

    friend class CDelayedDeleteMessagesOp;

    friend class CDelayedSetContentOp;

	protected:

    struct TOngoingFetchInfo;

    struct TCacheLine

        {

        CMsgStoreMessage* iMsg;

        CMsgStoreMessagePart* iBody;

        RPointerArray<CMsgStoreMessagePart> iMsgChildren;

        RPointerArray<CMsgStoreMessagePart> iBodyChildren;

        };

    public:

        static CBasePlugin* NewL();

        static CBasePlugin* NewLC();

        IMPORT_C virtual ~CBasePlugin();

    protected:

        IMPORT_C CBasePlugin();

        IMPORT_C void ConstructL();

    // CFSMailPlugin //

    public:

        IMPORT_C virtual void ListMailBoxesL(

            RArray<TFSMailMsgId>& aMailboxes );

        IMPORT_C virtual CFSMailBox* GetMailBoxByUidL(

            const TFSMailMsgId& aMailBox);

	    IMPORT_C virtual void DeleteMailBoxByUidL(

	        const TFSMailMsgId& aMailBoxId,

	        MFSMailRequestObserver& aOperationObserver,

			const TInt aRequestId );

        IMPORT_C virtual TDesC& GetBrandingIdL(

            const TFSMailMsgId& aMailboxId );

        IMPORT_C virtual void MoveMessagesL(

            const TFSMailMsgId& aMailBoxId,

            const RArray<TFSMailMsgId>& aMessageIds,

            const TFSMailMsgId& aSourceFolderId,

            const TFSMailMsgId& aDestinationFolderId );

        IMPORT_C virtual void CopyMessagesL(

            const TFSMailMsgId& aMailBoxId,

            const RArray<TFSMailMsgId>& aMessageIds,

            RArray<TFSMailMsgId>& aNewMessages,

            const TFSMailMsgId& aSourceFolderId,

            const TFSMailMsgId& aDestinationFolderId );

        IMPORT_C MDesCArray* GetMrusL(

            const TFSMailMsgId& aMailBoxId );

        IMPORT_C void SetMrusL(

            const TFSMailMsgId& aMailBoxId,

            MDesCArray* aNewMruList );

        IMPORT_C void GoOnlineL(

            const TFSMailMsgId& aMailBoxId );

        IMPORT_C void GoOfflineL(

            const TFSMailMsgId& aMailBoxId );

        IMPORT_C const TFSProgress GetLastSyncStatusL(

            const TFSMailMsgId& aMailBoxId );

        IMPORT_C void RefreshNowL(

            const TFSMailMsgId& aMailBoxId,

         	MFSMailRequestObserver& aOperationObserver,

         	TInt aRequestId );

        IMPORT_C virtual CFSMailFolder* GetFolderByUidL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId );

        IMPORT_C virtual CFSMailFolder* CreateFolderL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            const TDesC& aFolderName,

            const TBool aSync );

        IMPORT_C virtual void DeleteFolderByUidL(

            const TFSMailMsgId& aMailBox,

            const TFSMailMsgId& aFolder );

        IMPORT_C virtual void ListFoldersL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            RPointerArray<CFSMailFolder>& aFolderList );

        IMPORT_C virtual void ListFoldersL(

            const TFSMailMsgId& aMailBoxId,

            RPointerArray<CFSMailFolder>& aFolderList );

        IMPORT_C virtual TFSMailMsgId GetStandardFolderIdL(

            const TFSMailMsgId& aMailBoxId,

            const TFSFolderType aFolderType );

        IMPORT_C virtual MFSMailIterator* ListMessagesL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            const TFSMailDetails aDetails,

            const RArray<TFSMailSortCriteria>& aSorting );

        IMPORT_C virtual CFSMailMessage* GetMessageByUidL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailDetails aDetails );

        /**

         * The delete is executed asynchronously. The base plugin will queue

         * the request and return immediately.

         */

        IMPORT_C virtual void DeleteMessagesByUidL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            const RArray<TFSMailMsgId>& aMessages );

        IMPORT_C virtual CFSMailMessage* CreateMessageToSendL(

            const TFSMailMsgId& aMailBox );

        IMPORT_C virtual CFSMailMessage* CreateForwardMessageL(

            const TFSMailMsgId& aMailBox,

            const TFSMailMsgId& aOriginal,

            const TDesC& aHeaderDescriptor );

        IMPORT_C virtual CFSMailMessage* CreateReplyMessageL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aOriginalMessageId,

            const TBool aReplyToAll,

            const TDesC& aHeaderDescriptor );

        IMPORT_C virtual void StoreMessageL(

            const TFSMailMsgId& aMailBoxId,

            CFSMailMessage& aMessage );

        IMPORT_C virtual void FetchMessagesL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aFolderId,

            const RArray<TFSMailMsgId>& aMessageIds,

            TFSMailDetails aDetails,

            MFSMailRequestObserver& aObserver,

            TInt aRequestId );

        IMPORT_C virtual void FetchMessagePartsL(

            const TFSMailMsgId& aMailBoxId,

     		const TFSMailMsgId& aFolderId,

     		const TFSMailMsgId& aMessageId,

     		const RArray<TFSMailMsgId>& aMessagePartIds,

        	MFSMailRequestObserver& aOperationObserver,

			const TInt aRequestId,

        	const TUint aPreferredByteCount );

        IMPORT_C virtual void GetMessagesL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const RArray<TFSMailMsgId>& aMessageIds,

            RPointerArray<CFSMailMessage>& aMessageList,

            TFSMailDetails aDetails );

        IMPORT_C virtual void ChildPartsL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

			const TFSMailMsgId& aMessageId,

     		const TFSMailMsgId& aParentId,

     		RPointerArray<CFSMailMessagePart>& aParts );

        IMPORT_C virtual CFSMailMessagePart* NewChildPartL(

            const TFSMailMsgId& aMailBoxId,

        	const TFSMailMsgId& aParentFolderId,

			const TFSMailMsgId& aMessageId,

     		const TFSMailMsgId& aParentPartId,

        	const TFSMailMsgId& aInsertBefore,

        	const TDesC& aContentType );

        IMPORT_C virtual CFSMailMessagePart* CopyMessageAsChildPartL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

			const TFSMailMsgId& aMessageId,

        	const TFSMailMsgId& aParentPartId,

        	const TFSMailMsgId& aInsertBefore,

        	const CFSMailMessage& aMessage );

        IMPORT_C virtual void RemoveChildPartL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

        	const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aParentPartId,

            const TFSMailMsgId& aPartId );

        IMPORT_C virtual void SetPartContentFromFileL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aMessagePartId,

            const TDesC& aFilePath );

        IMPORT_C virtual void StoreMessagePartL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

         	const TFSMailMsgId& aMessageId,

         	CFSMailMessagePart& aMessagePart );

        IMPORT_C virtual CFSMailMessagePart* MessagePartL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aMessagePartId );

        IMPORT_C virtual TInt GetMessagePartFileL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aMessagePartId,

            RFile& aFileHandle );

        IMPORT_C virtual void CopyMessagePartFileL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aMessagePartId,

            const TDesC& aFilePath );

	    IMPORT_C virtual void GetContentToBufferL(

	        const TFSMailMsgId& aMailBoxId,

	        const TFSMailMsgId& aParentFolderId,

	 		const TFSMailMsgId& aMessageId,

	 		const TFSMailMsgId& aMessagePartId,

	 		TDes& aBuffer,

	 		TUint aStartOffset );

	    IMPORT_C virtual void SetContentL(

	        const TDesC& aBuffer,

	        const TFSMailMsgId& aMailBoxId,

	        const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const TFSMailMsgId& aMessagePartId);

        IMPORT_C virtual void RemovePartContentL(

            const TFSMailMsgId& aMailBoxId,

            const TFSMailMsgId& aParentFolderId,

            const TFSMailMsgId& aMessageId,

            const RArray<TFSMailMsgId>& aPartIds );

	    IMPORT_C virtual void SearchL(

	        const TFSMailMsgId& aMailBoxId,

			const RArray<TFSMailMsgId>& aFolderIds,

			const RPointerArray<TDesC>& aSearchStrings,

			const TFSMailSortCriteria& aSortCriteria,

			MFSMailBoxSearchObserver& aSearchObserver );

    	IMPORT_C virtual void CancelSearch(

    	    const TFSMailMsgId& aMailBoxId );

        IMPORT_C virtual void ClearSearchResultCache(

            const TFSMailMsgId& aMailBoxId );

        IMPORT_C virtual void AddObserverL(

            MFSMailEventObserver& aObserver );

        IMPORT_C virtual void RemoveObserver(

            MFSMailEventObserver& aObserver );

        IMPORT_C virtual void UnregisterRequestObserver(

            TInt aRequestId );

        IMPORT_C virtual void SendMessageL(

            CFSMailMessage& aMessage );

        IMPORT_C virtual TFSProgress StatusL(

            TInt aRequestId );

        IMPORT_C virtual void CancelL(

            TInt aRequestId );

        IMPORT_C virtual void SubscribeMailboxEventsL(

            const TFSMailMsgId& aMailboxId,

            MFSMailEventObserver& aObserver );

        IMPORT_C virtual void UnsubscribeMailboxEvents(

            const TFSMailMsgId& aMailboxId,

            MFSMailEventObserver& aObserver );

        IMPORT_C virtual TSSMailSyncState CurrentSyncState(

            const TFSMailMsgId& aMailboxId );

        IMPORT_C virtual TFSMailBoxStatus GetMailBoxStatus(

            const TFSMailMsgId& aMailboxId );

        IMPORT_C virtual TBool MailboxHasCapabilityL(

            TFSMailBoxCapabilities aCapability,

	 		TFSMailMsgId aMailBoxId );

	    /**

	     * Create a new ChildPart using a file path

	     */

	    IMPORT_C virtual CFSMailMessagePart* NewChildPartFromFileL(

		    const TFSMailMsgId& aMailBoxId,

		    const TFSMailMsgId& aParentFolderId,

		    const TFSMailMsgId& aMessageId,

		    const TFSMailMsgId& aParentPartId,

			const TDesC& aContentType,

		    const TDesC& aFilePath );

	    /**

	     * Create a new ChildPart using a file handle

         *  NOTE 1: RFs.ShareProtected() must have been called already before calling this method.

         *  NOTE 2: The ownersip of the RFile handle (aFile) is transferred to this method.

	     */

	    IMPORT_C virtual CFSMailMessagePart* NewChildPartFromFileL(

		    const TFSMailMsgId& aMailBoxId,

		    const TFSMailMsgId& aParentFolderId,

		    const TFSMailMsgId& aMessageId,

		    const TFSMailMsgId& aParentPartId,

			const TDesC& aContentType,

		    RFile& aFile );

        IMPORT_C virtual TInt WizardDataAvailableL();

        IMPORT_C virtual void AuthenticateL(

            MFSMailRequestObserver& aOperationObserver,

            TInt aRequestId );

        IMPORT_C virtual void SetCredentialsL(

            const TFSMailMsgId& aMailBoxId,

            const TDesC& aUsername,

            const TDesC& aPassword );

        IMPORT_C virtual TInt CancelSyncL(

        	const TFSMailMsgId& aMailBoxId );

        IMPORT_C virtual void SetMailboxName(

            const TFSMailMsgId& /*aMailboxId*/,

            const TDesC& /*aMailboxName*/ );

    // MMsgStoreObserver //

    public:

        IMPORT_C virtual void SystemEventNotify(

            TMsgStoreSystemEvent aEvent );

        IMPORT_C virtual void AccountEventNotify(

            TMsgStoreAccountEvent aEvent,

    		TInt32 aOwnerId,

            const TDesC& aName,

    		const TDesC& aNewName,

    		TMsgStoreId aMailboxId );

        IMPORT_C virtual void ModificationNotify(

            TMsgStoreId aMailBoxId,

            TMsgStoreOperation aOperation,

            TMsgStoreContainerType aType,

            TUint32 aFlags,

            TMsgStoreId aId,

            TMsgStoreId aParentId,

            TMsgStoreId aOtherId );

    protected:

        IMPORT_C CFSMailAddress* FetchEmailAddressL(

            CMsgStorePropertyContainer& aMessage,

            TUint aIdx );

        IMPORT_C CMailboxInfo& GetMailboxInfoL(

            TMsgStoreId aId );

        void GetMailboxDisplayNameL(

            TMsgStoreId aId,

            RBuf& aDisplayName );

        IMPORT_C virtual TUint GetPluginId();

        /**

         * Get signature string from protocol specific subclass.

         * Caller is responsible for memory of returned string.

         */

        virtual HBufC* GetSignatureL( TFSMailMsgId /* aMailBox */ )

        	{

        	return NULL;

        	}

        /**

         * Get reply-to address from protocol specific subclass.

         * Caller is responsible for memory of returned string.

         */

        virtual HBufC* GetReplyToAddressL( TFSMailMsgId /* aMailBox */ )

            {

            return NULL;

            }

        /**

         * Get MailBox address from protocol specific subclass.

         * Caller is responsible for memory of returned string.

         */

        virtual HBufC* GetMailBoxAddressL( TFSMailMsgId /*aMailBox*/ )

            {

            return NULL;

            }

        IMPORT_C virtual void TranslateMsgStorePropsL(

            const TFSMailMsgId& aMailBoxId,

            CMsgStorePropertyContainer& aMessage,

            CFSMailMessagePart& aFsMsg,

            const TFSMailDetails aDetails = EFSMsgDataEnvelope );

        /**

         * Translates common message store meeting requests into Freestyle mr info

         * objects.

         * Sync plugins might be interested in extending the default behavior.

         */

        IMPORT_C virtual void TranslateMsgStoreMrL(

            const TFSMailMsgId& aMailBoxId,

            CMsgStorePropertyContainer& aMessage,

            CMsgStorePropertyContainer& aCalendar,

            CFSMailMessagePart& aFsMsg );

        /**

         * Translates a message in Freestyle format to the common Message Store

         * format. Does not store the destination's properties in the msgstore.

         * The caller must call StorePropertiesL when necessary. This way writes

         * to the message store can be minimized.

         *

         * @param aSrc input/source Freestyle message.

         * @param aDst output/destination MessageStore message.

         */

        IMPORT_C virtual void TranslateEmailFwMessageL(

            CFSMailMessagePart& aSrc,

            CMsgStoreMessagePart& aDst,

            TBool aInInbox );

        IMPORT_C virtual void TranslateEmailFwMrL(

            MMRInfoObject& aSrc,

            CMsgStorePropertyContainer& aDst );

        IMPORT_C void TranslateEmailFwAttendeeL(

            MMROrganizer& aSrc,

            RMsgStoreAddress& aDst );

        void DoListFoldersL(

            TFSMailMsgId aMailBoxId,

            TMsgStoreId aFolderId,

            TBool aRecursive,

            RPointerArray<CFSMailFolder>& aFolderList );

        void NotifyEventL(

            TMsgStoreId aMailBoxId,

            TMsgStoreId aId,

            TMsgStoreId aParentId,

            TFSMailEvent aFsEvent,

            TMsgStoreId aOtherId = KMsgStoreInvalidId );

        void NotifyGlobalEventL(

            TFSMailEvent aEvent,

            TFSMailMsgId aMailBox = TFSMailMsgId(),

            TAny* aParam1 = NULL,

            TAny* aParam2 = NULL,

            TAny* aParam3 = NULL );