diff -r 139d4b7b2938 -r 99bcbff212ad emailservices/emailcommon/inc/cmailboxstateext.h
--- a/emailservices/emailcommon/inc/cmailboxstateext.h Mon May 24 21:02:02 2010 +0300
+++ b/emailservices/emailcommon/inc/cmailboxstateext.h Fri May 28 13:56:43 2010 +0300
@@ -1,5 +1,5 @@
/*
-* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* Copyright (c) 2009 - 2010 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"
@@ -11,7 +11,8 @@
*
* Contributors:
*
-* Description: Message extension interface
+* Description: Mailbox state extension for notifying email protocol plugins
+* about application state changes.
*
*/
@@ -30,16 +31,21 @@
class MEmailMailboxState
{
public:
+//
/**
* Returns currently active folder and related mailbox that
* is currently being used.
- * @param aActiveMailboxId id of currently active mailbox
+ * @param aActiveMailboxId id of currently active mailbox
+ *
* @param aActiveFolderId id of currently active mail folder
+ * If aActiveFolderId.IsNullId() returns true there is no active
+ * folder. This happens if e.g. email applications is closed.
* @return Symbian OS error code
*/
virtual TInt GetActiveFolderId(
TFSMailMsgId& aActiveMailboxId,
TFSMailMsgId& aActiveFolderId ) const = 0;
+//
};
/**
@@ -50,10 +56,21 @@
public:
/**
- * Sets data provider interface
- * @param aDataProvider data provider
+ * Sets data provider interface.
+ * @param aDataProvider data provider.
*/
virtual void SetStateDataProvider( MEmailMailboxState* aDataProvider ) = 0;
+//
+ /**
+ * Notification that folder has changed in email application.
+ * @param aActiveMailboxId id of the mailbox container the folder
+ * @param aActiveFolderId currently active folder id or null id if
+ * there's currently no active folder (e.g. application is closed)
+ */
+ virtual void NotifyActiveFolderChanged(
+ const TFSMailMsgId& aActiveMailboxId,
+ const TFSMailMsgId& aActiveFolderId) = 0;
+//
protected:
inline CMailboxStateExtension();
@@ -66,5 +83,5 @@
CEmailExtension( KEmailMailboxStateExtensionUid )
{
}
-
+
#endif // CMAILBOXSTATEEXT_H