|
1 // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
3 // This component and the accompanying materials are made available |
|
4 // under the terms of "Eclipse Public License v1.0" |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: Neeraj Nayan |
|
12 // |
|
13 // Description: The class provides interface to create message header |
|
14 // store. |
|
15 |
|
16 /** |
|
17 * HEADER FILES |
|
18 */ |
|
19 #include <msvapi.h> |
|
20 |
|
21 |
|
22 |
|
23 /** |
|
24 * MEMBER FUNCTIONS OF CMsvHeaderStore |
|
25 */ |
|
26 |
|
27 |
|
28 /** |
|
29 * CMsvHeaderStore() |
|
30 * The default Constructor. |
|
31 * |
|
32 * @param aMtmId: The MTM-Id of the header store to be created. |
|
33 * @param aSession: A reference to the session object. |
|
34 */ |
|
35 CMsvHeaderStore::CMsvHeaderStore(TUid aMtmId, CMsvSession& aSession) |
|
36 :iMtmUid(aMtmId),iSessionRef(aSession) |
|
37 { |
|
38 } |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 /** |
|
44 * ~CMsvHeaderStore() |
|
45 * |
|
46 * The default Destructor. |
|
47 */ |
|
48 CMsvHeaderStore::~CMsvHeaderStore() |
|
49 { |
|
50 if(iLastErrorMessage) |
|
51 { |
|
52 delete iLastErrorMessage; |
|
53 } |
|
54 |
|
55 iFieldDetails.ResetAndDestroy(); |
|
56 iFieldDetails.Close(); |
|
57 } |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 /** |
|
64 * NewLC() |
|
65 * |
|
66 * Allocates and constructs a new CMsvHeaderStore object. |
|
67 * |
|
68 * @param aMtmId: The MTM-Id of the header store to be created. |
|
69 * @param aSession: A reference to the session object. |
|
70 * @leave KErrNoMemory Not enough memory to create object. |
|
71 * |
|
72 @publishedAll |
|
73 @released |
|
74 */ |
|
75 EXPORT_C CMsvHeaderStore* CMsvHeaderStore::NewLC(const TUid& aMtmId, CMsvSession& aSession) |
|
76 { |
|
77 //Create the DBAdapter object. |
|
78 CMsvHeaderStore* self = new(ELeave) CMsvHeaderStore(aMtmId, aSession); |
|
79 CleanupStack::PushL(self); |
|
80 return self; |
|
81 } |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 /** |
|
89 * NewL() |
|
90 * |
|
91 * Allocates and constructs a new CMsvHeaderStore object. |
|
92 * |
|
93 * @param aMtmId: The MTM-Id of the header store to be created. |
|
94 * @param aSession: A reference to the session object. |
|
95 * @leave KErrNoMemory Not enough memory to create object. |
|
96 * |
|
97 @publishedAll |
|
98 @released |
|
99 */ |
|
100 EXPORT_C CMsvHeaderStore* CMsvHeaderStore::NewL(const TUid& aMtmId, CMsvSession& aSession) |
|
101 { |
|
102 //Create the DBAdapter object. |
|
103 CMsvHeaderStore* self = new(ELeave) CMsvHeaderStore(aMtmId, aSession); |
|
104 return self; |
|
105 } |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 /** |
|
112 * AddFieldL() |
|
113 * |
|
114 * Adds a new field to the header store. |
|
115 * |
|
116 * @param aFieldName: Name of the header field. |
|
117 * @param aFieldType: Data type of the field. |
|
118 * @leave KErrNoMemory Not enough memory to create object. |
|
119 * |
|
120 @publishedAll |
|
121 @released |
|
122 */ |
|
123 EXPORT_C void CMsvHeaderStore::AddFieldL(HBufC* aFieldName, EFieldType aFieldType) |
|
124 { |
|
125 if(NULL == aFieldName) |
|
126 { |
|
127 User::Leave(KErrArgument); |
|
128 } |
|
129 |
|
130 CFieldPair *fieldObject = new(ELeave) CFieldPair(); |
|
131 CleanupStack::PushL(fieldObject); |
|
132 |
|
133 fieldObject->iFieldType = aFieldType; |
|
134 fieldObject->iFieldName = aFieldName; |
|
135 |
|
136 iFieldDetails.AppendL(fieldObject); |
|
137 CleanupStack::Pop(fieldObject); |
|
138 } |
|
139 |
|
140 |
|
141 |
|
142 |
|
143 |
|
144 /** |
|
145 * AddFieldL() |
|
146 * |
|
147 * Adds a new standard field to the header store. It is recommended |
|
148 * that user calls this version of AddField() to add standard fields |
|
149 * to header store. The function might leave with KErrArgument or KErrNoMemory. |
|
150 * |
|
151 * @param aCommonHeaderFieldName: Standard header fields, To, CC, BCC, From, Subject. |
|
152 * @leave KErrNoMemory Not enough memory to create object. |
|
153 * @leave KErrArgument Invalid argument passed. |
|
154 * |
|
155 @publishedAll |
|
156 @released |
|
157 */ |
|
158 EXPORT_C void CMsvHeaderStore::AddFieldL(TCommonHeaderField aCommonHeaderFieldName) |
|
159 { |
|
160 CFieldPair *fieldObject = new(ELeave) CFieldPair(); |
|
161 CleanupStack::PushL(fieldObject); |
|
162 |
|
163 fieldObject->iFieldType = ETextField; |
|
164 switch (aCommonHeaderFieldName) |
|
165 { |
|
166 case EFrom: |
|
167 _LIT16(KFromText, "From"); |
|
168 fieldObject->iFieldName = KFromText().AllocL(); |
|
169 break; |
|
170 |
|
171 case ETo: |
|
172 _LIT16(KToText, "To"); |
|
173 fieldObject->iFieldName = KToText().AllocL(); |
|
174 break; |
|
175 |
|
176 case ECC: |
|
177 _LIT16(KCCText, "CC"); |
|
178 fieldObject->iFieldName = KCCText().AllocL(); |
|
179 break; |
|
180 |
|
181 case EBCC: |
|
182 _LIT16(KBCCText, "BCC"); |
|
183 fieldObject->iFieldName = KBCCText().AllocL(); |
|
184 break; |
|
185 |
|
186 case ESubject: |
|
187 _LIT16(KSubjectText, "Subject"); |
|
188 fieldObject->iFieldName = KSubjectText().AllocL(); |
|
189 break; |
|
190 |
|
191 default: |
|
192 User::Leave(KErrArgument); |
|
193 } |
|
194 |
|
195 iFieldDetails.AppendL(fieldObject); |
|
196 CleanupStack::Pop(fieldObject); |
|
197 } |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 /** |
|
204 * CreateStoreL() |
|
205 * |
|
206 * The API creates the header store in the message store in the message |
|
207 * server current drive. The caller must call AddFieldL() APIs to specify |
|
208 * the header structure before calling this API. |
|
209 * |
|
210 * A headerStore is associated with a mtm type and stores message header |
|
211 * data. Message server creates a separate store for each MTM type. A |
|
212 * header-entry in the headerStore is essentially a list of UID-Data entries. |
|
213 * For example an email header-entry can have CImHeader, MIME header and |
|
214 * encoded header stored as a separate UID-Data entry in the header store. |
|
215 * By default a UID-Data entry will have a "Default" field which store the |
|
216 * content of 'Data'. Moreover one such UID-Data pair can also specify mutiple |
|
217 * fields such that it can store individual portion of data in such fields |
|
218 * separately. |
|
219 * |
|
220 * @leave All system wide leave code. |
|
221 * |
|
222 * @capability WriteDeviceData |
|
223 * |
|
224 @publishedAll |
|
225 @released |
|
226 */ |
|
227 EXPORT_C void CMsvHeaderStore::CreateStoreL() |
|
228 { |
|
229 iSessionRef.Session().CreateStoreL(iMtmUid, iFieldDetails); |
|
230 } |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 |
|
237 |
|
238 /** |
|
239 * DoesStoreExists() |
|
240 * |
|
241 * The function checks the existence of a header store |
|
242 * for a given MTM Id. The function can be called to |
|
243 * check if the header store already exist before creating |
|
244 * the store. |
|
245 * |
|
246 * @param aMtmId: The MTM UID under consideration. |
|
247 * @param aSession: A reference to session with the server. |
|
248 * @return TBool: ETrue, if the header store for passed MTM |
|
249 * ID exists, otherwise returns EFalse. |
|
250 * @leave: All system wide error code. |
|
251 * |
|
252 * @capability ReadDeviceData |
|
253 * |
|
254 @publishedAll |
|
255 @released |
|
256 */ |
|
257 EXPORT_C TBool CMsvHeaderStore::DoesStoreExistsL(const TUid& aMtmId, CMsvSession& aSession) |
|
258 { |
|
259 return aSession.Session().DoesStoreExistsL(aMtmId); |
|
260 } |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 /** |
|
267 * LastErrorMessage() |
|
268 * |
|
269 * The function returns the detail error message |
|
270 * received while creating the header store. |
|
271 * |
|
272 * @return TPtrC: The detail error message. |
|
273 * @leave All system wide leave code. |
|
274 * |
|
275 @publishedAll |
|
276 @released |
|
277 */ |
|
278 EXPORT_C TPtrC CMsvHeaderStore::LastErrorMessageL() |
|
279 { |
|
280 if(iLastErrorMessage) |
|
281 { |
|
282 delete iLastErrorMessage; |
|
283 iLastErrorMessage = NULL; |
|
284 } |
|
285 iSessionRef.Session().LastErrorMessageL(iLastErrorMessage); |
|
286 return iLastErrorMessage->Des(); |
|
287 } |
|
288 |
|
289 |
|
290 |