emailservices/emailcommon/src/CFSMailMessageBase.cpp
branchRCL_3
changeset 63 d189ee25cf9d
equal deleted inserted replaced
61:dcf0eedfc1a3 63:d189ee25cf9d
       
     1 /*
       
     2 * Copyright (c) 2007-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:  common email base object
       
    15 *
       
    16 */
       
    17 
       
    18 #include "emailtrace.h"
       
    19 
       
    20 //<cmail>
       
    21 #include "CFSMailRequestHandler.h"
       
    22 #include "CFSMailMessageBase.h"
       
    23 #include "cmailmessageext.h"
       
    24 //</cmail>
       
    25 
       
    26 //<qmail>
       
    27 #include <nmcommonheaders.h>
       
    28 #include "nmmessageenvelope.h"
       
    29 #include "nmconverter.h"
       
    30 //</qmail>
       
    31 
       
    32 // ================= MEMBER FUNCTIONS ==========================================
       
    33 // -----------------------------------------------------------------------------
       
    34 // CFSMailMessageBase::NewLC
       
    35 // -----------------------------------------------------------------------------
       
    36 EXPORT_C CFSMailMessageBase * CFSMailMessageBase::NewLC( TFSMailMsgId aMessageId )
       
    37 {
       
    38   NM_FUNCTION;
       
    39   
       
    40   CFSMailMessageBase* message = new (ELeave) CFSMailMessageBase();
       
    41   CleanupStack:: PushL(message);
       
    42   message->ConstructL(aMessageId);
       
    43   return message;
       
    44 } 
       
    45 
       
    46 // -----------------------------------------------------------------------------
       
    47 // CFSMailMessageBase::NewL
       
    48 // -----------------------------------------------------------------------------
       
    49 EXPORT_C CFSMailMessageBase * CFSMailMessageBase::NewL( TFSMailMsgId aMessageId )
       
    50 {
       
    51   NM_FUNCTION;
       
    52   
       
    53   CFSMailMessageBase* message =  CFSMailMessageBase::NewLC(aMessageId);
       
    54   CleanupStack:: Pop(message);
       
    55   return message;
       
    56 }
       
    57 
       
    58 // -----------------------------------------------------------------------------
       
    59 // CFSMailMessageBase::CFSMailMessageBase
       
    60 // -----------------------------------------------------------------------------
       
    61 CFSMailMessageBase::CFSMailMessageBase(): iSender(NULL)
       
    62 {
       
    63     NM_FUNCTION;
       
    64     
       
    65 // <qmail> unnecessary member initialization removed: iSubject, iFlags </qmail>
       
    66     // set request handler pointer
       
    67   iRequestHandler = static_cast<CFSMailRequestHandler*>(Dll::Tls());
       
    68 }
       
    69 
       
    70 // -----------------------------------------------------------------------------
       
    71 // CFSMailMessageBase::ConstructL
       
    72 // -----------------------------------------------------------------------------
       
    73 EXPORT_C void CFSMailMessageBase::ConstructL( TFSMailMsgId aMessageId )
       
    74 {
       
    75     NM_FUNCTION;
       
    76     
       
    77 // <qmail>
       
    78     // Construction of shared data object
       
    79     iNmPrivateMessageEnvelope = new NmMessageEnvelopePrivate();
       
    80 
       
    81   // typedef long int TInt32 -> typedef unsigned int quint32
       
    82     iNmPrivateMessageEnvelope->mMessageId.setId32((quint32)aMessageId.Id() );
       
    83 
       
    84   // typedef unsigned int TUint -> typedef unsigned int quint32
       
    85     iNmPrivateMessageEnvelope->mMessageId.setPluginId32((quint32)aMessageId.PluginId().iUid);
       
    86 
       
    87     // construct the CFSMailAddress object and connect it with NmAddress private data 
       
    88     iSender = CFSMailAddress::NewL(iNmPrivateMessageEnvelope->mSender);
       
    89 // </qmail>
       
    90 }
       
    91 
       
    92 // <qmail>
       
    93 // -----------------------------------------------------------------------------
       
    94 // CFSMailMessageBase::ConstructL
       
    95 // -----------------------------------------------------------------------------
       
    96 EXPORT_C void CFSMailMessageBase::ConstructL(
       
    97     const NmMessageEnvelope &aMessageEnvelope )
       
    98 {
       
    99     NM_FUNCTION;
       
   100 
       
   101     iNmPrivateMessageEnvelope = aMessageEnvelope.d;
       
   102 }
       
   103 //</qmail>
       
   104 
       
   105 // -----------------------------------------------------------------------------
       
   106 // CFSMailMessageBase::~CFSMailMessageBase
       
   107 // -----------------------------------------------------------------------------
       
   108 EXPORT_C CFSMailMessageBase::~CFSMailMessageBase()
       
   109 {
       
   110     NM_FUNCTION;
       
   111     
       
   112   if(iSender)
       
   113     {
       
   114     delete iSender;
       
   115     iSender = NULL;
       
   116     }
       
   117 // <qmail> unnecessary member destruction removed: iSubject, iToRecipients, iCcRecipients, iBccRecipients </qmail>
       
   118 }
       
   119 
       
   120 // -----------------------------------------------------------------------------
       
   121 // CFSMailMessageBase::GetMessageId
       
   122 // -----------------------------------------------------------------------------
       
   123 EXPORT_C TFSMailMsgId CFSMailMessageBase::GetMessageId(  ) const
       
   124 {
       
   125     NM_FUNCTION;
       
   126     
       
   127 // <qmail>
       
   128     //For message  
       
   129     TFSMailMsgId id = TFSMailMsgId(iNmPrivateMessageEnvelope->mMessageId);
       
   130     
       
   131     //For message part
       
   132     if(id.IsNullId()){
       
   133         id = TFSMailMsgId(iNmPrivateMessageEnvelope->mFolderId);
       
   134     }
       
   135   
       
   136     return id;
       
   137 // </qmail>
       
   138 }
       
   139 
       
   140 // <qmail>
       
   141 // -----------------------------------------------------------------------------
       
   142 // CFSMailMessageBase::SetMessageId
       
   143 // -----------------------------------------------------------------------------
       
   144 EXPORT_C void CFSMailMessageBase::SetMessageId( const TFSMailMsgId aMessageId )
       
   145 {
       
   146     NM_FUNCTION;
       
   147     
       
   148     // typedef long int TInt32 -> typedef unsigned int quint32
       
   149     iNmPrivateMessageEnvelope->mMessageId.setId32( aMessageId.Id() );
       
   150 
       
   151     // typedef unsigned int TUint -> typedef unsigned int quint32
       
   152     iNmPrivateMessageEnvelope->mMessageId.setPluginId32(
       
   153             (unsigned int)aMessageId.PluginId().iUid);
       
   154 }
       
   155 //</qmail>
       
   156 
       
   157 // -----------------------------------------------------------------------------
       
   158 // CFSMailMessageBase::GetFolderId
       
   159 // -----------------------------------------------------------------------------
       
   160 EXPORT_C TFSMailMsgId CFSMailMessageBase::GetFolderId( ) const
       
   161 {
       
   162     NM_FUNCTION;
       
   163     
       
   164 // <qmail>
       
   165     return TFSMailMsgId(iNmPrivateMessageEnvelope->mFolderId);
       
   166 // </qmail>
       
   167 }
       
   168 
       
   169 // -----------------------------------------------------------------------------
       
   170 // CFSMailMessageBase::SetFolderId
       
   171 // -----------------------------------------------------------------------------
       
   172 EXPORT_C void CFSMailMessageBase::SetFolderId( const TFSMailMsgId aFolderId )
       
   173 {
       
   174     NM_FUNCTION;
       
   175     
       
   176 // <qmail>
       
   177     iNmPrivateMessageEnvelope->mFolderId = NmConverter::mailMsgIdToNmId(aFolderId);
       
   178 // </qmail>
       
   179 }
       
   180 
       
   181 // -----------------------------------------------------------------------------
       
   182 // CFSMailMessageBase::GetMailBoxId
       
   183 // -----------------------------------------------------------------------------
       
   184 EXPORT_C TFSMailMsgId CFSMailMessageBase::GetMailBoxId( ) const
       
   185 {
       
   186     NM_FUNCTION;
       
   187     
       
   188 // <qmail>
       
   189     return NmId(iNmPrivateMessageEnvelope->mMailboxId);
       
   190 // </qmail>
       
   191 }
       
   192 
       
   193 // -----------------------------------------------------------------------------
       
   194 // CFSMailMessageBase::SetMailBoxId
       
   195 // -----------------------------------------------------------------------------
       
   196 EXPORT_C void CFSMailMessageBase::SetMailBoxId( const TFSMailMsgId aMailBoxId )
       
   197 {
       
   198     NM_FUNCTION;
       
   199     
       
   200 // <qmail>
       
   201     iNmPrivateMessageEnvelope->mMailboxId = NmConverter::mailMsgIdToNmId(aMailBoxId);
       
   202 // </qmail>
       
   203 }
       
   204 
       
   205 // -----------------------------------------------------------------------------
       
   206 // CFSMailMessageBase::SetSender
       
   207 // -----------------------------------------------------------------------------
       
   208 EXPORT_C void CFSMailMessageBase::SetSender(CFSMailAddress* aSender)
       
   209 {
       
   210     NM_FUNCTION;
       
   211     
       
   212 // <qmail>
       
   213     // store sender
       
   214     if (iSender)
       
   215         {
       
   216         delete iSender;
       
   217         iSender = NULL;
       
   218         }
       
   219     if (!aSender) 
       
   220         {
       
   221         TRAP_IGNORE(iSender = CFSMailAddress::NewL());
       
   222         }
       
   223     else 
       
   224         {
       
   225         iSender = aSender;
       
   226         }   
       
   227     iNmPrivateMessageEnvelope->mSender = iSender->GetNmAddress();
       
   228 // </qmail>
       
   229 }
       
   230 
       
   231 // -----------------------------------------------------------------------------
       
   232 // CFSMailMessageBase::GetSender
       
   233 // -----------------------------------------------------------------------------
       
   234 EXPORT_C CFSMailAddress* CFSMailMessageBase::GetSender() const
       
   235 {
       
   236     NM_FUNCTION;
       
   237     
       
   238   return iSender;
       
   239 }
       
   240 
       
   241 // -----------------------------------------------------------------------------
       
   242 // CFSMailMessageBase::GetToRecipients
       
   243 // -----------------------------------------------------------------------------
       
   244 EXPORT_C RPointerArray<CFSMailAddress> CFSMailMessageBase::GetToRecipients()
       
   245 {
       
   246 // <qmail>
       
   247     NM_FUNCTION;
       
   248     
       
   249     return NmConverter::toRPointerArray(
       
   250         iNmPrivateMessageEnvelope->mToRecipients);
       
   251 // </qmail>
       
   252 }
       
   253 
       
   254 // -----------------------------------------------------------------------------
       
   255 // CFSMailMessageBase::GetCCRecipients
       
   256 // -----------------------------------------------------------------------------
       
   257 EXPORT_C RPointerArray<CFSMailAddress> CFSMailMessageBase::GetCCRecipients()
       
   258 {
       
   259 // <qmail>
       
   260     NM_FUNCTION;
       
   261     
       
   262     return NmConverter::toRPointerArray(
       
   263         iNmPrivateMessageEnvelope->mCcRecipients);
       
   264 // </qmail>
       
   265 }
       
   266 
       
   267 // -----------------------------------------------------------------------------
       
   268 // CFSMailMessageBase::GetBCCRecipients
       
   269 // -----------------------------------------------------------------------------
       
   270 EXPORT_C RPointerArray<CFSMailAddress> CFSMailMessageBase::GetBCCRecipients()
       
   271 {
       
   272 // <qmail>
       
   273     NM_FUNCTION;
       
   274     
       
   275     return NmConverter::toRPointerArray(
       
   276         iNmPrivateMessageEnvelope->mBccRecipients);
       
   277 // </qmail>
       
   278 }
       
   279 
       
   280 // -----------------------------------------------------------------------------
       
   281 // CFSMailMessageBase::AppendToRecipient
       
   282 // -----------------------------------------------------------------------------
       
   283 EXPORT_C void CFSMailMessageBase::AppendToRecipient(CFSMailAddress* aRecipient)
       
   284 {
       
   285     NM_FUNCTION;
       
   286     
       
   287 // <qmail>
       
   288     if (aRecipient) 
       
   289         {
       
   290         iNmPrivateMessageEnvelope->mToRecipients.append(aRecipient->GetNmAddress());
       
   291         }
       
   292 // </qmail>
       
   293 }
       
   294 
       
   295 // -----------------------------------------------------------------------------
       
   296 // CFSMailMessageBase::AppendCCRecipient
       
   297 // -----------------------------------------------------------------------------
       
   298 EXPORT_C void CFSMailMessageBase::AppendCCRecipient(CFSMailAddress* aRecipient )
       
   299 {
       
   300     NM_FUNCTION;
       
   301     
       
   302 // <qmail>
       
   303     if (aRecipient) 
       
   304         {
       
   305         iNmPrivateMessageEnvelope->mCcRecipients.append(
       
   306             aRecipient->GetNmAddress());
       
   307         }
       
   308 // </qmail>
       
   309 }
       
   310 
       
   311 // -----------------------------------------------------------------------------
       
   312 // CFSMailMessageBase::AppendBCCRecipient
       
   313 // -----------------------------------------------------------------------------
       
   314 EXPORT_C void CFSMailMessageBase::AppendBCCRecipient( CFSMailAddress* aRecipient )
       
   315 {
       
   316     NM_FUNCTION;
       
   317     
       
   318 // <qmail>
       
   319     if (aRecipient)
       
   320         {
       
   321         iNmPrivateMessageEnvelope->mBccRecipients.append(
       
   322             aRecipient->GetNmAddress());
       
   323         }
       
   324 // </qmail>      
       
   325 }
       
   326 
       
   327 // -----------------------------------------------------------------------------
       
   328 // CFSMailMessageBase::ClearToRecipients
       
   329 // -----------------------------------------------------------------------------
       
   330 EXPORT_C void CFSMailMessageBase::ClearToRecipients( )
       
   331 {
       
   332     NM_FUNCTION;
       
   333     
       
   334 // <qmail>
       
   335     iNmPrivateMessageEnvelope->mToRecipients.clear();
       
   336 // </qmail>
       
   337 }
       
   338 
       
   339 // -----------------------------------------------------------------------------
       
   340 // CFSMailMessageBase::ClearCcRecipients
       
   341 // -----------------------------------------------------------------------------
       
   342 EXPORT_C void CFSMailMessageBase::ClearCcRecipients( )
       
   343 {
       
   344     NM_FUNCTION;
       
   345     
       
   346 // <qmail>
       
   347     iNmPrivateMessageEnvelope->mCcRecipients.clear();
       
   348 // </qmail>
       
   349 }
       
   350 
       
   351 // -----------------------------------------------------------------------------
       
   352 // CFSMailMessageBase::ClearBccRecipients
       
   353 // -----------------------------------------------------------------------------
       
   354 EXPORT_C void CFSMailMessageBase::ClearBccRecipients( )
       
   355 {
       
   356     NM_FUNCTION;
       
   357     
       
   358 // <qmail>
       
   359     iNmPrivateMessageEnvelope->mBccRecipients.clear();
       
   360 // </qmail>
       
   361 }
       
   362 
       
   363 //<qmail>
       
   364 // -----------------------------------------------------------------------------
       
   365 // CFSMailMessageBase::GetSubject
       
   366 // -----------------------------------------------------------------------------
       
   367 EXPORT_C TDesC& CFSMailMessageBase::GetSubject() const
       
   368 {
       
   369     NM_FUNCTION;
       
   370     
       
   371 // <qmail>
       
   372     iSubjectPtr.Set(reinterpret_cast<const TUint16*> (iNmPrivateMessageEnvelope->mSubject.utf16()),
       
   373         iNmPrivateMessageEnvelope->mSubject.length());
       
   374     return iSubjectPtr;
       
   375 // </qmail>
       
   376 }
       
   377 
       
   378 // -----------------------------------------------------------------------------
       
   379 // CFSMailMessageBase::GetDate
       
   380 // -----------------------------------------------------------------------------
       
   381 EXPORT_C TTime CFSMailMessageBase::GetDate() const
       
   382 {
       
   383     NM_FUNCTION;
       
   384     
       
   385 // <qmail>
       
   386     return NmConverter::toTTime(iNmPrivateMessageEnvelope->mSentTime);
       
   387 // </qmail>
       
   388 }
       
   389 
       
   390 // -----------------------------------------------------------------------------
       
   391 // CFSMailMessageBase::SetDate
       
   392 // -----------------------------------------------------------------------------
       
   393 EXPORT_C void CFSMailMessageBase::SetDate( const TTime aDate )
       
   394 {
       
   395     NM_FUNCTION;
       
   396     
       
   397 // <qmail>
       
   398     iNmPrivateMessageEnvelope->mSentTime = NmConverter::toQDateTime(aDate);
       
   399 // </qmail>
       
   400 }
       
   401 
       
   402 // -----------------------------------------------------------------------------
       
   403 // CFSMailMessageBase::SetSubject
       
   404 // -----------------------------------------------------------------------------
       
   405 EXPORT_C void CFSMailMessageBase::SetSubject(const TDesC& aSubject)
       
   406 {
       
   407     NM_FUNCTION;
       
   408     
       
   409 // <qmail>
       
   410     QString qtSubject = QString::fromUtf16(aSubject.Ptr(), aSubject.Length());
       
   411     iNmPrivateMessageEnvelope->mSubject = qtSubject;
       
   412 // </qmail>
       
   413 }
       
   414 
       
   415 // -----------------------------------------------------------------------------
       
   416 // CFSMailMessageBase::GetFlags
       
   417 // -----------------------------------------------------------------------------
       
   418 EXPORT_C TInt CFSMailMessageBase::GetFlags( ) const
       
   419 {
       
   420     NM_FUNCTION;
       
   421     
       
   422 // <qmail>
       
   423     return (TInt)iNmPrivateMessageEnvelope->flags();
       
   424 // </qmail>
       
   425 }
       
   426 
       
   427 // -----------------------------------------------------------------------------
       
   428 // CFSMailMessageBase::SetFlag
       
   429 // -----------------------------------------------------------------------------
       
   430 EXPORT_C void CFSMailMessageBase::SetFlag(const TInt aFlag)
       
   431 {
       
   432     NM_FUNCTION;
       
   433     
       
   434 // <qmail>
       
   435     iNmPrivateMessageEnvelope->setFlags((NmMessageFlags)aFlag, true);
       
   436 // </qmail>
       
   437 }
       
   438 
       
   439 // -----------------------------------------------------------------------------
       
   440 // CFSMailMessageBase::ResetFlag
       
   441 // -----------------------------------------------------------------------------
       
   442 EXPORT_C void CFSMailMessageBase::ResetFlag(const TInt aFlag)
       
   443 {
       
   444     NM_FUNCTION;
       
   445     
       
   446 // <qmail>
       
   447     iNmPrivateMessageEnvelope->setFlags((NmMessageFlags)aFlag, false);
       
   448 // </qmail>
       
   449 }
       
   450 
       
   451 // -----------------------------------------------------------------------------
       
   452 // CFSMailMessageBase::IsFlagSet
       
   453 // -----------------------------------------------------------------------------
       
   454 EXPORT_C TBool CFSMailMessageBase::IsFlagSet(const TInt aFlag) const
       
   455 {
       
   456     NM_FUNCTION;
       
   457     
       
   458 // <qmail>
       
   459     TBool result = EFalse;
       
   460     if (iNmPrivateMessageEnvelope->isFlagSet((NmMessageFlag)aFlag)) 
       
   461         {
       
   462         result = ETrue;
       
   463         }
       
   464     return result;
       
   465 // <qmail>
       
   466 }
       
   467 
       
   468 // -----------------------------------------------------------------------------
       
   469 // CFSMailMessageBase::SetReplyToAddress
       
   470 // -----------------------------------------------------------------------------
       
   471 EXPORT_C void CFSMailMessageBase::SetReplyToAddress(CFSMailAddress* aReplyToAddress)
       
   472 {
       
   473     NM_FUNCTION;
       
   474     
       
   475   // store sender
       
   476   if (iReplyTo)
       
   477     {
       
   478     delete iReplyTo;
       
   479     }
       
   480   iReplyTo = aReplyToAddress;
       
   481 
       
   482 }
       
   483 
       
   484 // -----------------------------------------------------------------------------
       
   485 // CFSMailMessageBase::GetReplyToAddress
       
   486 // -----------------------------------------------------------------------------
       
   487 EXPORT_C const CFSMailAddress& CFSMailMessageBase::GetReplyToAddress()
       
   488 {
       
   489     NM_FUNCTION;
       
   490     
       
   491     return *iReplyTo;
       
   492 }
       
   493 
       
   494 EXPORT_C CFSMailRequestHandler& CFSMailMessageBase::RequestHandler( )
       
   495 {
       
   496     NM_FUNCTION;
       
   497     
       
   498     return *iRequestHandler;
       
   499 }
       
   500 
       
   501 // <qmail>
       
   502 // -----------------------------------------------------------------------------
       
   503 // CFSMailMessageBase::GetNmMessageEnvelope
       
   504 // -----------------------------------------------------------------------------
       
   505 EXPORT_C NmMessageEnvelope* CFSMailMessageBase::GetNmMessageEnvelope()
       
   506 {
       
   507     NM_FUNCTION;
       
   508     
       
   509     return new NmMessageEnvelope(iNmPrivateMessageEnvelope);
       
   510 }
       
   511 // </qmail>
       
   512 
       
   513 // -----------------------------------------------------------------------------
       
   514 // CFSMailMessageBase::ReleaseExtension
       
   515 // -----------------------------------------------------------------------------
       
   516 EXPORT_C void CFSMailMessageBase::ReleaseExtension( CEmailExtension* aExtension )
       
   517     {
       
   518     NM_FUNCTION;
       
   519     
       
   520     if ( CFSMailPlugin* plugin = iRequestHandler->GetPluginByUid(
       
   521 		iNmPrivateMessageEnvelope->mMessageId ) )
       
   522         {
       
   523         // If plugin has created the extension, let it handle destruction.
       
   524         plugin->ReleaseExtension( aExtension );
       
   525         }
       
   526     else
       
   527         {
       
   528         CExtendableEmail::ReleaseExtension( aExtension );
       
   529         }
       
   530     }
       
   531     
       
   532 // -----------------------------------------------------------------------------
       
   533 // CFSMailMessageBase::ExtensionL
       
   534 // -----------------------------------------------------------------------------
       
   535 EXPORT_C CEmailExtension* CFSMailMessageBase::ExtensionL( 
       
   536     const TUid& aInterfaceUid )
       
   537     {
       
   538     NM_FUNCTION;
       
   539     
       
   540     CEmailExtension* ext = CExtendableEmail::ExtensionL( aInterfaceUid );
       
   541     // didn't find already created instance, try now
       
   542     if ( !ext )
       
   543         {
       
   544         // check that plugin supports requested extension.
       
   545 // <qmail>
       
   546         if ( CFSMailPlugin* plugin = iRequestHandler->GetPluginByUid(
       
   547 			iNmPrivateMessageEnvelope->mMessageId ) )
       
   548 // </qmail>
       
   549             {
       
   550             // request extension from plugin, leaves if not supported
       
   551             ext = plugin->ExtensionL( aInterfaceUid );    
       
   552             }
       
   553 
       
   554         }
       
   555     return ext;
       
   556     }