Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_pop3_example.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: CPop3Example Class 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>CPop3Example Class Reference</h1><!-- doxytag: class="CPop3Example" -->
<p>
<a href="class_c_pop3_example-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#401645654f38c3e601b09ff84d6fd033">~CPop3Example</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#e48622bc95aeac93981f58a7418258f9">HandleSessionEventL</a> (TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#071be1033b73bd98a19978d4bd90b7fb">CreateClientRegistryL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#e1b7a4e38a8771d202c637adb12302c2">CreatePopAndSmtpAccountL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#4e14514a9a39eee71b372edc85a93b17">CreateSmtpMessageL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#681d0b120db69c06587235560f1e3b34">SendSMTPMessageL</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#a6944f804b14759d3eaec2b791b78f0c">ConnectDownloadAndDisconnectPOPServerL</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_c_pop3_example.html">CPop3Example</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pop3_example.html#b349920e1fdb72d5dbf6186c52d319b6">NewL</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class that publicily inherits two classes, CBase and MMsvSessionObserver. CBase is the base class for all classes to be instantiated on the heap. MMsvSessionObserver is the interface for notification of events from a Message Server session. Objects that need to observe a session view should implement this interface.
<p>Definition at line <a class="el" href="pop3_example_8h-source.html#l00059">59</a> of file <a class="el" href="pop3_example_8h-source.html">pop3Example.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="401645654f38c3e601b09ff84d6fd033"></a><!-- doxytag: member="CPop3Example::~CPop3Example" ref="401645654f38c3e601b09ff84d6fd033" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPop3Example::~CPop3Example </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00078">78</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b349920e1fdb72d5dbf6186c52d319b6"></a><!-- doxytag: member="CPop3Example::NewL" ref="b349920e1fdb72d5dbf6186c52d319b6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_pop3_example.html">CPop3Example</a> * CPop3Example::NewL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Allocates and constructs a <a class="el" href="class_c_pop3_example.html">CPop3Example</a> object. Initialises all member data to their default values.
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00052">52</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e48622bc95aeac93981f58a7418258f9"></a><!-- doxytag: member="CPop3Example::HandleSessionEventL" ref="e48622bc95aeac93981f58a7418258f9" args="(TMsvSessionEvent aEvent, TAny *aArg1, TAny *aArg2, TAny *aArg3)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::HandleSessionEventL </td>
<td>(</td>
<td class="paramtype">TMsvSessionEvent </td>
<td class="paramname"> <em>aEvent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TAny * </td>
<td class="paramname"> <em>aArg3</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Implements the session observer interface to update the registry information when MTM groups are installed or uninstalled. Invoked by the active object mechanism. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aEvent</em> </td><td>Event type </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aArg1</em> </td><td>Event type-specific argument value (unused) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aArg2</em> </td><td>Event type-specific argument value (unused) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aArg3</em> </td><td>Event type-specific argument value (unused) System wide error codes </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00354">354</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="071be1033b73bd98a19978d4bd90b7fb"></a><!-- doxytag: member="CPop3Example::CreateClientRegistryL" ref="071be1033b73bd98a19978d4bd90b7fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::CreateClientRegistryL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Starts a message server session, creates a client side mtm registry and pop client mtm. KErrNoMemory, KErrNotFound, KErrBadLibraryEntryPoint
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00096">96</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="e1b7a4e38a8771d202c637adb12302c2"></a><!-- doxytag: member="CPop3Example::CreatePopAndSmtpAccountL" ref="e1b7a4e38a8771d202c637adb12302c2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::CreatePopAndSmtpAccountL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a pop account and an smtp account. Sets the pop server address to system address and sets login name and password system wide error codes
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00122">122</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e14514a9a39eee71b372edc85a93b17"></a><!-- doxytag: member="CPop3Example::CreateSmtpMessageL" ref="4e14514a9a39eee71b372edc85a93b17" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::CreateSmtpMessageL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates an smtp message,stores and then commits settings to a specified message store. KErrNoMemory,KErrNotFound,KErrAccessDenied,Standard
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00190">190</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="681d0b120db69c06587235560f1e3b34"></a><!-- doxytag: member="CPop3Example::SendSMTPMessageL" ref="681d0b120db69c06587235560f1e3b34" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::SendSMTPMessageL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accesses the entry with the specified ID. Sets the context to the specified entry. Sends the created smtp mail. KErrNoMemory,KErrNotFound
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00254">254</a> of file <a class="el" href="pop3_example_8cpp-source.html">pop3Example.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="a6944f804b14759d3eaec2b791b78f0c"></a><!-- doxytag: member="CPop3Example::ConnectDownloadAndDisconnectPOPServerL" ref="a6944f804b14759d3eaec2b791b78f0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPop3Example::ConnectDownloadAndDisconnectPOPServerL </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Changes the entry on which later actions are performed to the entry with the specified TMsvId. Connects to the pop server. Downloads the mail sent using smtp and disconnects from the service. KErrNoMemory,KErrNotFound,KErrNotSupported,system wide error codes
<p>Definition at line <a class="el" href="pop3_example_8cpp-source.html#l00297">297</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:07 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>