MCL/sf/app/commonemail: comparison emailservices/emailframework/inc/CFSMailPlugin.h

equal deleted inserted replaced

-:dcf0eedfc1a3
+:d189ee25cf9d
 */
 #ifndef CFSFWMAILPLUGIN_H
 #define CFSFWMAILPLUGIN_H
-#include <ecom/ecom.h>
+#include <ecom.h>
-#include "mfsmailrequestobserver.h"
+//<cmail>
-#include "mfsmaileventobserver.h"
+#include "MFSMailRequestObserver.h"
-#include "cfsmailbox.h"
+#include "MFSMailEventObserver.h"
-#include "cfsmailplugin.hrh"
+#include "CFSMailBox.h"
+#include "CFSMailPlugin.hrh"
 #include "cemailextensionbase.h"
+//</cmail>
 // constants
 const TUid KFSMailPluginInterface = { FSMAILPLUGININTERFACE };
 _LIT8( KFSPluginInterfaceImplementationType, "Plug-In Interface / Freestyle Email Framework");
+class MFSMailIterator;
 /**
 *  Freestyle Email Framework Plugin Interface
 *
 *  class MFSMailPlugin defines functions used by email framework
 *  and implemented by plugin implementor.
 *
 *  Plugin implementor inherits from class CFSMailPlugin,
-*  but plugin load medhods are provided by framework in file cfsmailplugin.inl
+*  but plugin load medhods are provided by framework in file CFSMailPlugin.inl
-*  CFSMailPlugin,cfsmailplugin.inl are exported by framework
+*  CFSMailPlugin,CFSMailPlugin.inl are exported by framework
 *
 *  @lib FSFWCommonLib
 *
 */
-class CFSMailPlugin : public CExtendableEmail
+NONSHARABLE_CLASS ( CFSMailPlugin ) : public CExtendableEmail
 {
 public: // Methods
 /**
 * @param aMailBoxId defines mailbox
 * @param aOperationObserver is client provided observer that
 *        will receive progress notifications during the operation.
 * @param aRequestId identifies asynchronous request if parallel
 * requests exist
+* @param aSilentConnection defines if connection is needed to be
+*        silent connection or non-silent one (default).
 */
 virtual void RefreshNowL( const TFSMailMsgId& aMailBoxId,
 MFSMailRequestObserver& aOperationObserver,
-TInt aRequestId ) = 0;
+TInt aRequestId,
+const TBool aSilentConnection=EFalse ) = 0;
 /**
 * Returns last synchronization operation status.
 *
 * @param aMailBoxId mailbox id
 * @param aMessages ids of messages to be deleted
 */
 virtual void DeleteMessagesByUidL( const TFSMailMsgId& aMailBoxId,
 const TFSMailMsgId& aFolderId,
 const RArray<TFSMailMsgId>& aMessages ) = 0;
+// <qmail>
+/**
+* deletes email defined by message id
+*
+* @param aMailBoxId id of the mailbox containing email
+* @param aFolderId email parent folder id
+* @param aMessages ids of messages to be deleted
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+* @return KErrNone if this method is supported, KErrNotSupported if not
+*/
+virtual void DeleteMessagesByUidL( const TFSMailMsgId& aMailBoxId,
+const TFSMailMsgId& aFolderId,
+const RArray<TFSMailMsgId>& aMessages,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId );
+// </qmail>
 /**
 * creates new email template into drafts folder
 *
 * @param aMailBoxId id of the mailbox where new email is created
 * @return email object to be modified by user, ownership is transferred to user
 */
 virtual CFSMailMessage* CreateMessageToSendL( const TFSMailMsgId& aMailBoxId ) = 0;
+// <qmail>
+/**
+* Asynchronous creation of new email template into drafts folder. When the operation
+* finishes, RequestResponseL is called on the observer and the created message is
+* passed along with the TFSProgress data. It is not necessary for a plugin to
+	  * implement this method if using the synchronous version does not cause performance
+	  * problems for the UI or general problems for the application. UI uses these methods
+	  * via an operation class NmMessageCreationOperation (see NmailUiEngine). If a plugin
+	  * doesn't implement this method the operation class automatically selects the
+	  * synchronous version.
+*
+* @param aMailBoxId id of the mailbox where new email is created
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+	  * @return KErrNone if this method is supported, KErrNotSupported if not
+*/
+virtual void CreateMessageToSendL(
+	     const TFSMailMsgId& aMailBoxId,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId );
+// </qmail>
 /**
 * creates new email template to drafts folder to be forwarded
 *
 * @param aMailBoxId id of the mailbox where new email is created
 * @return email object to be modified by user, ownership is transferred to user
 */
 virtual CFSMailMessage* CreateForwardMessageL( const TFSMailMsgId& aMailBoxId,
 const TFSMailMsgId& aOriginalMessageId,
 const TDesC& aHeaderDescriptor = KNullDesC ) = 0;
