emailservices/emailframework/commonlib/inc/CFSMailMessageBase.h
branchRCL_3
changeset 8 e1b6206813b4
parent 0 8466d47a6819
equal deleted inserted replaced
4:e7aa27f58ae1 8:e1b6206813b4
    39     /**
    39     /**
    40      * Two-phased constructor.
    40      * Two-phased constructor.
    41      *
    41      *
    42      * @param aMessageId id of the email to be created
    42      * @param aMessageId id of the email to be created
    43      */
    43      */
    44    	 IMPORT_C static CFSMailMessageBase* NewL(const TFSMailMsgId aMessageId);
    44      IMPORT_C static CFSMailMessageBase* NewL(const TFSMailMsgId aMessageId);
    45     
    45     
    46     /**
    46     /**
    47      * Two-phased constructor.
    47      * Two-phased constructor.
    48      *
    48      *
    49      * @param aMessageId id of the email to be created
    49      * @param aMessageId id of the email to be created
    59      * message id accessor
    59      * message id accessor
    60      *
    60      *
    61      * @return message id
    61      * @return message id
    62      */
    62      */
    63      IMPORT_C TFSMailMsgId GetMessageId() const;
    63      IMPORT_C TFSMailMsgId GetMessageId() const;
    64   	 
    64      
    65  	/**
    65     /**
    66      * if email is related to another email, for example due reply / forward,
    66      * if email is related to another email, for example due reply / forward,
    67      * related email id is returned
    67      * related email id is returned
    68      *
    68      *
    69      * @return related email id
    69      * @return related email id
    70      */
    70      */
    71   	 IMPORT_C TFSMailMsgId IsRelatedTo() const;
    71      IMPORT_C TFSMailMsgId IsRelatedTo() const;
    72 
    72 
    73  	/**
    73     /**
    74      * set email related to another email, for example due reply / forward
    74      * set email related to another email, for example due reply / forward
    75      *
    75      *
    76      * @param aMessageId related email id
    76      * @param aMessageId related email id
    77      */
    77      */
    78   	 IMPORT_C void SetRelatedTo( const TFSMailMsgId aMessageId );
    78      IMPORT_C void SetRelatedTo( const TFSMailMsgId aMessageId );
    79 
    79 
    80     /**
    80     /**
    81      * email parent folder id accessor
    81      * email parent folder id accessor
    82      *
    82      *
    83      * @returns parent folder id
    83      * @returns parent folder id
   157     /**
   157     /**
   158      * appends one recipient to email BCC field, ownership transferred from user
   158      * appends one recipient to email BCC field, ownership transferred from user
   159      *
   159      *
   160      * @param aRecipient new recipient email address
   160      * @param aRecipient new recipient email address
   161      */
   161      */
   162   	 IMPORT_C void AppendBCCRecipient( CFSMailAddress* aRecipient );
   162      IMPORT_C void AppendBCCRecipient( CFSMailAddress* aRecipient );
   163 
   163 
   164     /**
   164     /**
   165      * clears email TO-recipients list
   165      * clears email TO-recipients list
   166      *
   166      *
   167      */
   167      */
   224     /**
   224     /**
   225      * email flag reset
   225      * email flag reset
   226      *
   226      *
   227      * @aFlag email flag to be reset
   227      * @aFlag email flag to be reset
   228      */
   228      */
   229 	 IMPORT_C void ResetFlag(const TInt aFlag);
   229      IMPORT_C void ResetFlag(const TInt aFlag);
   230 
   230 
   231     /**
   231     /**
   232      * test email flag is set
   232      * test email flag is set
   233      *
   233      *
   234      * @aFlag email flag to be tested
   234      * @aFlag email flag to be tested
   251      * @param aReplyToAddress email reply-to address
   251      * @param aReplyToAddress email reply-to address
   252      */
   252      */
   253      IMPORT_C void SetReplyToAddress(CFSMailAddress* aReplyToAddress);
   253      IMPORT_C void SetReplyToAddress(CFSMailAddress* aReplyToAddress);
   254 
   254 
   255      /**
   255      /**
   256 	  * plugin request handler accessor
   256       * plugin request handler accessor
   257 	  * 
   257       * 
   258 	  * @return request handler
   258       * @return request handler
   259 	  */
   259       */
   260      IMPORT_C CFSMailRequestHandler& RequestHandler( );
   260      IMPORT_C CFSMailRequestHandler& RequestHandler( );
   261           
   261           
   262 public: // from  CExtendableEmail
   262 public: // from  CExtendableEmail
   263 
   263 
   264      /**
   264      /**
   285      * email message id
   285      * email message id
   286      */
   286      */
   287      TFSMailMsgId    iMessageId;
   287      TFSMailMsgId    iMessageId;
   288 
   288 
   289  private: 
   289  private: 
   290 	 
   290      
   291     /**
   291     /**
   292      * ConstructL
   292      * ConstructL
   293      */
   293      */
   294      void ConstructL( const TFSMailMsgId aMessageId );	 
   294      void ConstructL( const TFSMailMsgId aMessageId );   
   295 protected:
   295 protected:
   296     // Request handler from tls 
   296     // Request handler from tls 
   297     CFSMailRequestHandler* 			iRequestHandler;	
   297     CFSMailRequestHandler*          iRequestHandler;    
   298  private: // data
   298  private: // data
   299 
   299 
   300  	/**
   300     /**
   301      * id of another email or part this object is related to
   301      * id of another email or part this object is related to
   302      * due some reason, like in reply or forward email use cases
   302      * due some reason, like in reply or forward email use cases
   303      */
   303      */
   304 	 TFSMailMsgId    iRelatedTo;
   304      TFSMailMsgId    iRelatedTo;
   305 
   305 
   306  	/**
   306     /**
   307      * email mailbox id
   307      * email mailbox id
   308      */
   308      */
   309      TFSMailMsgId    iMailBoxId;
   309      TFSMailMsgId    iMailBoxId;
   310 
   310 
   311  	/**
   311     /**
   312      * email parent folder id
   312      * email parent folder id
   313      */
   313      */
   314      TFSMailMsgId    iFolderId;
   314      TFSMailMsgId    iFolderId;
   315 
   315 
   316  	/**
   316     /**
   317      * email sender address
   317      * email sender address
   318      */
   318      */
   319      CFSMailAddress*    iSender;
   319      CFSMailAddress*    iSender;
   320 
   320 
   321  	/**
   321     /**
   322      * email reply-to address
   322      * email reply-to address
   323      */
   323      */
   324      CFSMailAddress*    iReplyTo;
   324      CFSMailAddress*    iReplyTo;
   325 
   325 
   326 	/**
   326     /**
   327      * email recipients, to/cc/bcc
   327      * email recipients, to/cc/bcc
   328      */
   328      */
   329      RPointerArray<CFSMailAddress> iToRecipients;
   329      RPointerArray<CFSMailAddress> iToRecipients;
   330      RPointerArray<CFSMailAddress> iCcRecipients;
   330      RPointerArray<CFSMailAddress> iCcRecipients;
   331      RPointerArray<CFSMailAddress> iBccRecipients;
   331      RPointerArray<CFSMailAddress> iBccRecipients;
   332 
   332 
   333     /**
   333     /**
   334      * email subject
   334      * email subject
   335      */
   335      */
   336      HBufC*             iSubject;
   336      HBufC*             iSubject;
   337  		 
   337          
   338     /**
   338     /**
   339      * email flags
   339      * email flags
   340      */
   340      */
   341      TInt               iFlags;
   341      TInt               iFlags;
   342 
   342 
   343     /**
   343     /**
   344      * email date
   344      * email date
   345      */
   345      */
   346      TTime              iDate;	 
   346      TTime              iDate;   
   347 };
   347 };
   348 
   348 
   349 
   349 
   350 #endif // __CFSMAILMESSAGEBASE_H
   350 #endif // __CFSMAILMESSAGEBASE_H