email_plat/nmail_client_api/nmapimessageenvelope.h
changeset 23 2dc6caa42ec3
parent 20 ecc8def7944a
child 68 83cc6bae1de8
--- a/email_plat/nmail_client_api/nmapimessageenvelope.h	Mon May 03 12:23:15 2010 +0300
+++ b/email_plat/nmail_client_api/nmapimessageenvelope.h	Fri May 14 15:41:10 2010 +0300
@@ -15,218 +15,209 @@
  *
  */
 
-#ifndef NMAPIMESSAGEENVELOPEINFO_H
-#define NMAPIMESSAGEENVELOPEINFO_H
+#ifndef NMAPIMESSAGEENVELOPE_H
+#define NMAPIMESSAGEENVELOPE_H
+
 
-#include <QString>
-#include <QDateTime>
 #include <QExplicitlySharedDataPointer>
+#include <QList>
 
-#include "nmenginedef.h"
-#include "nmapiemailaddress.h"
-#include "nmapimessagebody.h"
+#include <nmapidef.h>
+
+class QString;
+class QDateTime;
 
 namespace EmailClientApi
 {
-class NmMessageEnvelopePrivate : public QSharedData
+class NmApiMessageEnvelopePrivate;
+class NmApiEmailAddress;
+class NmApiMessageBody;
+
+// read-only envelope
+class NMAPI_EXPORT NmApiMessageEnvelope
 {
 public:
-    NmMessageEnvelopePrivate();
-    virtual ~NmMessageEnvelopePrivate();
-
-    bool read;
-    bool attachments;
-    bool forwarded;
-    bool replied;
-
-    QList<EmailClientApi::NmEmailAddress> ccRecipients;
-    QList<EmailClientApi::NmEmailAddress> toRecipients;
-
-    quint64 id;
-    quint64 parentFolder;
-
-    QString contentType;
-    QString subject;
-    QString sender;
+    /*!
+       constructor for NmApiMessageEnvelope
+     */
+    NmApiMessageEnvelope();
+    
+    /*!
+       destructor for NmApiMessageEnvelope
+     */
+    virtual ~NmApiMessageEnvelope();
+    
+    /*!
+       copying constructor for NmApiMessageEnvelope
+     */
+    NmApiMessageEnvelope(const NmApiMessageEnvelope &envelope);
 
-    QString plainText;
-    quint64 totalSize;
-    quint64 fetchedSize;
-
-    QDateTime sentTime;
-};
+    /*!
+       Assignment operator
+     */
+    NmApiMessageEnvelope &operator=(const NmApiMessageEnvelope &envelope);
 
-// read-only envelope
-class NMENGINE_EXPORT NmMessageEnvelope
-{
-public:
-    /*
-     * constructor for nmmessageenvelope
+    /*!
+       Comapre data from \a envelope
      */
-    NmMessageEnvelope();
-    /*
-     * destructor for nmmessageenvelope
-     */
-    virtual ~NmMessageEnvelope();
-    NmMessageEnvelope &operator=(const NmMessageEnvelope &envelope);
-
+    bool operator==(const NmApiMessageEnvelope &envelope);
     /*!        
-     * getter for id
+       getter for id
      */
     quint64 id() const;
 
-    /*
-     * getter for id of parent folder
+    /*!
+       getter for id of parent folder
      */
     quint64 parentFolder() const;
 
-    /*
-     * getter for subject
+    /*!
+       getter for subject
      */
     QString subject() const;
 
-    /*
-     * getter for sender
+    /*!
+       getter for sender
      */
     QString sender() const;
 
-    /*
-     * getter for to recipients
+    /*!
+       getter for to recipients
      */
-    void getToRecipients( QList<EmailClientApi::NmEmailAddress> &toRecipients );
+    void getToRecipients(QList<EmailClientApi::NmApiEmailAddress> &toRecipients);
 
-    /*
-     * getter for cc recipients
+    /*!
+       getter for cc recipients
      */
-    void getCcRecipients( QList<EmailClientApi::NmEmailAddress> &ccRecipients );
+    void getCcRecipients(QList<EmailClientApi::NmApiEmailAddress> &ccRecipients);
 
-    /*
-     * getter for sent time
+    /*!
+       getter for sent time
      */
     QDateTime sentTime() const;
 
-    /*
-     * getter for is read flag
+    /*!
+       getter for is read flag
      */
     bool isRead() const;
 
-    /*
-     * getter for has attachments flag
+    /*!
+       getter for has attachments flag
      */
     bool hasAttachments() const;
 
-    /*
-     * getter for is forwarded flag
+    /*!
+       getter for is forwarded flag
      */
     bool isForwarded() const;
 
-    /*
-     * getter for is replied flag
+    /*!
+       getter for is replied flag
      */
     bool isReplied() const;
 
-    /*
-     * getter for content type
+    /*!
+       getter for content type
      */
     QString contentType() const;
 
-    /*
-     * getter for plaintext body
+    /*!
+       getter for plaintext body
      */
-    void getPlainTextBody( EmailClientApi::NmMessageBody &body );
+    void getPlainTextBody(EmailClientApi::NmApiMessageBody &body);
 
-    /*
-     * getter for plaintext body
+    /*!
+       getter for plaintext body
      */
     QString plainText() const;
 
-    /*
-     * getter for messages fetched size 
+    /*!
+       getter for messages fetched size 
      */
     quint64 totalSize() const;
 
-    /*
-     * getter for messages fetched size 
+    /*!
+       getter for messages fetched size 
      */
     quint64 fetchedSize() const;
 
-    /*
-     * setter for id 
+    /*!
+       setter for id 
      */
     void setId(quint64 id);
 
-    /*
-     * setter for parent folder 
+    /*!
+       setter for parent folder 
      */
     void setParentFolder(quint64 parentFolder);
 
-    /*
-     * setter for subject 
+    /*!
+       setter for subject 
      */
-    void setSubject(const QString& subject);
+    void setSubject(const QString &subject);
 
-    /*
-     * setter for sender  
+    /*!
+       setter for sender  
      */
-    void setSender(const QString& sender);
+    void setSender(const QString &sender);
 
-    /*
-     * setter for to recipients 
+    /*!
+       setter for to recipients 
      */
-    void setToRecipients(const QList<EmailClientApi::NmEmailAddress>& toRecipients);
+    void setToRecipients(const QList<EmailClientApi::NmApiEmailAddress> &toRecipients);
 
-    /*
-     * setter for cc recipients 
+    /*!
+       setter for cc recipients 
      */
-    void setCcRecipients(const QList<EmailClientApi::NmEmailAddress> &ccRecipients);
+    void setCcRecipients(const QList<EmailClientApi::NmApiEmailAddress> &ccRecipients);
 
-    /*
-     * setter for sent time 
+    /*!
+       setter for sent time 
      */
     void setSentTime(QDateTime sentTime);
 
-    /*
-     * setter for is read flag
+    /*!
+       setter for is read flag
      */
     void setIsRead(bool isRead);
 
-    /*
-     * setter for has attachments flag 
+    /*!
+       setter for has attachments flag 
      */
     void setHasAttachments(bool hasAttachments);
 
-    /*
-     * setter for is forwarded flag 
+    /*!
+       setter for is forwarded flag 
      */
     void setIsForwarded(bool isForwarded);
 
-    /*
-     * setter for is replied flag 
+    /*!
+       setter for is replied flag 
      */
     void setIsReplied(bool isReplied);
 
-    /*
-     * setter for content type 
+    /*!
+       setter for content type 
      */
     void setContentType(const QString &contentType);
 
-    /*
-     * getter for messages plain text 
+    /*!
+       getter for messages plain text 
      */
     void setPlainText(const QString &plainText);
 
-    /*
-     * getter for messages fetched size 
+    /*!
+       getter for messages fetched size 
      */
     void setTotalSize(quint64 totalSize);
 
-    /*
-     * getter for messages fetched size 
+    /*!
+       getter for messages fetched size 
      */
     void setFetchedSize(quint64 fetchedSize);
 
 private:
-    QExplicitlySharedDataPointer<NmMessageEnvelopePrivate> d;
+    QExplicitlySharedDataPointer<NmApiMessageEnvelopePrivate> d;
 };
 }
 #endif