author | hgs |
Wed, 15 Sep 2010 12:09:55 +0300 | |
changeset 68 | 83cc6bae1de8 |
parent 23 | 2dc6caa42ec3 |
permissions | -rw-r--r-- |
23
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
1 |
/* |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
3 |
* All rights reserved. |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
4 |
* This component and the accompanying materials are made available |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
5 |
* under the terms of "Eclipse Public License v1.0" |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
6 |
* which accompanies this distribution, and is available |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
8 |
* |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
9 |
* Initial Contributors: |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
10 |
* Nokia Corporation - initial contribution. |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
11 |
* |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
12 |
* Contributors: |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
13 |
* |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
14 |
* Description: |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
15 |
* |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
16 |
*/ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
17 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
18 |
#ifndef NMAPICOMMON_H_ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
19 |
#define NMAPICOMMON_H_ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
20 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
21 |
#include <QMetaType> |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
22 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
23 |
namespace EmailClientApi |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
24 |
{ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
25 |
/*! |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
26 |
Enum to describe mailbox events |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
27 |
*/ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
28 |
enum NmApiMailboxEvent |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
29 |
{ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
30 |
MailboxCreated, MailboxDeleted |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
31 |
}; |
68 | 32 |
|
33 |
/*! |
|
34 |
Email to message priority |
|
35 |
*/ |
|
36 |
enum NmApiMessagePriority |
|
37 |
{ |
|
38 |
NmApiMessagePriorityLow, |
|
39 |
NmApiMessagePriorityNormal, |
|
40 |
NmApiMessagePriorityHigh |
|
41 |
}; |
|
42 |
||
43 |
/*! |
|
44 |
Enum to message flags |
|
45 |
*/ |
|
46 |
enum NmApiMessageFlag |
|
47 |
{ |
|
48 |
NmApiMessageFlagRead = 1, |
|
49 |
NmApiMessageFlagReadLocally = 2, |
|
50 |
NmApiMessageFlagLow = 4, |
|
51 |
NmApiMessageFlagImportant = 8, |
|
52 |
NmApiMessageFlagFollowUpComplete = 16, |
|
53 |
NmApiMessageFlagFollowUp = 32, |
|
54 |
NmApiMessageFlagAttachments = 64, |
|
55 |
NmApiMessageFlagMultiple = 128, |
|
56 |
NmApiMessageFlagCalendarMsg = 256, |
|
57 |
NmApiMessageFlagAnswered = 512, |
|
58 |
NmApiMessageFlagForwarded = 1024, |
|
59 |
NmApiMessageFlagOnlyToMe = 2048, |
|
60 |
NmApiMessageFlagRemoteDeleted = 4096, |
|
61 |
NmApiMessageFlagHasMsgSender = 8192 |
|
62 |
}; |
|
63 |
Q_DECLARE_FLAGS(NmApiMessageFlags, NmApiMessageFlag) |
|
64 |
Q_DECLARE_OPERATORS_FOR_FLAGS(NmApiMessageFlags) |
|
65 |
||
23
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
66 |
/*! |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
67 |
Enum to describe message events. |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
68 |
*/ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
69 |
enum NmApiMessageEvent |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
70 |
{ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
71 |
MessageCreated, |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
72 |
MessageDeleted, |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
73 |
MessageChanged |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
74 |
}; |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
75 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
76 |
/*! |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
77 |
Enum to describe type of email folder |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
78 |
*/ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
79 |
enum NmApiEmailFolderType |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
80 |
{ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
81 |
Inbox, Drafts, Outbox, Sent, Deleted, EOther |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
82 |
}; |
68 | 83 |
|
84 |
/*! |
|
85 |
Email list sorting options |
|
86 |
*/ |
|
87 |
enum NmApiMailSortField |
|
88 |
{ |
|
89 |
MailDontCare, // user accepts any sort order |
|
90 |
MailSortByDate, // sorting is done by date |
|
91 |
MailSortBySender, // sorting is done by sender |
|
92 |
MailSortByRecipient, // sorting is done by recipients |
|
93 |
MailSortBySubject, // sorting is done by subject |
|
94 |
MailSortByPriority, // sorting is done by priority |
|
95 |
MailSortByFlagStatus, // follow up and completed |
|
96 |
MailSortByUnread, // sorting is based on unread |
|
97 |
MailSortBySize, // sorting is done by size |
|
98 |
MailSortByAttachment // sorting is based on if message has attachments |
|
99 |
}; |
|
100 |
||
101 |
/*! |
|
102 |
Email list sort order |
|
103 |
*/ |
|
104 |
enum NmApiMailSortOrder |
|
105 |
{ |
|
106 |
MailDescending, |
|
107 |
MailAscending |
|
108 |
}; |
|
109 |
||
23
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
110 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
111 |
/*! |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
112 |
Enum to describe error types |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
113 |
*/ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
114 |
enum NmApiError |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
115 |
{ |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
116 |
GeneralError = -1, NotSupportedError |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
117 |
}; |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
118 |
|
68 | 119 |
/*! |
120 |
Sort criteria definion Class for searching email messages |
|
121 |
*/ |
|
122 |
class NmApiMailSortCriteria |
|
123 |
{ |
|
124 |
public: |
|
125 |
NmApiMailSortField iField; |
|
126 |
NmApiMailSortOrder iOrder; |
|
127 |
}; |
|
128 |
||
129 |
/*! |
|
130 |
NmApi error codes |
|
131 |
*/ |
|
132 |
const int NmApiNoError = 0; |
|
133 |
const int NmApiNotFoundError = -1; |
|
134 |
const int NmApiGeneralError = -2; |
|
135 |
const int NmApiCancelError = -3; |
|
136 |
||
137 |
/*! |
|
138 |
NmApi predefined constants for ContentTypes |
|
139 |
*/ |
|
140 |
const QString NmApiContentTypeMultipartMixed = "multipart/mixed"; |
|
141 |
const QString NmApiContentTypeMultipartAlternative = "multipart/alternative"; |
|
142 |
const QString NmApiContentTypeMultipartDigest = "multipart/digest"; |
|
143 |
const QString NmApiContentTypeMultipartParallel = "multipart/parallel"; |
|
144 |
const QString NmApiContentTypeMultipartRelated = "multipart/related"; |
|
145 |
const QString NmApiContentTypeTextPlain = "text/plain"; |
|
146 |
const QString NmApiContentTypeTextHtml = "text/html"; |
|
147 |
const QString NmApiContentTypeTypeMessage = "message/rfc822"; |
|
148 |
const QString NmApiContentTypeParamName = " name="; |
|
149 |
const QString NmApiContentTypeParamCharset = " charset="; |
|
23
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
150 |
} |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
151 |
Q_DECLARE_METATYPE (EmailClientApi::NmApiMailboxEvent) |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
152 |
Q_DECLARE_METATYPE(EmailClientApi::NmApiMessageEvent) |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
153 |
Q_DECLARE_METATYPE (EmailClientApi::NmApiEmailFolderType) |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
154 |
Q_DECLARE_METATYPE (EmailClientApi::NmApiError) |
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
155 |
|
2dc6caa42ec3
Revision: 201017
Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
parents:
diff
changeset
|
156 |
#endif /* NMAPICOMMON_H_ */ |