Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/pop3_example_8cpp.html
Week 12 contribution of SDK documentation_content. See release notes for details. Fixes Bug 1892, Bug 1522, Bug 1520, Bug 394, Bug 1319, Bug 344, Bug 1897
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: examples/Messaging/Pop3Example/pop3Example.cpp File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>examples/Messaging/Pop3Example/pop3Example.cpp File Reference</h1>
<p>
<a href="pop3_example_8cpp-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da3670b4dde79415afdbe76e48bb6d57"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="da3670b4dde79415afdbe76e48bb6d57" args="(KTextPressAKey,"\n\n Press any key to step through the example")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTextPressAKey,"\n\n Press any key to step through the example")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c75ec938163c1ab2b41cd1f82f6ed51"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="8c75ec938163c1ab2b41cd1f82f6ed51" args="(KExit,"\n\n Press any key to exit the application ")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KExit,"\n\n Press any key to exit the application ")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb2d7576bb1445b2635797600c0dff9f"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="cb2d7576bb1445b2635797600c0dff9f" args="(KCreateMtm,"\n\n Creating a Pop3 client MTM")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreateMtm,"\n\n Creating a Pop3 client MTM")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="375e5181d496dacab4af622be044ffbb"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="375e5181d496dacab4af622be044ffbb" args="(KKeyPress,"\n\n Press any key")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KKeyPress,"\n\n Press any key")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de85907f532c1ec1f34ac0afeb27b939"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="de85907f532c1ec1f34ac0afeb27b939" args="(KTxtAccountName,"PopAccount")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTxtAccountName,"PopAccount")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb47336ecb02ae13eecfd42a587b22cd"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="cb47336ecb02ae13eecfd42a587b22cd" args="(KCreatePopAccount,"\n\n Creating a Pop account")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreatePopAccount,"\n\n Creating a Pop account")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2ca2019ce8494c114a1b6f6b722177a5"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="2ca2019ce8494c114a1b6f6b722177a5" args="(KCreateSmtpAccount,"\n\n Creating an Smtp account")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KCreateSmtpAccount,"\n\n Creating an Smtp account")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1b3b59a3c9b4389182892290cd36691"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="f1b3b59a3c9b4389182892290cd36691" args="(KSmtpServerAddress,"ban-sindhub01.intra")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KSmtpServerAddress,"ban-sindhub01.intra")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="322508e44f54bb15ddeba4e67653850a"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="322508e44f54bb15ddeba4e67653850a" args="(KEmailAlias,"Messaging example")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KEmailAlias,"Messaging example")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a15dab94acdfa85e21d805b71e3f137"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="1a15dab94acdfa85e21d805b71e3f137" args="(KSmtpEmailAddress,"ban-sindhub01@ban-sindhub01.intra")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KSmtpEmailAddress,"ban-sindhub01@ban-sindhub01.intra")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c266486455db60891c7d1823b7434191"></a><!-- doxytag: member="pop3Example.cpp::_LIT8" ref="c266486455db60891c7d1823b7434191" args="(KFrom,"ban-sindhub01@ban-sindhub01.intra")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT8</b> (KFrom,"ban-sindhub01@ban-sindhub01.intra")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b9f82024899fd0ce6eaa660ab5e5866f"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="b9f82024899fd0ce6eaa660ab5e5866f" args="(KTo,"ban-sindhub01@ban-sindhub01.intra")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KTo,"ban-sindhub01@ban-sindhub01.intra")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29d55254b09e7a2dbc71f5fcb291db51"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="29d55254b09e7a2dbc71f5fcb291db51" args="(KSubject,"SimpleEmail")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KSubject,"SimpleEmail")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8c34cf01d197ace66350f03a9ab0e461"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="8c34cf01d197ace66350f03a9ab0e461" args="(KBodyContents,"This is a very simple mail")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KBodyContents,"This is a very simple mail")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b7a49ff6194f8c0375fe5ae3ddba310d"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="b7a49ff6194f8c0375fe5ae3ddba310d" args="(KSendMail,"\n\n Sending the mail... please wait")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KSendMail,"\n\n Sending the mail... please wait")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9eb45e886031ef39b7d21240b41ce169"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="9eb45e886031ef39b7d21240b41ce169" args="(KPopServer,"ban-sindhub01.intra")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KPopServer,"ban-sindhub01.intra")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4382ab369822d657f56570e7e8976d16"></a><!-- doxytag: member="pop3Example.cpp::_LIT8" ref="4382ab369822d657f56570e7e8976d16" args="(KPopPassword,"ban-sindhub01")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT8</b> (KPopPassword,"ban-sindhub01")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6a57607007b6a1c699f842bff5dbbda"></a><!-- doxytag: member="pop3Example.cpp::_LIT8" ref="a6a57607007b6a1c699f842bff5dbbda" args="(KPopLoginName,"ban-sindhub01")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT8</b> (KPopLoginName,"ban-sindhub01")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="674dd9f2ab3b0904ee734678fa9f9b40"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="674dd9f2ab3b0904ee734678fa9f9b40" args="(KWait,"\n\n Connecting to pop3 server")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KWait,"\n\n Connecting to pop3 server")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8931d8a7996211ae4a2851be8b771c09"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="8931d8a7996211ae4a2851be8b771c09" args="(KDownload,"\n\n Downloading mail from the pop3 server")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDownload,"\n\n Downloading mail from the pop3 server")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a40abf3bd6b4dc978765f3ef42fedc52"></a><!-- doxytag: member="pop3Example.cpp::_LIT" ref="a40abf3bd6b4dc978765f3ef42fedc52" args="(KDisconnect,"\n\n Press any key to disconnect")" -->
</td><td class="memItemRight" valign="bottom"><b>_LIT</b> (KDisconnect,"\n\n Press any key to disconnect")</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">LOCAL_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="pop3_example_8cpp.html#689e0bf9aa924a1d7dc108665d44736c">MainL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GLDEF_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="pop3_example_8cpp.html#0f358e9c4355138f629b8c4f37310295">E32Main</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition in file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="689e0bf9aa924a1d7dc108665d44736c"></a><!-- doxytag: member="pop3Example.cpp::MainL" ref="689e0bf9aa924a1d7dc108665d44736c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LOCAL_C void MainL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Much simpler <a class="el" href="circularbuffer_8cpp.html#5fb473d4ee18739183215b04dcad6e12">MainL()</a>, uses the new Rendezvous() call to sync with the client<p>
Secure variant Much simpler, uses the new Rendezvous() call to sync with the client
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00357">357</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="0f358e9c4355138f629b8c4f37310295"></a><!-- doxytag: member="pop3Example.cpp::E32Main" ref="0f358e9c4355138f629b8c4f37310295" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GLDEF_C TInt E32Main </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns standard error code on exit<p>
Secure variant only Process entry point. Called by client using RProcess API <dl class="return" compact><dt><b>Returns:</b></dt><dd>Standard Epoc error code on process exit<p>
Standard Epoc error code on process exit Secure variant only Process entry point. Called by client using RProcess API</dd></dl>
Entry point for the example<p>
The E32main function is the main entry point for the code.<p>
The below section is added to make the code compatible with v9.1 This is because only exe files are compatible with v9.1<p>
Standard entry point function.
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00403">403</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:02 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>