|
1 /* |
|
2 * Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Message store message. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef __MSG_STORE_MESSAGE_H__ |
|
21 #define __MSG_STORE_MESSAGE_H__ |
|
22 |
|
23 //<cmail> |
|
24 #include "MsgStoreMessagePart.h" |
|
25 //</cmail> |
|
26 |
|
27 /** This class represents a message in the message store. |
|
28 */ |
|
29 class CMsgStoreMessage : public CMsgStoreMessagePart |
|
30 { |
|
31 public: |
|
32 |
|
33 /** Commits a newly created message to the message store. |
|
34 |
|
35 This function commits a newly created message to the message store. If this function is not |
|
36 called, then the message will be automatically cleaned up when the message store is |
|
37 restarted. |
|
38 |
|
39 ECapabilityWriteUserData is required to use this function. |
|
40 */ |
|
41 IMPORT_C void CommitL(); |
|
42 |
|
43 /** Abandons an uncommitted message. |
|
44 |
|
45 This function abandons an uncommitted message, and all children of the uncommitted message. |
|
46 The message object should no longer be used after this call. |
|
47 |
|
48 ECapabilityWriteUserData is required to use this function. |
|
49 */ |
|
50 IMPORT_C void AbandonL(); |
|
51 |
|
52 |
|
53 virtual ~CMsgStoreMessage(); |
|
54 |
|
55 // --------------------------- |
|
56 // INTERNAL USE (NOT EXPORTED) |
|
57 // --------------------------- |
|
58 |
|
59 static CMsgStoreMessage* NewL( CMsgStoreSessionContext& aSessionContext, |
|
60 TMsgStoreId aId, |
|
61 TMsgStoreId aCurrentParentId, |
|
62 TMsgStoreId aFolderId, |
|
63 TMsgStoreId aMailBoxId, |
|
64 const TDesC8& aPropertiesBuf ); |
|
65 |
|
66 private: |
|
67 |
|
68 CMsgStoreMessage( CMsgStoreSessionContext& aSessionContext, |
|
69 TMsgStoreId aId, |
|
70 TMsgStoreId aCurrentParentId, |
|
71 TMsgStoreId aFolderId, |
|
72 TMsgStoreId aMailBoxId); |
|
73 |
|
74 void ConstructL( const TDesC8& aPropertiesBuf ); |
|
75 |
|
76 private: |
|
77 |
|
78 const TMsgStoreId iFolderId; |
|
79 |
|
80 }; // end class CMsgStoreMessage |
|
81 |
|
82 #endif //__MSG_STORE_MESSAGE_H__ |