Symbian3/PDK/Source/GUID-0DA1FA9A-0F61-580D-922F-02B33CEA09D6.dita
changeset 1 25a17d01db0c
child 3 46218c8b8afa
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     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-0DA1FA9A-0F61-580D-922F-02B33CEA09D6" xml:lang="en"><title>Reading
       
    13 Email Messages Using the Plain Text API</title><shortdesc>This tutorial explains how to read email messages using the plain
       
    14 text API.</shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    15 <section><title>Introduction</title> <p>You can download and
       
    16 store email messages using the <xref href="GUID-6A4CAFB0-262A-3721-B91B-07F2C3B64B5F.dita"><apiname>CMsvPlainBodyText</apiname></xref> API, and
       
    17 read them using the <xref href="GUID-14EA98A8-06E7-33FF-B2B1-4BC3D044518D.dita"><apiname>CImPlainBodyText</apiname></xref> API. </p> </section>
       
    18 <section><title>Procedure</title> <ol id="GUID-DF33FDBB-6DE8-565D-BA78-DAABEA214EA6">
       
    19 <li id="GUID-3AB85720-EB0B-59AE-897D-88C472BDC5BA"><p>Use the <xref href="GUID-A4B1F874-27C0-3BB6-9D29-C35C75A5DB98.dita"><apiname>TMsvId</apiname></xref>  <codeph>aMessageId</codeph> parameter
       
    20 of the downloaded email to create the <xref href="GUID-85BBE389-81F7-3E2F-A789-446D9BE2CC49.dita"><apiname>CMsvEntry</apiname></xref> class. </p> </li>
       
    21 <li id="GUID-160A66AF-092E-58C4-879D-FF1E7D23A911"><p>Use the <xref href="GUID-85BBE389-81F7-3E2F-A789-446D9BE2CC49.dita"><apiname>CMsvEntry</apiname></xref> class
       
    22 to create the <xref href="GUID-323E701E-EA22-3CC8-AE84-C16880608D44.dita"><apiname>CImEmailMessage</apiname></xref> object. </p> </li>
       
    23 <li id="GUID-D58CE6D1-E97C-5BAC-AD33-A921A5BE5F02"><p>Call the <xref href="GUID-323E701E-EA22-3CC8-AE84-C16880608D44.dita#GUID-323E701E-EA22-3CC8-AE84-C16880608D44/GUID-E20991B9-52D4-3952-A748-41A65E321952"><apiname>CImEmailMessage::OpenPlainBodyTextForReadL()</apiname></xref> function
       
    24 to get the <xref href="GUID-6A4CAFB0-262A-3721-B91B-07F2C3B64B5F.dita"><apiname>CMsvPlainBodyText</apiname></xref> instance, passing in the number
       
    25 of characters that will be populated for each read operation. </p> </li>
       
    26 <li id="GUID-7DED1564-5F11-5E97-9B39-5AA5C71AD0F8"><p>Use the <xref href="GUID-14EA98A8-06E7-33FF-B2B1-4BC3D044518D.dita#GUID-14EA98A8-06E7-33FF-B2B1-4BC3D044518D/GUID-1BD29476-4C4B-3C62-8EC9-23803231E9C2"><apiname>CImPlainBodyText::NextChunkL()</apiname></xref> function
       
    27 or the <xref href="GUID-14EA98A8-06E7-33FF-B2B1-4BC3D044518D.dita#GUID-14EA98A8-06E7-33FF-B2B1-4BC3D044518D/GUID-CFCAA0D3-BF63-31A2-9037-E08AF82252DB"><apiname>CImPlainBodyText::PreviousChunkL()</apiname></xref> function to retrieve
       
    28 the body text of the message. </p> <p> Note: The <xref href="GUID-977B99AD-A5FB-3606-9043-824E22905604.dita"><apiname>NextChunkL()</apiname></xref> function
       
    29 is used to get the data of the email message in chunks and in sequential order
       
    30 from the beginning of the body text to the end of it. <xref href="GUID-64806D92-CDB6-31A9-8F08-D0E876B5CF18.dita"><apiname>PreviousChunkL()</apiname></xref> is
       
    31 used to get the chunk that is previously retrieved by the <xref href="GUID-977B99AD-A5FB-3606-9043-824E22905604.dita"><apiname>NextChunkL()</apiname></xref> function.
       
    32 The size of the chunk is specified in the call to the <xref href="GUID-E1CBCDE3-FF5F-3CBA-B3DD-1AB9F58D98F6.dita"><apiname>OpenPlainBodyTextForReadL()</apiname></xref> function. </p> <p>Email
       
    33 applications must check the length of the chunk populated. If the length is
       
    34 zero (0) it indicates that it has reached the last chunk of the previous read
       
    35 operation. </p> </li>
       
    36 </ol> </section>
       
    37 </conbody><related-links>
       
    38 <link href="GUID-2C8653F9-8873-59E8-9FD2-4215F6877ABC.dita"><linktext>Chunk Method
       
    39 to Process Emails</linktext></link>
       
    40 <link href="GUID-D73AD200-BE4D-50BF-BCF9-14627DE530B7.dita"><linktext>Imap4Example:
       
    41 An Email manager using IMAP4 and SMTP</linktext></link>
       
    42 <link href="GUID-BB35DBCC-FE56-547F-BADA-9EF854691ADC.dita"><linktext>Pop3Example:
       
    43 An Email manager using POP3 and SMTP</linktext></link>
       
    44 </related-links></concept>