/usr/share/doc/qmf/html/qmailaccountconfiguration.html is in qmf-doc-html 1.0.7~2011w23.2-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 | <?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmailaccountconfiguration.cpp -->
<head>
<title>QMailAccountConfiguration Class Reference</title>
<link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png" border="0" /></td></tr></table><h1 class="title">QMailAccountConfiguration Class Reference</h1>
<p>The QMailAccountConfiguration class contains the configuration parameters of an account. <a href="#details">More...</a></p>
<pre> #include <QMailAccountConfiguration></pre><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailaccountconfiguration-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a></b> <tt> (preliminary)</tt></td></tr>
</table>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#QMailAccountConfiguration">QMailAccountConfiguration</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#QMailAccountConfiguration-2">QMailAccountConfiguration</a></b> ( const QMailAccountId & <i>id</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#addServiceConfiguration">addServiceConfiguration</a></b> ( const QString & <i>service</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailAccountId </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#id">id</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#removeServiceConfiguration">removeServiceConfiguration</a></b> ( const QString & <i>service</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ServiceConfiguration & </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#serviceConfiguration">serviceConfiguration</a></b> ( const QString & <i>service</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const ServiceConfiguration & </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#serviceConfiguration-2">serviceConfiguration</a></b> ( const QString & <i>service</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#services">services</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailaccountconfiguration.html#setId">setId</a></b> ( const QMailAccountId & <i>id</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMailAccountConfiguration class contains the configuration parameters of an account.</p>
<p>QMailAccountConfiguration provides the configuration information for a single account, as retrieved from the mail store. The configuration is stored as key-value pairs, grouped into services, where each service within the account has a different name. A service typically corresponds to a protocol used to implement the account.</p>
<p>To modify the configuration details, the <a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> class must be used. <a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> groupings may be added to and removed from the account configuration, but a service configuration may not be modified until it has been added. A service is not stored in the mail store until it has member parameters.</p>
<p><a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> objects are allocated by, and retained within the QMailAccountConfiguration object.</p>
<p>A <a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> object cannot be directly constructed, but can be acquired from the containing account's QMailAccountConfiguration object.</p>
<p>See also <a href="qmailaccountconfiguration.html#serviceConfiguration">QMailAccountConfiguration::serviceConfiguration</a>().</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QMailAccountConfiguration"></a>QMailAccountConfiguration::QMailAccountConfiguration ()</h3>
<p>Creates an empty configuration object which is not associated with any account.</p>
<h3 class="fn"><a name="QMailAccountConfiguration-2"></a>QMailAccountConfiguration::QMailAccountConfiguration ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>id</i> )</h3>
<p>Creates a configuration object which contains the configuration details of the account identified by <i>id</i>.</p>
<h3 class="fn"><a name="addServiceConfiguration"></a>bool QMailAccountConfiguration::addServiceConfiguration ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>service</i> )</h3>
<p>Adds a configuration for the service named <i>service</i> within the account configuration. Returns true if successful; otherwise returns false;</p>
<h3 class="fn"><a name="id"></a><a href="qmailaccountid.html">QMailAccountId</a> QMailAccountConfiguration::id () const</h3>
<p>Returns the identifier of the account that this configuration pertains to.</p>
<p>See also <a href="qmailaccountconfiguration.html#setId">setId</a>().</p>
<h3 class="fn"><a name="removeServiceConfiguration"></a>bool QMailAccountConfiguration::removeServiceConfiguration ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>service</i> )</h3>
<p>Removes the configuration for the service named <i>service</i> within the account configuration. Returns true if successful; otherwise returns false;</p>
<h3 class="fn"><a name="serviceConfiguration"></a><a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> & QMailAccountConfiguration::serviceConfiguration ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>service</i> )</h3>
<p>Returns the configuration for the service <i>service</i>, which must be present within the account configuration.</p>
<p><a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> instances are allocated by, and retained within the <a href="qmailaccountconfiguration.html">QMailAccountConfiguration</a> object.</p>
<h3 class="fn"><a name="serviceConfiguration-2"></a>const <a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> & QMailAccountConfiguration::serviceConfiguration ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>service</i> ) const</h3>
<p>Returns the configuration for the service <i>service</i>, which must be present within the account configuration.</p>
<p><a href="qmailaccountconfiguration-serviceconfiguration.html">ServiceConfiguration</a> instances are allocated by, and retained within the <a href="qmailaccountconfiguration.html">QMailAccountConfiguration</a> object.</p>
<p>See also <a href="qmailaccountconfiguration.html#serviceConfiguration">QMailAccountConfiguration::serviceConfiguration</a>().</p>
<h3 class="fn"><a name="services"></a><a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> QMailAccountConfiguration::services () const</h3>
<p>Returns a list of the services whose configurations are contained within the account configuration.</p>
<h3 class="fn"><a name="setId"></a>void QMailAccountConfiguration::setId ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>id</i> )</h3>
<p>Sets the configuration to pertain to the account identified by <i>id</i>.</p>
<p>See also <a href="qmailaccountconfiguration.html#id">id</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright © 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>
|