summaryrefslogtreecommitdiffstats
path: root/src/messaging/qmessage.h
blob: 1d1da7de8cb6a8c4bdbdffc646b4f75fbf5697c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QMESSAGE_H
#define QMESSAGE_H
#include <qmessageglobal.h>
#include <qmessageaccountid.h>
#include <qmessagefolderid.h>
#include <qmessagecontentcontainer.h>
#include <qmessageaddress.h>

#include <QDateTime>
#include <QStringList>
#include <QTextStream>


QTM_BEGIN_NAMESPACE

class QMessagePrivate;

class Q_MESSAGING_EXPORT QMessage : public QMessageContentContainer
{
    friend class QMessagePrivate;

public:
    enum Type
    {
        NoType            = 0,
        Mms               = 0x1,
        Sms               = 0x2,
        Email             = 0x4,
        InstantMessage    = 0x8,
        // Extensible
        AnyType = 0xFFFFFFFF
    };
    Q_DECLARE_FLAGS(TypeFlags, Type)

    enum Status
    {
        Read = 0x1,
        HasAttachments = 0x2,
        Incoming = 0x4,
        Removed = 0x8
    };
    Q_DECLARE_FLAGS(StatusFlags, Status)

    enum Priority
    {
        HighPriority = 1,
        NormalPriority,
        LowPriority
    };

    enum StandardFolder
    {
        InboxFolder = 1,
        OutboxFolder,
        DraftsFolder,
        SentFolder,
        TrashFolder
    };

    enum ResponseType
    {
        ReplyToSender = 1,
        ReplyToAll,
        Forward
    };

    QMessage();
    QMessage(const QMessageId &id);
    QMessage(const QMessage &other);
    virtual ~QMessage();

    QMessage& operator=(const QMessage &other);

    QMessageId id() const;

    Type type() const;
    void setType(Type t);

    QMessageAccountId parentAccountId() const;
    void setParentAccountId(const QMessageAccountId &accountId);

    QMessageFolderId parentFolderId() const;

    StandardFolder standardFolder() const;

    QMessageAddress from() const;
    void setFrom(const QMessageAddress &address);

    QString subject() const;
    void setSubject(const QString &s);

    QDateTime date() const;
    void setDate(const QDateTime &d);

    QDateTime receivedDate() const;
    void setReceivedDate(const QDateTime &d);

    QMessageAddressList to() const;
    void setTo(const QMessageAddressList &toList);
    void setTo(const QMessageAddress &address);

    QMessageAddressList cc() const;
    void setCc(const QMessageAddressList &ccList);

    QMessageAddressList bcc() const;
    void setBcc(const QMessageAddressList &bccList);

    StatusFlags status() const;
    void setStatus(StatusFlags newStatus);
    void setStatus(Status flag, bool set = true);

    Priority priority() const;
    void setPriority(Priority newPriority);

    int size() const;

    QMessageContentContainerId bodyId() const;

    void setBody(const QString &body, const QByteArray &mimeType = QByteArray());
    void setBody(QTextStream &in, const QByteArray &mimeType = QByteArray());

    QMessageContentContainerIdList attachmentIds() const;

    void appendAttachments(const QStringList &fileNames);
    void clearAttachments();

    bool isModified() const;

    QMessage createResponseMessage(ResponseType type) const;

    static void setPreferredCharsets(const QList<QByteArray> &charsetNames);
    static QList<QByteArray> preferredCharsets();

    static QByteArray preferredCharsetFor(const QString &text);

private:
    friend class QMessageStore;
    friend class QMessageContentContainer;
    friend class QMessageContentContainerPrivate;
    friend class MapiSession;

    QMessagePrivate *d_ptr;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QMessage::TypeFlags)
Q_DECLARE_OPERATORS_FOR_FLAGS(QMessage::StatusFlags)

QTM_END_NAMESPACE
#endif