+// <qmail>
+/**
+* Asynchronous creation of new forwarded email into drafts folder. When the operation
+* finishes, RequestResponseL is called on the observer and the created message is
+* passed along with the TFSProgress data.
+*
+* @param aMailBoxId id of the mailbox where new email is created
+* @param aOriginalMessageId if of the (original) message,which is forwarded
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+* @param aHeaderDescriptor user can give quote headers data to plugin as
+*  parameter if needed
+* @return email object to be modified by user, ownership is transferred to user
+*/
+virtual void CreateForwardMessageL( const TFSMailMsgId& aMailBoxId,
+const TFSMailMsgId& aOriginalMessageId,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId,
+const TDesC& aHeaderDescriptor = KNullDesC );
+// </qmail>
 /**
 * creates new email template to drafts folder to be replied
 *
 * @param aMailBoxId id of the mailbox where new email is created
 virtual CFSMailMessage* CreateReplyMessageL( const TFSMailMsgId& aMailBoxId,
 const TFSMailMsgId& aOriginalMessageId,
 const TBool aReplyToAll,
 const TDesC& aHeaderDescriptor = KNullDesC) = 0;
+// <qmail>
+/**
+* Asynchronous creation of new mail template to drafts folder to be replied. When the operation
+* finishes, RequestResponseL is called on the observer and the created message is
+* passed along with the TFSProgress data.
+*
+* @param aMailBoxId id of the mailbox where new email is created
+* @param aOriginalMessageId id of original email,which is replied to
+* @param aReplyToAll true if reply to all is wanted
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+* @param aHeaderDescriptor user can give quote headers data to plugin as
+*        parameter if needed
+*
+* @return email object to be modified by user, ownership is transferred to user
+*/
+virtual void CreateReplyMessageL( const TFSMailMsgId& aMailBoxId,
+const TFSMailMsgId& aOriginalMessageId,
+const TBool aReplyToAll,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId,
+const TDesC& aHeaderDescriptor = KNullDesC);
+// </qmail>
 /**
 * stores email object data to message store after modifications (commit)
 *
 * @param aMailBoxId id of the mailbox where email is stored
 * @param aMessage email data to be stored by plugin
 */
 virtual void StoreMessageL( const TFSMailMsgId& aMailBoxId,
 CFSMailMessage& aMessage ) = 0;
