|
1 /* |
|
2 * Copyright (c) 2009 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 extension interface |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef CMAILMESSAGEEXT_H |
|
19 #define CMAILMESSAGEEXT_H |
|
20 |
|
21 #include "cemailextensionbase.h" |
|
22 |
|
23 // interface UID value passed to CFSMailMessageBase::ExtensionL |
|
24 const TUid KEmailMessageExtensionUid = { 0x2001E288 }; |
|
25 |
|
26 /** |
|
27 * Message extension interface |
|
28 * |
|
29 * @code |
|
30 * // below message is of type CFSMailMessageBase (or its derived type) |
|
31 * CEmailExtension* extension = message->ExtensionL( KEmailMessageExtensionUid ); |
|
32 * CMailMessageExtension* mExt = reinterpret_cast<CMailMessageExtension*>( extension ); |
|
33 * mExt->CommitL(CFSMailMessage&); |
|
34 * // Release extension when not needed any more. |
|
35 * message->ReleaseExtension( extension ); |
|
36 * @endcode |
|
37 * |
|
38 */ |
|
39 class CMailMessageExtension : public CEmailExtension |
|
40 { |
|
41 public: |
|
42 |
|
43 /** |
|
44 * Commits changes of the message to store. |
|
45 * @param aMessage a message to commit. |
|
46 */ |
|
47 virtual void CommitL(CFSMailMessage& aMessage) = 0; |
|
48 |
|
49 protected: |
|
50 inline CMailMessageExtension(); |
|
51 }; |
|
52 |
|
53 inline CMailMessageExtension::CMailMessageExtension() : |
|
54 CEmailExtension( KEmailMessageExtensionUid ) |
|
55 { |
|
56 } |
|
57 |
|
58 #endif // CMAILMESSAGEEXT_H |