emailservices/emailframework/commonlib/inc/CFSMailFolder.h
changeset 4 e7aa27f58ae1
parent 0 8466d47a6819
child 8 e1b6206813b4
equal deleted inserted replaced
3:a4d6f1ea0416 4:e7aa27f58ae1
    17 
    17 
    18 
    18 
    19 #ifndef __FSMAILFOLDER_H
    19 #ifndef __FSMAILFOLDER_H
    20 #define __FSMAILFOLDER_H
    20 #define __FSMAILFOLDER_H
    21 
    21 
    22 #include "cfsmailfolderbase.h"
    22 #include "CFsMailFolderBase.h"
    23 #include "mfsmailiterator.h"
    23 #include "mfsmailiterator.h"
    24 
    24 
    25 // forward declarations
    25 // forward declarations
    26 class CFSMailIterator;
    26 class CFSMailIterator;
    27 
    27 
    32  *  @since S60 S60 v3.1
    32  *  @since S60 S60 v3.1
    33  */
    33  */
    34 class CFSMailFolder : public CFSMailFolderBase
    34 class CFSMailFolder : public CFSMailFolderBase
    35 {
    35 {
    36  public:
    36  public:
    37   	  
    37       
    38     /**
    38     /**
    39      * Two-phased constructor.
    39      * Two-phased constructor.
    40      *
    40      *
    41      * @param aFolderId folder id in plugin containing folder
    41      * @param aFolderId folder id in plugin containing folder
    42      */
    42      */
    43      IMPORT_C static CFSMailFolder* NewL( TFSMailMsgId aFolderId );
    43      IMPORT_C static CFSMailFolder* NewL( TFSMailMsgId aFolderId );
    44   	
    44     
    45     /**
    45     /**
    46      * Two-phased constructor.
    46      * Two-phased constructor.
    47      *
    47      *
    48      * @param aFolderId folder id in plugin containing folder
    48      * @param aFolderId folder id in plugin containing folder
    49      */
    49      */
    63      *        First item in array is primary sort criteria.
    63      *        First item in array is primary sort criteria.
    64      *
    64      *
    65      * @return email list iterator, ownership is transferred to user
    65      * @return email list iterator, ownership is transferred to user
    66      */
    66      */
    67      IMPORT_C MFSMailIterator* ListMessagesL(
    67      IMPORT_C MFSMailIterator* ListMessagesL(
    68         						const TFSMailDetails aDetails,
    68                                 const TFSMailDetails aDetails,
    69         						const RArray<TFSMailSortCriteria>& aSorting);
    69                                 const RArray<TFSMailSortCriteria>& aSorting);
    70     /**
    70     /**
    71      * removes given message from folder
    71      * removes given message from folder
    72      *
    72      *
    73      * @param aMessageId id of message to be removed
    73      * @param aMessageId id of message to be removed
    74      */
    74      */
    77     /**
    77     /**
    78      * lists subfolders contained by this folder
    78      * lists subfolders contained by this folder
    79      *
    79      *
    80      * @param aSubFolderList list of subfolders
    80      * @param aSubFolderList list of subfolders
    81      */
    81      */
    82   	 IMPORT_C void GetSubFoldersL(RPointerArray<CFSMailFolder>& aSubFolders);
    82      IMPORT_C void GetSubFoldersL(RPointerArray<CFSMailFolder>& aSubFolders);
    83 
    83 
    84     /**
    84     /**
    85      * method launches fetching of messages given by user from server
    85      * method launches fetching of messages given by user from server
    86      *
    86      *
    87      * @param aMessageIds ids of messages to be fetched
    87      * @param aMessageIds ids of messages to be fetched
    88      * @param aDetails defines which details each message contains
    88      * @param aDetails defines which details each message contains
    89      * @param aObserver request observer for conveying fetching progress
    89      * @param aObserver request observer for conveying fetching progress
    90      *  events to user
    90      *  events to user
    91      */
    91      */
    92 	 IMPORT_C TInt FetchMessagesL( 	const RArray<TFSMailMsgId>& aMessageIds,
    92      IMPORT_C TInt FetchMessagesL(  const RArray<TFSMailMsgId>& aMessageIds,
    93      				 				TFSMailDetails aDetails,
    93                                     TFSMailDetails aDetails,
    94      				 				MFSMailRequestObserver& aObserver );
    94                                     MFSMailRequestObserver& aObserver );
    95     /**
    95     /**
    96      * method to check if this folder allows copying from given folder type
    96      * method to check if this folder allows copying from given folder type
    97      *
    97      *
    98      * @param aFolderType folder type
    98      * @param aFolderType folder type
    99      */
    99      */
   126  protected:
   126  protected:
   127 
   127 
   128     /**
   128     /**
   129      * C++ default constructor.
   129      * C++ default constructor.
   130      */
   130      */
   131   	 CFSMailFolder();
   131      CFSMailFolder();
   132 
   132 
   133 private:
   133 private:
   134 
   134 
   135   	/**
   135     /**
   136      * Two-phased constructor
   136      * Two-phased constructor
   137      */
   137      */
   138 	void ConstructL( TFSMailMsgId aFolderId );
   138     void ConstructL( TFSMailMsgId aFolderId );
   139 
   139 
   140 private: // data
   140 private: // data
   141 
   141 
   142     /**
   142     /**
   143      * request handler for plugin requests
   143      * request handler for plugin requests
   144      */
   144      */
   145 	 CFSMailRequestHandler* 	iRequestHandler;	
   145      CFSMailRequestHandler*     iRequestHandler;    
   146 
   146 
   147 };
   147 };
   148 
   148 
   149 #endif
   149 #endif