/usr/share/doc/qmf/html/qmail.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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | <?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">
<!-- qmailnamespace.cpp -->
<head>
<title>QMail Namespace 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">QMail Namespace Reference</h1>
<p>The QMail namespace contains miscellaneous functionality used by the Messaging framework. <a href="#details">More...</a></p>
<pre> #include <QMail></pre><ul>
</ul>
<hr />
<a name="types"></a>
<h2>Types</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#SaslMechanism-enum">SaslMechanism</a></b> { NoMechanism, LoginMechanism, PlainMechanism, CramMd5Mechanism }</td></tr>
</table>
<hr />
<a name="functions"></a>
<h2>Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#baseSubject">baseSubject</a></b> ( const QString & <i>subject</i>, bool * <i>replyOrForward</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QSqlDatabase </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#createDatabase">createDatabase</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#dataPath">dataPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#extensionsForMimeType">extensionsForMimeType</a></b> ( const QString & <i>mimeType</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#fileLock">fileLock</a></b> ( const QString & <i>lockFile</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#fileUnlock">fileUnlock</a></b> ( int <i>id</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#lastSystemErrorMessage">lastSystemErrorMessage</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#messageIdentifiers">messageIdentifiers</a></b> ( const QString & <i>str</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#messageServerPath">messageServerPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#messageSettingsPath">messageSettingsPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#mimeTypeFromFileName">mimeTypeFromFileName</a></b> ( const QString & <i>filename</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#pluginsPath">pluginsPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">StringType </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#quoteString">quoteString</a></b> ( const StringType & <i>src</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#sslCertsPath">sslCertsPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#tempPath">tempPath</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">StringType </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#unquoteString">unquoteString</a></b> ( const StringType & <i>src</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmail.html#usleep">usleep</a></b> ( unsigned long <i>usecs</i> )</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMail namespace contains miscellaneous functionality used by the Messaging framework.</p>
<hr />
<h2>Type Documentation</h2>
<h3 class="fn"><a name="SaslMechanism-enum"></a>enum QMail::SaslMechanism</h3>
<p>This enum type describes the available SASL (Simple Authentication and Security Layer <a href="http://www.ietf.org/rfc/rfc4422.txt">RFC 2822</a> ) mechanisms for authenticating with external servers using protocol plugins. They should be used in conjunction with a data security mechanism such as TLS (Transport Layer Security <a href="http://www.ietf.org/rfc4346">RFC 4346</a>)</p>
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
<tr><td valign="top"><tt>QMail::NoMechanism</tt></td><td align="center" valign="top"><tt>0</tt></td><td valign="top">No SASL mechanism will be used.</td></tr>
<tr><td valign="top"><tt>QMail::LoginMechanism</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">Simple clear-text user/password authentication mechanism, obsoleted by Plain.</td></tr>
<tr><td valign="top"><tt>QMail::PlainMechanism</tt></td><td align="center" valign="top"><tt>2</tt></td><td valign="top">Simple clear-text user/password authentication mechanism.</td></tr>
<tr><td valign="top"><tt>QMail::CramMd5Mechanism</tt></td><td align="center" valign="top"><tt>3</tt></td><td valign="top">A challenge-response authentication mechanism.</td></tr>
</table></p>
<hr />
<h2>Function Documentation</h2>
<h3 class="fn"><a name="baseSubject"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::baseSubject ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>subject</i>, bool * <i>replyOrForward</i> )</h3>
<p>Returns the 'base' form of <i>subject</i>, using the transformation defined by RFC5256. If the original subject contains any variant of the tokens "Re" or "Fwd" recognized by RFC5256, then <i>replyOrForward</i> will be set to true.</p>
<h3 class="fn"><a name="createDatabase"></a><a href="http://doc.trolltech.com/4.5/qsqldatabase.html">QSqlDatabase</a> QMail::createDatabase ()</h3>
<p>Returns the database where the Messaging framework will store its message meta-data. If the database does not exist, it is created.</p>
<h3 class="fn"><a name="dataPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::dataPath ()</h3>
<p>Returns the path to where the Messaging framework will store its data files.</p>
<h3 class="fn"><a name="extensionsForMimeType"></a><a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> QMail::extensionsForMimeType ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>mimeType</i> )</h3>
<p>Returns a list of valid file extensions for the mime type string <i>mimeType</i> or an empty list if the mime type is unrecognized.</p>
<h3 class="fn"><a name="fileLock"></a>int QMail::fileLock ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>lockFile</i> )</h3>
<p>Convenience function that attempts to obtain a lock on a file with name <i>lockFile</i>. It is not necessary to create <i>lockFile</i> as this file is created temporarily.</p>
<p>Returns the id of the lockFile if successful or <tt>-1</tt> for failure.</p>
<p>See also <a href="qmail.html#fileUnlock">QMail::fileUnlock</a>().</p>
<h3 class="fn"><a name="fileUnlock"></a>bool QMail::fileUnlock ( int <i>id</i> )</h3>
<p>Convenience function that attempts to unlock the file with identifier <i>id</i> that was locked by <tt>QMail::fileLock</tt>.</p>
<p>Returns <tt>true</tt> for success or <tt>false</tt> otherwise.</p>
<p>See also <a href="qmail.html#fileLock">QMail::fileLock</a>().</p>
<h3 class="fn"><a name="lastSystemErrorMessage"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::lastSystemErrorMessage ()</h3>
<p>Returns the text describing the last error reported by the underlying platform.</p>
<h3 class="fn"><a name="messageIdentifiers"></a><a href="http://doc.trolltech.com/4.5/qstringlist.html">QStringList</a> QMail::messageIdentifiers ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>str</i> )</h3>
<p>Returns the sequence of message identifiers that can be extracted from <i>str</i>. Message identifiers must conform to the definition given by RFC 5256.</p>
<h3 class="fn"><a name="messageServerPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::messageServerPath ()</h3>
<p>Returns the path to where the Messaging framework will invoke the messageserver process.</p>
<h3 class="fn"><a name="messageSettingsPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::messageSettingsPath ()</h3>
<p>Returns the path to where the Messaging framework will search for settings information.</p>
<h3 class="fn"><a name="mimeTypeFromFileName"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::mimeTypeFromFileName ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>filename</i> )</h3>
<p>Returns the string mime type based on the filename <i>filename</i>.</p>
<h3 class="fn"><a name="pluginsPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::pluginsPath ()</h3>
<p>Returns the path to where the Messaging framework will look for its plugin directories</p>
<h3 class="fn"><a name="quoteString"></a>StringType QMail::quoteString ( const StringType & <i>src</i> )</h3>
<p>Returns <i>src</i> surrounded by double-quotes, which are added if not already present.</p>
<h3 class="fn"><a name="sslCertsPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::sslCertsPath ()</h3>
<p>Returns the path to where the Messaging framework will search for SSL certificates.</p>
<h3 class="fn"><a name="tempPath"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMail::tempPath ()</h3>
<p>Returns the path to where the Messaging framework will store its temporary files.</p>
<h3 class="fn"><a name="unquoteString"></a>StringType QMail::unquoteString ( const StringType & <i>src</i> )</h3>
<p>If <i>src</i> has double-quote as the first and last characters, return the string between those characters; otherwise, return the original string.</p>
<h3 class="fn"><a name="usleep"></a>void QMail::usleep ( unsigned long <i>usecs</i> )</h3>
<p>Suspends the current process for <i>usecs</i> microseconds.</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>
|