/*

* Copyright (c) 2002 - 2007 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: mmsheaders  declaration

*

*/

#ifndef CMMSHEADERS_H

#define CMMSHEADERS_H

//  INCLUDES

#include <e32base.h>

#include <badesca.h>

#include <mtclbase.h>       // TMsvPartList

#include "mmsconst.h"

#include "mmsgenutils.h"

#include "mmssendingchain.h"

#include "mmsdeleteresultarray.h"

// CONSTANTS

// Maximum size for Multimedia message field string value.

const TInt KMaxHeaderStringLength = 1000;

// MACROS

// DATA TYPES

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

class CMmsSettings;

class CMmsElementDescriptor;

class CMmsMMBoxMessageHeaders;

class CMmsMMBoxViewHeaders;

// CLASS DECLARATION

/**

*  This class provides access to MMS specific header data.

*  The class can be used from both Client MTM and Server MTM.

*/

class CMmsHeaders:public CBase

    {

    public:  // Constructors and destructor

// <DEPRECATED>

        /**

        * Two-phased constructor.

        * This is a legacy function and sets the default mms version

        * to a hard coded value.

        * All client should use the NewL version that gives the version

        * as parameter. The version value should come form CMmsSettings class

        */

        IMPORT_C static CMmsHeaders* NewL();

// </DEPRECATED>

        /**

        * Two-phased constructor.

        * @param aMmsVersion The version of MMS encapsulation that should be

        *     used unless the actual message contains some other value

        */

        IMPORT_C static CMmsHeaders* NewL( TInt16 aMmsVersion );

        /**

        * Destructor.

        */

        virtual ~CMmsHeaders();

    public: // New functions

        /**

        * Reset.

        * @param aSettings MMS settings to be used for initial values. Can be NULL.

        */

        IMPORT_C void Reset( CMmsSettings* aSettings = NULL);

        /**

        * Internalize the headers.

        * @param aStore CMsvStore

        */

        IMPORT_C void RestoreL( CMsvStore& aStore );

        /**

        * Externalize the headers.

        * Caller must commit the store to allow several store operations

        *     before committing the store

        * @param aStore CMsvStore in edit mode.

        */

        IMPORT_C void StoreL( CMsvStore& aStore );

        /**

        * Subject mutator. Note that Client MTM should update explicitly 

        * TMsvEntry.iDescription too.

        * @param aSubject subject string,

        */

        IMPORT_C void SetSubjectL( const TDesC& aSubject );

        /**

        * Subject accessor.

        * @return Subject string.

        */

        IMPORT_C TPtrC Subject() const;

        /**

        * Returns recipients that are of specified type (To, Cc, Bcc).

        * @param aType specifies recipient type (types defined in MMSCONST.H)

        * @return array of recipient addresses.

        */

        IMPORT_C const CDesCArray& TypedAddresseeList( TMmsRecipients aType );

        /**

        * Adds recipient with specified type (To, Cc, Bcc).<br>

        * This function also adds all recipients into the internal list <br>

        * that contains all addressees regardless of addressee type.<br>

        * @param aRealAddress recipient address.

        * @param aType specifies recipient type (types defined in MMSCONST.H)

        */

        IMPORT_C void AddTypedAddresseeL( const TDesC& aRealAddress, 

                                          TMmsRecipients aType );

        /**

        * Remove a given address from the right typed list.

        * @param aRealAddress recipient address.

        * @return ETrue is address is found and deleted.

        */

        IMPORT_C TBool RemoveAddressee( const TDesC& aRealAddress );

        /**

        * Sender mutator

        * @param aAlias

        */

        IMPORT_C void SetSenderL( const TDesC& aAlias );

        /**

        * Sender accessor

        * @return Real address of sender (for example phone number). <br>

        *     Alias can be searched from contacts database.

        */

        IMPORT_C TPtrC Sender() const;

        /**

        * Message class accessor

        * @return Message class: Personal/Advertisement/Informational. <br>

        *     values defined in MMSCONST.H

        */

        inline TInt MessageClass() const;

        /**

        * Message class mutator

        * values defined in MMSCONST.H

        */

        inline void SetMessageClass( TInt aClass );

        /**

        * Expiration interval mutator

        * @param aInterval The length of time after which the message

        *     is discarded by MMSC. Expressed in seconds.

        */

        IMPORT_C void SetExpiryInterval( TInt aInterval );

        /**

        * Expiration interval accessor.

        * @return Storage time of the message in MMSC (in seconds).

        */

        IMPORT_C TInt ExpiryInterval();

        /**

        * Expiration date mutator.

        * @param aDate The date and time the message will expire in seconds from 1970-01-01.

        *     Date must be in UTC time zone

        */

        IMPORT_C void SetExpiryDate( TInt64 aDate );

        /**

        * Expiration date accessor.

        * @return The date and time the message will expire in seconds from 1970-01-01.

        *     Date will be in UTC time zone

        */

        IMPORT_C TInt64 ExpiryDate();

        /**

        * Delivery time interval mutator.

        * @param aInterval The length of time after which the message will<br>

        *     be delivered to the recipient by the MMSC.<br>

        *     Expressed in seconds.

        */

        IMPORT_C void SetDeliveryTimeInterval( TInt aInterval );

        /**

        * Delivery time interval accessor.

        * @return delivery time interval of the message (in seconds).

        */

        IMPORT_C TInt DeliveryTimeInterval();

        /**

        * Delivery date mutator.

        * @param aDate The date and time the message will be delivered <br>

        *     to the recipient by the MMSC in seconds from 1970-01-01.

        *     Date must be in UTC time zone

        */

        IMPORT_C void SetDeliveryDate( TInt64 aDate );

        /**

        * Delivery date accessor.

        * @return The date and time the message will be delivered to the

        *     recipient by the MMSC in seconds from 1970-01-01.

        *     Date will be in UTC time zone

        */

        IMPORT_C TInt64 DeliveryDate();

        /**

        * Message priority mutator (Low/Normal/High). Default: Normal.

        * @param aPriority Message priority, values defined in MMSCONST.H

        */

        inline void SetMessagePriority( TInt aPriority );

        /**

        * Message priority accessor.

        * @return Message priority, values defined in MMSCONST.H

        */

        inline TInt MessagePriority() const;

        /**

        * Sender visibility mutator.

        * @param aVisibility Hide or Show (values defined in MMSCONST.H)

        */

        inline void SetSenderVisibility( TInt aVisibility );

        /**

        * Sender visibility accessor.

        * @return Hide or Show (values defined in MMSCONST.H)

        */

        inline TInt SenderVisibility();

        /**

        * Delivery Report Request mutator.

        * @param aRequest Yes or No (values defined in MMSCONST.H)

        */

        inline void SetDeliveryReport( TInt aRequest );

        /**

        * Delivery Report Request accessor.

        * @return Yes or No (values defined in MMSCONST.H)

        */

        inline TInt DeliveryReport();

        /**

        * Read Reply Request mutator.

        * @param aRequest Yes or No (values defined in MMSCONST.H)

        */

        inline void SetReadReply( TInt aRequest );

        /**

        * Read Reply Request accessor.

        * @return Yes or No (values defined in MMSCONST.H)

        */

        inline TInt ReadReply();

        /**

        * Message root part mutator.

        * @param aId Id of the message part that should be displayed

        *     first.<br>

        *     Should point to the SMIL part that starts the message display.

        */

        inline void SetMessageRoot( const TMsvAttachmentId aId );

        /**

        * Message root part accessor.

        * @return Id of the message part that should be displayed

        *     first.<br>

        *     Should point to the SMIL part that starts the message display.

        */

        inline TMsvAttachmentId MessageRoot( ) const;

        /** 

        * Give const access to the "To" recipient list

        * @return recipient list

        */

        inline const CDesCArray& ToRecipients() const;

        /** 

        * Give const access to the "Cc" recipient list

        * @return recipient list

        */

        inline const CDesCArray& CcRecipients() const;

        /** 

        * Give const access to the "Bcc" recipient list

        * @return recipient list

        */

        inline const CDesCArray& BccRecipients() const;

        /**

        * Content-Location mutator. Used in a Message Notification.

        * @param aURL URL of the message.

        */

        IMPORT_C void SetContentLocationL( const TDesC8& aURL );

        /**

        * Content-Location accessor. Used in a Message Notification.

        * @return URL of the message

        */

        IMPORT_C TPtrC8 ContentLocation() const;

        /**

        * Set Message-Size header.

        * @param aSize Message-Size in bytes. Used in a Message Notification.

        */

        inline void SetMessageSize( TInt aSize );

        /**

        * Get Message-Size. Used in a Message Notification.

        * @return Message-Size in bytes.

        */

        inline TInt MessageSize() const;

        /**

        * Size of the MMS headers object in memory. 

        * The multipart objet size is not included.

        * @return object size

        */

        IMPORT_C TInt Size() const;

        /**

        * Set Transaction-ID

        * @param aCid transaction ID

        */

        IMPORT_C void SetTidL( const TDesC8& aCid ); 

        /**

        * Get Transcation-ID

        * @return transaction id

        */

        IMPORT_C TPtrC8 Tid() const;

        /**

        * Set Message-Type

        * @param aType message type 

        */

        inline void SetMessageType( TInt aType ); 

        /**

        * Get Message-Type

        * @return message type.

        */

        inline TInt MessageType();

        /**

        * Set MMS-Version

        * @param aVersion MMS version

        */

        inline void SetMmsVersion( TInt16 aVersion );

        /**

        * Get MMS-Version

        * @return MMS-Version

        */

        inline TInt16 MmsVersion();

        /**

        * Set Date

        * @param aTime seconds from 1.1. 1970

        *     Date must be in UTC time zone

        */

        inline void SetDate( TInt64 aTime );

        /**

        * Get Date

        * @return seconds from 1.1. 1970

        *     Date will be in UTC time zone

        */

        inline TInt64 Date();

        /**

        * Report-Allowed accessor

        * @return Report-Allowed field value 

        */

        inline TInt32 ReportAllowed() const;

        /**

        * Report-Allowed mutator

        * @param aValue Report-Allowed value

        */

        inline void SetReportAllowed( TInt32 aValue );

        /**

        * Response-Status accessor

        * @return Response-Status field value 

        */

        inline TInt32 ResponseStatus() const;

        /**

        * Response-Status mutator

        * @param aValue Response-Status value

        */

        inline void SetResponseStatus( TInt32 aValue );

        /**

        * Message-ID mutator

        * @param aID Message-ID

        */

        IMPORT_C void SetMessageIdL( const TDesC8& aId ); 

        /**

        * Message-ID accessor

        * @return Message-ID

        */

        IMPORT_C TPtrC8 MessageId() const;

        /**

        * Status mutator

        * @param aStatus status value. See mmsconst.h.

        */

        inline void SetStatus( const TInt aStatus );

        /**

        * Status accessor

        * @return status value. See mmsconst.h.

        */

        inline TInt Status() const;

        // DEPRECATED

        // Legacy function, new version needs RFs (file system handle)

        /**

        * Make a copy of MmsHeaders

        * @param aParts message part list

        * @param aReply if the new message is a reply message. This has meaning

        *               for recipient handling.

        * @return MmsHeader object

        */

        IMPORT_C CMmsHeaders* CopyL( 

            TMsvPartList aParts,

            TBool aReply );

        /**

        * Set initial setting values from service settings

        * @param aSettings MMS service settings. Optional.

        */

        IMPORT_C void SetSettings(

            CMmsSettings* aSettings);

        /**

        * Maximum image size mutator.

        * @param aWidth image width

        * @param aHeight image height

        */

        IMPORT_C void SetMaximumImage( TInt aWidth, TInt aHeight );

        /**

        * Maximum image size accessor.

        * @param aWidth image width (OUT)

        * @param aHeight image height (OUT)

        */

        IMPORT_C void GetMaximumImage( TInt& aWidth, TInt& aHeight ) const;

        /**

        * Root Content-ID mutator.

        * @param aID Content-ID for message presentation part 

        */

        IMPORT_C void SetRootContentIdL( const TDesC8& aId ); 

        /**

        * Root Content-ID accessor.

        * @return Content-ID for message presentation part 

        */

        IMPORT_C TPtrC8 RootContentId() const;

        // new for MMS encapsulation version 1.1

        /**

        * Read status mutator.

        * @param aReadStatus status value. See mmsconst.h.

        */

        inline void SetReadStatus( const TInt aReadStatus );

        /**

        * Read status accessor.

        * @return Read status field value.

        */

        inline TInt ReadStatus() const;

        /**

        * ReplyCharging mutator.

        * @param aReplyCharging value. See mmsconst.h

        */

        inline void SetReplyCharging( const TInt aReplyCharging );

        /**

        * ReplyCharging accessor.

        * @return ReplyCharging status field

        */

        inline TInt ReplyCharging() const;

        /**

        * ReplyChargingSize mutator.

        * @param aReplyChargingSize maximum size of message for which

        *     reply charging applies.

        */

        inline void SetReplyChargingSize( const TInt aReplyChargingSize );

        /**

        * ReplyChargingSize accessor.

        * @return maximum size of message for which reply charging applies.

        */

        inline TInt ReplyChargingSize() const;

        /**

        * ReplyChargingID mutator.

        * @param aId original message ID to which this is a reply to

        */

        IMPORT_C void SetReplyChargingIdL( const TDesC8& aId ); 

        /**

        * ReplyChargingId accessor.

        * @return original message ID to which this is a reply to

        */

        IMPORT_C TPtrC8 ReplyChargingId() const;