|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE concept |
|
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
|
12 <concept id="GUID-7BB755B3-B34F-4F09-AE83-336D4F5556D0" xml:lang="en"><title>Email |
|
13 Widget API</title><shortdesc>This section provides an overview of the functionality of Email |
|
14 Widget API. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
15 <section id="GUID-3B0D7647-5AE0-4955-B63C-792D538771C2"> <title>Purpose</title> <p>Email |
|
16 Widget API provides a plug-in interface to enable third-party developers to |
|
17 integrate their email application or framework with Symbian platform email |
|
18 widget.</p></section> |
|
19 <section id="GUID-03A94132-C79A-4FAF-BA61-9DE955CCA888"><title>Description</title><p>This |
|
20 API is an ECOM plug-in which must be implemented by the third-party developers. |
|
21 The Email Server process of Symbian platform instantiates this plug-in and |
|
22 the plug-in must provide up to date information that is requested by the Email |
|
23 Server. </p></section> |
|
24 <section id="GUID-8B3D3ACA-6869-40E0-B9D5-51D29A22FB5C"><title>APIs</title><p>The |
|
25 key classes are: </p><table id="GUID-EA7D4989-CFDD-4F78-8212-F62C5E0CFB80"> |
|
26 <tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/> |
|
27 <tbody> |
|
28 <row> |
|
29 <entry><xref href="GUID-F28C7E5D-9A31-3B40-B3E4-E51F8E4232D9.dita"><apiname>CEmailObserverPlugin</apiname></xref></entry> |
|
30 <entry><p>Interface for Email Observer Plug-in API.</p></entry> |
|
31 </row> |
|
32 <row> |
|
33 <entry><xref href="GUID-D9AB36F9-867B-3F61-A068-D19E2AF63126.dita"><apiname>MEmailData</apiname></xref> </entry> |
|
34 <entry><p>Interface for plug-in data. Client will access the data through |
|
35 this API.</p></entry> |
|
36 </row> |
|
37 <row> |
|
38 <entry><xref href="GUID-E3C7BCD3-5772-3C8F-A84A-4296780DC61E.dita"><apiname>MEmailLaunchParameters</apiname></xref> </entry> |
|
39 <entry><p>Interface for launch parameters. When user access the widget, an |
|
40 application launch is initiated with the launch parameters.</p></entry> |
|
41 </row> |
|
42 <row> |
|
43 <entry><xref href="GUID-1A6C6F03-72C4-3C9A-8018-2FB6E8C4C276.dita"><apiname>MEmailObserverListener</apiname></xref> </entry> |
|
44 <entry><p>Interface class that is implemented by the plug-in instantiator.</p></entry> |
|
45 </row> |
|
46 <row> |
|
47 <entry><xref href="GUID-B6365AAC-B4D1-3CE7-86ED-4D3B3ED3AE55.dita"><apiname>MMailboxData</apiname></xref></entry> |
|
48 <entry><p>Interface for mailbox related information.</p></entry> |
|
49 </row> |
|
50 <row> |
|
51 <entry><codeph>KEmailObserverInterfaceUid</codeph> </entry> |
|
52 <entry><p>Ecom interface uid for email observer plug-in (<codeph>0x2002A5AE</codeph>).</p></entry> |
|
53 </row> |
|
54 </tbody> |
|
55 </tgroup> |
|
56 </table></section> |
|
57 <section id="GUID-6D15E5D6-DB71-41A3-9986-8ECD59ABF699"><title>Typical Uses</title><p>Following |
|
58 are some of the typical uses of Email widget API:<ul> |
|
59 <li><p>allows to add third-party email accounts to the Symbian platform email |
|
60 widget.</p></li> |
|
61 <li><p>notifies when a new message is received on the third-party email account.</p></li> |
|
62 <li><p>allows to remove the widget with 3rd party email account from the homescreen.</p></li> |
|
63 </ul></p> </section> |
|
64 </conbody></concept> |