+// <qmail>
+/**
+* Asynchronous message storing
+*
+* @param aMailBoxId id of the mailbox where the messages are
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+*/
+virtual void StoreMessagesL(
+const TFSMailMsgId& aMailBoxId,
+RPointerArray<CFSMailMessage> &messages,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId ) = 0;
+// </qmail>
 /**
 * starts email fetching from email server
 *
 * @param aMailBoxId id of the mailbox where email is located
 * @param aFolderId id of the parent folder containing email
 const TFSMailMsgId& aMessageId,
 const TFSMailMsgId& aParentPartId,
 const TDesC& aContentType,
 const TDesC& aFilePath) = 0;
+// <qmail>
-/**
+	    /**
-* Creates and adds a new child part from file to given email part.
+	     * Creates and adds a new child part from file to given email part.
-*
+	     *
-* @param aMailBoxId id of the mailbox where parent part is located
+	     * @param aMailBoxId id of the mailbox where parent part is located
-* @param aParentFolderId id of the parent folder where email is located
+	     * @param aParentFolderId id of the parent folder where email is located
-* @param aMessageId id of the email parent part belongs to
+	     * @param aMessageId id of the email parent part belongs to
-* @param aParentPartId id of the parent part of the new part
+	     * @param aParentPartId id of the parent part of the new part
-* @param aInsertBefore id of existing part that new part should precede.
+	     * @param aInsertBefore id of existing part that new part should precede.
-* If aInsertBefore is NULL id then new part is added as last.
+	     * If aInsertBefore is NULL id then new part is added as last.
-* @param aContentType content type of the new message part
+	     * @param aContentType content type of the new message part
-* @param aFile access to file containing new child part contents,
+	     * @param aFilePath file containing new child part contents
-*  ownership is transferred
+* @param aOperationObserver Observer for the operation
-*
+* @param aRequestId id of the operation
-* return new child part object, ownership is transferred to user
+	     *
-*/
+	     * return new child part object, ownership is transferred to user
-virtual CFSMailMessagePart* NewChildPartFromFileL( const TFSMailMsgId& aMailBoxId,
+	     */
-const TFSMailMsgId& aParentFolderId,
+virtual void NewChildPartFromFileL( const TFSMailMsgId& aMailBoxId,
-const TFSMailMsgId& aMessageId,
+	                                        const TFSMailMsgId& aParentFolderId,
-const TFSMailMsgId& aParentPartId,
+	                                        const TFSMailMsgId& aMessageId,
-const TDesC& aContentType,
+	                                        const TFSMailMsgId& aParentPartId,
-RFile& aFile ) = 0;
+	                                        const TDesC& aContentType,
+	                                        const TDesC& aFilePath,
+	                                        MFSMailRequestObserver& aOperationObserver,
+	                                        const TInt aRequestId );
+// </qmail>
+	 /**
+	  * Creates and adds a new child part from file to given email part.
+	  *
+	  * @param aMailBoxId id of the mailbox where parent part is located
+	  * @param aParentFolderId id of the parent folder where email is located
+	  * @param aMessageId id of the email parent part belongs to
+	  * @param aParentPartId id of the parent part of the new part
+	  * @param aInsertBefore id of existing part that new part should precede.
+	  * If aInsertBefore is NULL id then new part is added as last.
+	  * @param aContentType content type of the new message part
+	  * @param aFile access to file containing new child part contents,
+	  *  ownership is transferred
+	  *
+	  * return new child part object, ownership is transferred to user
+	  */
+	  virtual CFSMailMessagePart* NewChildPartFromFileL( const TFSMailMsgId& aMailBoxId,
+	                                                     const TFSMailMsgId& aParentFolderId,
+	                                                     const TFSMailMsgId& aMessageId,
+	                                                     const TFSMailMsgId& aParentPartId,
+	                                                     const TDesC& aContentType,
+	                                                     RFile& aFile ) = 0;
 /**
 * Copies given email as new child part to given email part.
 *
 const TFSMailMsgId& aParentFolderId,
 const TFSMailMsgId& aMessageId,
 const TFSMailMsgId& aParentPartId,
 const TFSMailMsgId& aPartId) = 0;
+// <qmail>
+/**
+* Removes child part (and its children, if any) from given email part
+*
+* @param aMailBoxId id of the mailbox where email is located
+* @param aParentFolderId id of the parent folder where email is located
+* @param aMessageId id of the email parent part belongs to
+* @param aParentPartId id of the parent of the part
+* @param aPartId id of the part to removed
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+*/
+virtual void RemoveChildPartL( const TFSMailMsgId& aMailBoxId,
+const TFSMailMsgId& aParentFolderId,
+const TFSMailMsgId& aMessageId,
+const TFSMailMsgId& aParentPartId,
+const TFSMailMsgId& aPartId,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId);
+// </qmail>
 /**
 * Returns given message part. Ownership of object is transferred to caller.
 *
 * @param aMailBoxId id of the mailbox where email is located
 * @param aParentFolderId id of the parent folder where email is located
 */
 virtual void StoreMessagePartL( const TFSMailMsgId& aMailBoxId,
 const TFSMailMsgId& aParentFolderId,
 const TFSMailMsgId& aMessageId,
 CFSMailMessagePart& aMessagePart) = 0;
+// <qmail>
+/**
+* Asynchronous message parts storing
+*
+* @param aMessagePart email parts data to be stored
+* @param aOperationObserver Observer for the operation
+* @param aRequestId id of the operation
+*/
+virtual void StoreMessagePartsL( RPointerArray<CFSMailMessagePart>& aMessagePart,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId ) = 0;
+// <//qmail>
 /**
 * unregisters request observer to cancel pending events
 *
 * @param aRequestId request id of the pending asynchronous request
 * cancellation is deleting the message from outbox.
 *
 * @param aMessage email to be sent
 */
 virtual void SendMessageL( CFSMailMessage& aMessage ) = 0;
+// <qmail>
+/**
+* Launches email sending in plugin,
+* @param aMessage email to be sent
+* @param aOperationObserver Operation observer
+* @param aRequestId Request id
+*/
+virtual void SendMessageL( CFSMailMessage& aMessage,
+MFSMailRequestObserver& aOperationObserver,
+const TInt aRequestId );
+// </qmail>
 /**
 * Returns pending asynchronous request status, request is identified
 * by request id if parallel requests exists
 *
 */
 virtual void PrepareMrDescriptionL( const TFSMailMsgId& /*aMailBoxId*/,
 const TFSMailMsgId& /*aMessageId*/ )
 { return; };
+/**
+* Gets the signature for the given mailbox. Returns NULL if there is no signature defined for
+* the given mailbox.
+*
+* @param aMailboxId mailbox id
+*/
+virtual HBufC* GetSignatureL( const TFSMailMsgId& aMailBoxId );
 protected:
 /**
 * C++ default constructor.
 */
 TUid        iDtor_ID_Key;
 };
 //<cmail>
-#include "cfsmailplugin.inl"
+#include "CFSMailPlugin.inl"
 //</cmail>
 #endif // CFSFW_MAIL_PLUGIN_H
 // End of File

branch	RCL_3
changeset 24	d189ee25cf9d
parent 22	d620048b4810
child 25	3533d4323edc