email_plat/nmail_client_api/nmapimessageenvelope.h
changeset 23 2dc6caa42ec3
parent 20 ecc8def7944a
child 68 83cc6bae1de8
equal deleted inserted replaced
20:ecc8def7944a 23:2dc6caa42ec3
    13  *
    13  *
    14  * Description:
    14  * Description:
    15  *
    15  *
    16  */
    16  */
    17 
    17 
    18 #ifndef NMAPIMESSAGEENVELOPEINFO_H
    18 #ifndef NMAPIMESSAGEENVELOPE_H
    19 #define NMAPIMESSAGEENVELOPEINFO_H
    19 #define NMAPIMESSAGEENVELOPE_H
    20 
    20 
    21 #include <QString>
    21 
    22 #include <QDateTime>
       
    23 #include <QExplicitlySharedDataPointer>
    22 #include <QExplicitlySharedDataPointer>
    24 
    23 #include <QList>
    25 #include "nmenginedef.h"
    24 
    26 #include "nmapiemailaddress.h"
    25 #include <nmapidef.h>
    27 #include "nmapimessagebody.h"
    26 
       
    27 class QString;
       
    28 class QDateTime;
    28 
    29 
    29 namespace EmailClientApi
    30 namespace EmailClientApi
    30 {
    31 {
    31 class NmMessageEnvelopePrivate : public QSharedData
    32 class NmApiMessageEnvelopePrivate;
       
    33 class NmApiEmailAddress;
       
    34 class NmApiMessageBody;
       
    35 
       
    36 // read-only envelope
       
    37 class NMAPI_EXPORT NmApiMessageEnvelope
    32 {
    38 {
    33 public:
    39 public:
    34     NmMessageEnvelopePrivate();
    40     /*!
    35     virtual ~NmMessageEnvelopePrivate();
    41        constructor for NmApiMessageEnvelope
    36 
    42      */
    37     bool read;
    43     NmApiMessageEnvelope();
    38     bool attachments;
    44     
    39     bool forwarded;
    45     /*!
    40     bool replied;
    46        destructor for NmApiMessageEnvelope
    41 
    47      */
    42     QList<EmailClientApi::NmEmailAddress> ccRecipients;
    48     virtual ~NmApiMessageEnvelope();
    43     QList<EmailClientApi::NmEmailAddress> toRecipients;
    49     
    44 
    50     /*!
    45     quint64 id;
    51        copying constructor for NmApiMessageEnvelope
    46     quint64 parentFolder;
    52      */
    47 
    53     NmApiMessageEnvelope(const NmApiMessageEnvelope &envelope);
    48     QString contentType;
    54 
    49     QString subject;
    55     /*!
    50     QString sender;
    56        Assignment operator
    51 
    57      */
    52     QString plainText;
    58     NmApiMessageEnvelope &operator=(const NmApiMessageEnvelope &envelope);
    53     quint64 totalSize;
    59 
    54     quint64 fetchedSize;
    60     /*!
    55 
    61        Comapre data from \a envelope
    56     QDateTime sentTime;
    62      */
    57 };
    63     bool operator==(const NmApiMessageEnvelope &envelope);
    58 
       
    59 // read-only envelope
       
    60 class NMENGINE_EXPORT NmMessageEnvelope
       
    61 {
       
    62 public:
       
    63     /*
       
    64      * constructor for nmmessageenvelope
       
    65      */
       
    66     NmMessageEnvelope();
       
    67     /*
       
    68      * destructor for nmmessageenvelope
       
    69      */
       
    70     virtual ~NmMessageEnvelope();
       
    71     NmMessageEnvelope &operator=(const NmMessageEnvelope &envelope);
       
    72 
       
    73     /*!        
    64     /*!        
    74      * getter for id
    65        getter for id
    75      */
    66      */
    76     quint64 id() const;
    67     quint64 id() const;
    77 
    68 
    78     /*
    69     /*!
    79      * getter for id of parent folder
    70        getter for id of parent folder
    80      */
    71      */
    81     quint64 parentFolder() const;
    72     quint64 parentFolder() const;
    82 
    73 
    83     /*
    74     /*!
    84      * getter for subject
    75        getter for subject
    85      */
    76      */
    86     QString subject() const;
    77     QString subject() const;
    87 
    78 
    88     /*
    79     /*!
    89      * getter for sender
    80        getter for sender
    90      */
    81      */
    91     QString sender() const;
    82     QString sender() const;
    92 
    83 
    93     /*
    84     /*!
    94      * getter for to recipients
    85        getter for to recipients
    95      */
    86      */
    96     void getToRecipients( QList<EmailClientApi::NmEmailAddress> &toRecipients );
    87     void getToRecipients(QList<EmailClientApi::NmApiEmailAddress> &toRecipients);
    97 
    88 
    98     /*
    89     /*!
    99      * getter for cc recipients
    90        getter for cc recipients
   100      */
    91      */
   101     void getCcRecipients( QList<EmailClientApi::NmEmailAddress> &ccRecipients );
    92     void getCcRecipients(QList<EmailClientApi::NmApiEmailAddress> &ccRecipients);
   102 
    93 
   103     /*
    94     /*!
   104      * getter for sent time
    95        getter for sent time
   105      */
    96      */
   106     QDateTime sentTime() const;
    97     QDateTime sentTime() const;
   107 
    98 
   108     /*
    99     /*!
   109      * getter for is read flag
   100        getter for is read flag
   110      */
   101      */
   111     bool isRead() const;
   102     bool isRead() const;
   112 
   103 
   113     /*
   104     /*!
   114      * getter for has attachments flag
   105        getter for has attachments flag
   115      */
   106      */
   116     bool hasAttachments() const;
   107     bool hasAttachments() const;
   117 
   108 
   118     /*
   109     /*!
   119      * getter for is forwarded flag
   110        getter for is forwarded flag
   120      */
   111      */
   121     bool isForwarded() const;
   112     bool isForwarded() const;
   122 
   113 
   123     /*
   114     /*!
   124      * getter for is replied flag
   115        getter for is replied flag
   125      */
   116      */
   126     bool isReplied() const;
   117     bool isReplied() const;
   127 
   118 
   128     /*
   119     /*!
   129      * getter for content type
   120        getter for content type
   130      */
   121      */
   131     QString contentType() const;
   122     QString contentType() const;
   132 
   123 
   133     /*
   124     /*!
   134      * getter for plaintext body
   125        getter for plaintext body
   135      */
   126      */
   136     void getPlainTextBody( EmailClientApi::NmMessageBody &body );
   127     void getPlainTextBody(EmailClientApi::NmApiMessageBody &body);
   137 
   128 
   138     /*
   129     /*!
   139      * getter for plaintext body
   130        getter for plaintext body
   140      */
   131      */
   141     QString plainText() const;
   132     QString plainText() const;
   142 
   133 
   143     /*
   134     /*!
   144      * getter for messages fetched size 
   135        getter for messages fetched size 
   145      */
   136      */
   146     quint64 totalSize() const;
   137     quint64 totalSize() const;
   147 
   138 
   148     /*
   139     /*!
   149      * getter for messages fetched size 
   140        getter for messages fetched size 
   150      */
   141      */
   151     quint64 fetchedSize() const;
   142     quint64 fetchedSize() const;
   152 
   143 
   153     /*
   144     /*!
   154      * setter for id 
   145        setter for id 
   155      */
   146      */
   156     void setId(quint64 id);
   147     void setId(quint64 id);
   157 
   148 
   158     /*
   149     /*!
   159      * setter for parent folder 
   150        setter for parent folder 
   160      */
   151      */
   161     void setParentFolder(quint64 parentFolder);
   152     void setParentFolder(quint64 parentFolder);
   162 
   153 
   163     /*
   154     /*!
   164      * setter for subject 
   155        setter for subject 
   165      */
   156      */
   166     void setSubject(const QString& subject);
   157     void setSubject(const QString &subject);
   167 
   158 
   168     /*
   159     /*!
   169      * setter for sender  
   160        setter for sender  
   170      */
   161      */
   171     void setSender(const QString& sender);
   162     void setSender(const QString &sender);
   172 
   163 
   173     /*
   164     /*!
   174      * setter for to recipients 
   165        setter for to recipients 
   175      */
   166      */
   176     void setToRecipients(const QList<EmailClientApi::NmEmailAddress>& toRecipients);
   167     void setToRecipients(const QList<EmailClientApi::NmApiEmailAddress> &toRecipients);
   177 
   168 
   178     /*
   169     /*!
   179      * setter for cc recipients 
   170        setter for cc recipients 
   180      */
   171      */
   181     void setCcRecipients(const QList<EmailClientApi::NmEmailAddress> &ccRecipients);
   172     void setCcRecipients(const QList<EmailClientApi::NmApiEmailAddress> &ccRecipients);
   182 
   173 
   183     /*
   174     /*!
   184      * setter for sent time 
   175        setter for sent time 
   185      */
   176      */
   186     void setSentTime(QDateTime sentTime);
   177     void setSentTime(QDateTime sentTime);
   187 
   178 
   188     /*
   179     /*!
   189      * setter for is read flag
   180        setter for is read flag
   190      */
   181      */
   191     void setIsRead(bool isRead);
   182     void setIsRead(bool isRead);
   192 
   183 
   193     /*
   184     /*!
   194      * setter for has attachments flag 
   185        setter for has attachments flag 
   195      */
   186      */
   196     void setHasAttachments(bool hasAttachments);
   187     void setHasAttachments(bool hasAttachments);
   197 
   188 
   198     /*
   189     /*!
   199      * setter for is forwarded flag 
   190        setter for is forwarded flag 
   200      */
   191      */
   201     void setIsForwarded(bool isForwarded);
   192     void setIsForwarded(bool isForwarded);
   202 
   193 
   203     /*
   194     /*!
   204      * setter for is replied flag 
   195        setter for is replied flag 
   205      */
   196      */
   206     void setIsReplied(bool isReplied);
   197     void setIsReplied(bool isReplied);
   207 
   198 
   208     /*
   199     /*!
   209      * setter for content type 
   200        setter for content type 
   210      */
   201      */
   211     void setContentType(const QString &contentType);
   202     void setContentType(const QString &contentType);
   212 
   203 
   213     /*
   204     /*!
   214      * getter for messages plain text 
   205        getter for messages plain text 
   215      */
   206      */
   216     void setPlainText(const QString &plainText);
   207     void setPlainText(const QString &plainText);
   217 
   208 
   218     /*
   209     /*!
   219      * getter for messages fetched size 
   210        getter for messages fetched size 
   220      */
   211      */
   221     void setTotalSize(quint64 totalSize);
   212     void setTotalSize(quint64 totalSize);
   222 
   213 
   223     /*
   214     /*!
   224      * getter for messages fetched size 
   215        getter for messages fetched size 
   225      */
   216      */
   226     void setFetchedSize(quint64 fetchedSize);
   217     void setFetchedSize(quint64 fetchedSize);
   227 
   218 
   228 private:
   219 private:
   229     QExplicitlySharedDataPointer<NmMessageEnvelopePrivate> d;
   220     QExplicitlySharedDataPointer<NmApiMessageEnvelopePrivate> d;
   230 };
   221 };
   231 }
   222 }
   232 #endif
   223 #endif
   233 
   224