emailservices/emailclientapi/src/emailfolder.cpp
changeset 54 997a02608b3a
child 62 a8c646b56683
equal deleted inserted replaced
53:bf7eb7911fc5 54:997a02608b3a
       
     1 /*
       
     2 * Copyright (c)2010 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description: This file implements class CEmailFolder.
       
    15 *
       
    16 */
       
    17 
       
    18 #include "emailfolder.h"
       
    19 #include "emailmailbox.h"
       
    20 #include "emailapiutils.h"
       
    21 #include "messageiterator.h"
       
    22 #include "emailsorting.h"
       
    23 #include "cfsmailfolder.h"
       
    24 #include "cfsmailplugin.h"
       
    25 #include "emailclientapi.hrh"
       
    26 #include "emailclientapiimpldefs.h"
       
    27 
       
    28 // -----------------------------------------------------------------------------
       
    29 // 
       
    30 // -----------------------------------------------------------------------------
       
    31 CEmailFolder* CEmailFolder::NewLC( 
       
    32     CPluginData& aPluginData,
       
    33     const TFolderId& aFolderId,  
       
    34     CFSMailFolder *aFolder )
       
    35     {
       
    36     CEmailFolder* self = new ( ELeave ) 
       
    37         CEmailFolder( aPluginData, aFolderId, aFolder );
       
    38     CleanupStack::PushL( self );
       
    39     self->ConstructL();
       
    40     return self;
       
    41     }
       
    42 
       
    43 // -----------------------------------------------------------------------------
       
    44 // 
       
    45 // -----------------------------------------------------------------------------
       
    46 CEmailFolder* CEmailFolder::NewL( 
       
    47     CPluginData& aPluginData,
       
    48     const TFolderId& aFolderId,  
       
    49     CFSMailFolder *aFolder )
       
    50     {
       
    51     CEmailFolder* self = CEmailFolder::NewLC( aPluginData, aFolderId, aFolder);
       
    52     CleanupStack::Pop( self );
       
    53     return self;
       
    54     }
       
    55 
       
    56 // -----------------------------------------------------------------------------
       
    57 // 
       
    58 // -----------------------------------------------------------------------------
       
    59 CEmailFolder::CEmailFolder( 
       
    60     CPluginData& aPluginData, 
       
    61     const TFolderId& aFolderId,
       
    62     CFSMailFolder* aFolder) : 
       
    63     iPluginData( aPluginData ), 
       
    64     iFolderType( EOther ), 
       
    65     iFolderId( aFolderId ),
       
    66     iFolder( aFolder )
       
    67     {
       
    68     }
       
    69    
       
    70 
       
    71 // -----------------------------------------------------------------------------
       
    72 // 
       
    73 // -----------------------------------------------------------------------------
       
    74 void CEmailFolder::ConstructL()
       
    75     {
       
    76     iPlugin = iPluginData.ClaimInstance();
       
    77     
       
    78     User::LeaveIfNull( iFolder );
       
    79     
       
    80     const TFSFolderType fsType = iFolder->GetFolderType();
       
    81     switch ( fsType )
       
    82         {
       
    83         case EFSInbox:
       
    84             iFolderType = EInbox;
       
    85             break;
       
    86         case EFSOutbox:
       
    87             iFolderType = EOutbox;
       
    88             break;
       
    89         case EFSDraftsFolder:
       
    90             iFolderType = EDrafts;
       
    91             break;
       
    92         case EFSSentFolder:
       
    93             iFolderType = ESent;
       
    94             break;
       
    95         case EFSDeleted:
       
    96             iFolderType = EDeleted;
       
    97             break;
       
    98         case EFSOther:
       
    99         default:
       
   100             iFolderType = EOther;
       
   101             break;
       
   102         }
       
   103     iParentId = TFolderId( 
       
   104         iFolder->GetParentFolderId().Id(), 
       
   105         iFolderId.iMailboxId );
       
   106     }
       
   107 
       
   108 // -----------------------------------------------------------------------------
       
   109 // 
       
   110 // -----------------------------------------------------------------------------
       
   111 CEmailFolder::~CEmailFolder()
       
   112     {
       
   113     iPluginData.ReleaseInstance();
       
   114     delete iFolder;
       
   115     }
       
   116 
       
   117 // -----------------------------------------------------------------------------
       
   118 // 
       
   119 // -----------------------------------------------------------------------------
       
   120 TEmailTypeId CEmailFolder::InterfaceId() const
       
   121     {
       
   122     return KEmailIFUidFolder;
       
   123     }
       
   124 
       
   125 // -----------------------------------------------------------------------------
       
   126 // 
       
   127 // -----------------------------------------------------------------------------
       
   128 void CEmailFolder::Release()
       
   129     {
       
   130     delete this;
       
   131     }
       
   132 
       
   133 // -----------------------------------------------------------------------------
       
   134 // 
       
   135 // -----------------------------------------------------------------------------
       
   136 TFolderId CEmailFolder::FolderId() const
       
   137     {
       
   138     return iFolderId;
       
   139     }
       
   140 
       
   141 // -----------------------------------------------------------------------------
       
   142 // 
       
   143 // -----------------------------------------------------------------------------
       
   144 TFolderId CEmailFolder::ParentFolderId() const
       
   145     {
       
   146     return iParentId;
       
   147     }
       
   148 
       
   149 // -----------------------------------------------------------------------------
       
   150 // 
       
   151 // -----------------------------------------------------------------------------
       
   152 TFolderType CEmailFolder::FolderType() const
       
   153     {
       
   154     return iFolderType;
       
   155     }
       
   156 
       
   157 // -----------------------------------------------------------------------------
       
   158 // 
       
   159 // -----------------------------------------------------------------------------
       
   160 TPtrC CEmailFolder::Name() const
       
   161     {
       
   162     if ( !iFolder )
       
   163         return KNullDesC();
       
   164     return TPtrC ( iFolder->GetFolderName() );
       
   165     }
       
   166 
       
   167 // -----------------------------------------------------------------------------
       
   168 // 
       
   169 // -----------------------------------------------------------------------------
       
   170 TInt CEmailFolder::GetSubfoldersL( RFolderArray& aSubfolders ) const
       
   171     {
       
   172     User::LeaveIfNull( iFolder );
       
   173 
       
   174     RPointerArray<CFSMailFolder> folders;
       
   175     CleanupResetAndDestroy<RPointerArray<CFSMailFolder> >::PushL( folders );
       
   176 
       
   177     iFolder->GetSubFoldersL( folders );
       
   178     
       
   179     TInt res( folders.Count() );
       
   180     
       
   181     for ( TInt i = 0; i < res; i++ )
       
   182         {
       
   183         const CFSMailFolder* fsfolder = folders[i];
       
   184         const TEntryId id = fsfolder->GetFolderId().Id();
       
   185         const TFolderId folderId( id, iFolderId.iMailboxId.iId );
       
   186         MEmailFolder* folder = CEmailFolder::NewL( iPluginData, folderId, folders[i] );
       
   187         aSubfolders.AppendL( folder );
       
   188         }
       
   189     CleanupStack::Pop( &folders );
       
   190     folders.Close();
       
   191     return res;
       
   192     }
       
   193 
       
   194 // -----------------------------------------------------------------------------
       
   195 //  CEmailFolder::MessagesL
       
   196 // -----------------------------------------------------------------------------
       
   197 MMessageIterator* CEmailFolder::MessagesL(
       
   198         const RSortCriteriaArray& aCriteria )
       
   199     {
       
   200     RArray<TFSMailSortCriteria> sortCriterias;
       
   201     CleanupClosePushL( sortCriterias );
       
   202     CEmailFolder::ToFsSortCriteriaL( aCriteria, sortCriterias );
       
   203 
       
   204     MFSMailIterator* fsIter = iFolder->ListMessagesL( EFSMsgDataEnvelope, sortCriterias );
       
   205     TUint count = iFolder->GetMessageCount();
       
   206 
       
   207     CleanupStack::PopAndDestroy( &sortCriterias );
       
   208     CMessageIterator* iter = CMessageIterator::NewL( 
       
   209         fsIter, iPluginData, count );
       
   210 
       
   211     return iter;
       
   212     }
       
   213 
       
   214 // -----------------------------------------------------------------------------
       
   215 // 
       
   216 // -----------------------------------------------------------------------------
       
   217 void CEmailFolder::DeleteMessagesL( const REmailMessageIdArray& aMessageIds )
       
   218     {
       
   219     RArray<TFSMailMsgId> fsArray;
       
   220     CleanupClosePushL( fsArray );
       
   221     const TInt count( aMessageIds.Count() );
       
   222     for ( TInt i = 0; i < count; i++ )
       
   223         {
       
   224         TMessageId msgId = aMessageIds[i];
       
   225         if ( iFolderId != msgId.iFolderId )
       
   226             {
       
   227             // not all messages in the same folder, plugin API doesn't accept this.
       
   228             User::Leave( KErrArgument );
       
   229             }
       
   230         fsArray.AppendL( FsMsgId( iPluginData, msgId ) );
       
   231         }
       
   232     iPlugin->DeleteMessagesByUidL( 
       
   233             FsMsgId( iPluginData, iFolderId.iMailboxId ), 
       
   234             FsMsgId( iPluginData, iFolderId ), 
       
   235             fsArray );
       
   236     CleanupStack::PopAndDestroy( &fsArray );
       
   237     }
       
   238 
       
   239 // -----------------------------------------------------------------------------
       
   240 // Maps email api sort criteria to sort criteria type that protocol plugin
       
   241 // accepts.
       
   242 // -----------------------------------------------------------------------------
       
   243 void CEmailFolder::ToFsSortCriteriaL( 
       
   244     const RSortCriteriaArray& aSortCriteria, 
       
   245     RArray<TFSMailSortCriteria>& aFsCriteria )
       
   246     {
       
   247     const TFSMailSortField fieldValues[] = {
       
   248         EFSMailDontCare,        
       
   249         EFSMailSortByDate,      
       
   250         EFSMailSortBySender,    
       
   251         EFSMailSortByRecipient, 
       
   252         EFSMailSortBySubject,   
       
   253         EFSMailSortByPriority,  
       
   254         EFSMailSortByFlagStatus,
       
   255         EFSMailSortByUnread,    
       
   256         EFSMailSortBySize,      
       
   257         EFSMailSortByAttachment };
       
   258 
       
   259     for ( TInt i=0; i < aSortCriteria.Count(); i++ )
       
   260         {
       
   261         const TEmailSortCriteria& criteria  = aSortCriteria[i];
       
   262         __ASSERT_ALWAYS( criteria.iField < sizeof( fieldValues ) / sizeof (fieldValues [i] ),
       
   263             Panic( EMailPanicSortMapIndexOutOfBounds ) );
       
   264         TFSMailSortCriteria fsCriteria;
       
   265         fsCriteria.iField = fieldValues[ criteria.iField ];
       
   266         if ( criteria.iAscending )
       
   267             {
       
   268             fsCriteria.iOrder = EFSMailAscending;
       
   269             }
       
   270         else
       
   271             {
       
   272             fsCriteria.iOrder = EFSMailDescending;
       
   273             }
       
   274         aFsCriteria.AppendL( fsCriteria );
       
   275         }
       
   276     }
       
   277 
       
   278 // End of file