<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kioslaves/imap4: IMAP4Protocol Class Reference (kioslaves/imap4)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../../">API Reference</a>
/ <a href="../../html/index.html">kioslaves</a> / <a href=".">imap4</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>kioslaves/imap4</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>IMAP4Protocol Class Reference</h1><!-- doxytag: class="IMAP4Protocol" --><!-- doxytag: inherits="KIO::TCPSlaveBase,imapParser,mimeIO" --><code>#include <<a class="el" href="imap4_8h-source.html">imap4.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for IMAP4Protocol:</div>
<div class="dynsection">
<p><center><img src="classIMAP4Protocol.png" usemap="#IMAP4Protocol_map" border="0" alt=""></center>
<map name="IMAP4Protocol_map">
<area href="classmimeIO.html" alt="mimeIO" shape="rect" coords="0,0,97,24">
</map>
</div>
<p>
<a href="classIMAP4Protocol-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
IOSlave derived class.
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>References:<ul>
<li>RFC 2060 - Internet Message Access Protocol - Version 4rev1 - December 1996</li><li>RFC 2192 - IMAP URL Scheme - September 1997</li><li>RFC 1731 - IMAP Authentication Mechanisms - December 1994 (Discusses KERBEROSv4, GSSAPI, and S/Key)</li><li>RFC 2195 - IMAP/POP AUTHorize Extension for Simple Challenge/Response<ul>
<li>September 1997 (CRAM-MD5 authentication method)</li></ul>
</li><li>RFC 2104 - HMAC: Keyed-Hashing for Message Authentication - February 1997</li><li>RFC 2086 - IMAP4 ACL extension - January 1997</li><li><a href="http://www.ietf.org/internet-drafts/draft-daboo-imap-annotatemore-05.txt">http://www.ietf.org/internet-drafts/draft-daboo-imap-annotatemore-05.txt</a> IMAP ANNOTATEMORE draft - April 2004.</li></ul>
</dd></dl>
Supported URLs: <div class="fragment"><pre class="fragment">
imap://server/
imap://user:pass@server/
imap://user;AUTH=method:pass@server/
imap://server/folder/
* </pre></div> These URLs cause the following actions (in order):<ul>
<li>Prompt for user/pass, list all folders in home directory</li><li>Uses LOGIN to log in</li><li>Uses AUTHENTICATE to log in</li><li>List messages in folder</li></ul>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>API notes: Not receiving the required write access for a folder means ERR_CANNOT_OPEN_FOR_WRITING. ERR_DOES_NOT_EXIST is reserved for folders. </dd></dl>
<p>Definition at line <a class="el" href="imap4_8h-source.html#l00047">47</a> of file <a class="el" href="imap4_8h-source.html">imap4.h</a>.</p>
<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"><a class="anchor" name="b7197c0694bf6ed39e513d1c780f4e38"></a><!-- doxytag: member="IMAP4Protocol::IMAP4Protocol" ref="b7197c0694bf6ed39e513d1c780f4e38" args="(const QCString &pool, const QCString &app, bool isSSL)" -->
</td><td class="memItemRight" valign="bottom"><b>IMAP4Protocol</b> (const QCString &pool, const QCString &app, bool isSSL)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d061de390149f60416508eb10e9255c"></a><!-- doxytag: member="IMAP4Protocol::openConnection" ref="7d061de390149f60416508eb10e9255c" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>openConnection</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="19a3c7ea10c9cebcff793f35abd929b3"></a><!-- doxytag: member="IMAP4Protocol::closeConnection" ref="19a3c7ea10c9cebcff793f35abd929b3" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>closeConnection</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="784882a26bd9e8a0f2eee4934ec3ecb6"></a><!-- doxytag: member="IMAP4Protocol::setHost" ref="784882a26bd9e8a0f2eee4934ec3ecb6" args="(const QString &_host, int _port, const QString &_user, const QString &_pass)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setHost</b> (const QString &_host, int _port, const QString &_user, const QString &_pass)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#9fd710c6483a804b65c57ecfac0eeeab">get</a> (const KURL &_url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#7c7fec114f2ecb4d898aad79c29833c5">stat</a> (const KURL &_url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="486dc50bb562ce46b2f4796beeedbee1"></a><!-- doxytag: member="IMAP4Protocol::slave_status" ref="486dc50bb562ce46b2f4796beeedbee1" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>slave_status</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#0cd9c8e8bdc5b4d20fc1780703fa9647">del</a> (const KURL &_url, bool isFile)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#146711a428170d2b4d4ccd00c031f540">special</a> (const QByteArray &data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#21b5f6b9b4103f232ee925a481813903">listDir</a> (const KURL &_url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c73de82fb6442bedfc57f286e8f46bf7"></a><!-- doxytag: member="IMAP4Protocol::setSubURL" ref="c73de82fb6442bedfc57f286e8f46bf7" args="(const KURL &_url)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>setSubURL</b> (const KURL &_url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c9871d494d6099afddbf6e11332e8c7"></a><!-- doxytag: member="IMAP4Protocol::dispatch" ref="4c9871d494d6099afddbf6e11332e8c7" args="(int command, const QByteArray &data)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>dispatch</b> (int command, const QByteArray &data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#3b99ecb7c62fe970136c9712d458f5a2">mkdir</a> (const KURL &url, int permissions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="65f3c63226edaa6a5ebbcf5e8a0e1904"></a><!-- doxytag: member="IMAP4Protocol::put" ref="65f3c63226edaa6a5ebbcf5e8a0e1904" args="(const KURL &url, int permissions, bool overwrite, bool resume)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>put</b> (const KURL &url, int permissions, bool overwrite, bool resume)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f40551d8399d536337dd91f54713586"></a><!-- doxytag: member="IMAP4Protocol::rename" ref="1f40551d8399d536337dd91f54713586" args="(const KURL &src, const KURL &dest, bool overwrite)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>rename</b> (const KURL &src, const KURL &dest, bool overwrite)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37b50e18540ef9cfd82ce3142ad29c30"></a><!-- doxytag: member="IMAP4Protocol::copy" ref="37b50e18540ef9cfd82ce3142ad29c30" args="(const KURL &src, const KURL &dest, int permissions, bool overwrite)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>copy</b> (const KURL &src, const KURL &dest, int permissions, bool overwrite)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#a3312a811d0f80054710507585f42e6a">parseRelay</a> (const QByteArray &buffer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#df8b0019e72de277ad1f3250dcca2f3d">parseRelay</a> (ulong)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#6d95f8ed7293011c69a9984577d08b15">parseRead</a> (QByteArray &buffer, ulong len, ulong relay=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#af9abaf5da9214b5f020795f7bb28047">parseReadLine</a> (QByteArray &buffer, ulong relay=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#acf514405e1b50f3a24db0470235d007">parseWriteLine</a> (const QString &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#9050b7c6e60bd082c8418d14324fd3e5">outputLine</a> (const QCString &_str, int len=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#a8bbc20bf95dbc6538c10b1e3bc05757">flushOutput</a> (QString contentEncoding=QString::null)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0739c6e2afa3c36753c582331f53eeb8"></a><!-- doxytag: member="IMAP4Protocol::assureBox" ref="0739c6e2afa3c36753c582331f53eeb8" args="(const QString &aBox, bool readonly)" -->
bool </td><td class="memItemRight" valign="bottom"><b>assureBox</b> (const QString &aBox, bool readonly)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39423323fa73a36fd2ca086951ca7285"></a><!-- doxytag: member="IMAP4Protocol::myRead" ref="39423323fa73a36fd2ca086951ca7285" args="(void *data, ssize_t len)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><b>myRead</b> (void *data, ssize_t len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum IMAP_TYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#5a4c2e249dc42f1576fdc2d9f773fb0c">parseURL</a> (const KURL &_url, QString &_box, QString &_section, QString &_type, QString &_uid, QString &_validity, QString &_hierarchyDelimiter, QString &_info, bool cache=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9afa446adb6c4da56e64a29d4a791b58"></a><!-- doxytag: member="IMAP4Protocol::getMimeType" ref="9afa446adb6c4da56e64a29d4a791b58" args="(enum IMAP_TYPE)" -->
QString </td><td class="memItemRight" valign="bottom"><b>getMimeType</b> (enum IMAP_TYPE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="857d90e4734feb791db1061f902f3f17"></a><!-- doxytag: member="IMAP4Protocol::makeLogin" ref="857d90e4734feb791db1061f902f3f17" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>makeLogin</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3f542bb050837ccfb0a28ed3cedca86f"></a><!-- doxytag: member="IMAP4Protocol::outputLineStr" ref="3f542bb050837ccfb0a28ed3cedca86f" args="(const QString &_str)" -->
void </td><td class="memItemRight" valign="bottom"><b>outputLineStr</b> (const QString &_str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b2ac4cf3eea34f0d16b83265106296a"></a><!-- doxytag: member="IMAP4Protocol::doListEntry" ref="3b2ac4cf3eea34f0d16b83265106296a" args="(const KURL &_url, int stretch, imapCache *cache=NULL, bool withFlags=FALSE, bool withSubject=FALSE)" -->
void </td><td class="memItemRight" valign="bottom"><b>doListEntry</b> (const KURL &_url, int stretch, imapCache *cache=NULL, bool withFlags=FALSE, bool withSubject=FALSE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#a699ca1f28d1ac8c9f8f9763d73d0eb1">doListEntry</a> (const KURL &url, const QString &myBox, const imapList &item, bool appendPath=true)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#b69679750eac750c0c2753d1623f6e45">specialACLCommand</a> (int command, QDataStream &stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#5d97eac198aec68334f4f972a4521ce0">specialAnnotateMoreCommand</a> (int command, QDataStream &stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3daae653a7f80e8713f540adb800b24a"></a><!-- doxytag: member="IMAP4Protocol::specialQuotaCommand" ref="3daae653a7f80e8713f540adb800b24a" args="(int command, QDataStream &stream)" -->
void </td><td class="memItemRight" valign="bottom"><b>specialQuotaCommand</b> (int command, QDataStream &stream)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#59ddb4792b3f962a3a59b33f7ad3ccc0">specialSearchCommand</a> (QDataStream &)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIMAP4Protocol.html#f4a9c882f8b93d5bbdf78720b6b71187">specialCustomCommand</a> (QDataStream &)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9fd710c6483a804b65c57ecfac0eeeab"></a><!-- doxytag: member="IMAP4Protocol::get" ref="9fd710c6483a804b65c57ecfac0eeeab" args="(const KURL &_url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::get </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>_url</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get a message or part of a message the data is normally send as we get it from the server if you want the slave to decode the content (e.g.
<p>
for attachments) then append an additional INFO=DECODE to the URL
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00185">185</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c7fec114f2ecb4d898aad79c29833c5"></a><!-- doxytag: member="IMAP4Protocol::stat" ref="7c7fec114f2ecb4d898aad79c29833c5" args="(const KURL &_url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::stat </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>_url</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
stat a mailbox, message, attachment
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01829">1829</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="0cd9c8e8bdc5b4d20fc1780703fa9647"></a><!-- doxytag: member="IMAP4Protocol::del" ref="0cd9c8e8bdc5b4d20fc1780703fa9647" args="(const KURL &_url, bool isFile)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::del </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>isFile</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
delete a mailbox
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01071">1071</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="146711a428170d2b4d4ccd00c031f540"></a><!-- doxytag: member="IMAP4Protocol::special" ref="146711a428170d2b4d4ccd00c031f540" args="(const QByteArray &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::special </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"> <em>data</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Capabilites, NOOP, (Un)subscribe, Change status, Change ACL.
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01212">1212</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="21b5f6b9b4103f232ee925a481813903"></a><!-- doxytag: member="IMAP4Protocol::listDir" ref="21b5f6b9b4103f232ee925a481813903" args="(const KURL &_url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::listDir </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>_url</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
list a directory/mailbox
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00397">397</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="3b99ecb7c62fe970136c9712d458f5a2"></a><!-- doxytag: member="IMAP4Protocol::mkdir" ref="3b99ecb7c62fe970136c9712d458f5a2" args="(const KURL &url, int permissions)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::mkdir </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>permissions</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a mailbox
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00911">911</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="a3312a811d0f80054710507585f42e6a"></a><!-- doxytag: member="IMAP4Protocol::parseRelay" ref="a3312a811d0f80054710507585f42e6a" args="(const QByteArray &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::parseRelay </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"> <em>buffer</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the parser relay hook to send the fetched data directly to an upper level
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00641">641</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="df8b0019e72de277ad1f3250dcca2f3d"></a><!-- doxytag: member="IMAP4Protocol::parseRelay" ref="df8b0019e72de277ad1f3250dcca2f3d" args="(ulong)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::parseRelay </td>
<td>(</td>
<td class="paramtype">ulong </td>
<td class="paramname"> <em>len</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the parser relay hook to announce the fetched data directly to an upper level
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00661">661</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="6d95f8ed7293011c69a9984577d08b15"></a><!-- doxytag: member="IMAP4Protocol::parseRead" ref="6d95f8ed7293011c69a9984577d08b15" args="(QByteArray &buffer, ulong len, ulong relay=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IMAP4Protocol::parseRead </td>
<td>(</td>
<td class="paramtype">QByteArray & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ulong </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ulong </td>
<td class="paramname"> <em>relay</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the parser read at least len bytes
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00668">668</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="af9abaf5da9214b5f020795f7bb28047"></a><!-- doxytag: member="IMAP4Protocol::parseReadLine" ref="af9abaf5da9214b5f020795f7bb28047" args="(QByteArray &buffer, ulong relay=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IMAP4Protocol::parseReadLine </td>
<td>(</td>
<td class="paramtype">QByteArray & </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ulong </td>
<td class="paramname"> <em>relay</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the parser
<p>
read at least a line (up to CRLF)
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l00703">703</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="acf514405e1b50f3a24db0470235d007"></a><!-- doxytag: member="IMAP4Protocol::parseWriteLine" ref="acf514405e1b50f3a24db0470235d007" args="(const QString &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::parseWriteLine </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>aStr</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the parser
<p>
write argument to the server
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l02199">2199</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="9050b7c6e60bd082c8418d14324fd3e5"></a><!-- doxytag: member="IMAP4Protocol::outputLine" ref="9050b7c6e60bd082c8418d14324fd3e5" args="(const QCString &_str, int len=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IMAP4Protocol::outputLine </td>
<td>(</td>
<td class="paramtype">const QCString & </td>
<td class="paramname"> <em>_str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reimplement the <a class="el" href="classmimeIO.html">mimeIO</a>
<p>
<p>Reimplemented from <a class="el" href="classmimeIO.html">mimeIO</a>.</p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l02579">2579</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="a8bbc20bf95dbc6538c10b1e3bc05757"></a><!-- doxytag: member="IMAP4Protocol::flushOutput" ref="a8bbc20bf95dbc6538c10b1e3bc05757" args="(QString contentEncoding=QString::null)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::flushOutput </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>contentEncoding</em> = <code>QString::null</code> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send out cached data to the application
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l02608">2608</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="5a4c2e249dc42f1576fdc2d9f773fb0c"></a><!-- doxytag: member="IMAP4Protocol::parseURL" ref="5a4c2e249dc42f1576fdc2d9f773fb0c" args="(const KURL &_url, QString &_box, QString &_section, QString &_type, QString &_uid, QString &_validity, QString &_hierarchyDelimiter, QString &_info, bool cache=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum IMAP_TYPE IMAP4Protocol::parseURL </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>_url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_box</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_uid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_validity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_hierarchyDelimiter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString & </td>
<td class="paramname"> <em>_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>cache</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses the given URL The return values are set by parsing the URL and querying the server.
<p>
If you set caching to true the server is not queried but the type is always set to ITYPE_DIR_AND_BOX
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l02449">2449</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="a699ca1f28d1ac8c9f8f9763d73d0eb1"></a><!-- doxytag: member="IMAP4Protocol::doListEntry" ref="a699ca1f28d1ac8c9f8f9763d73d0eb1" args="(const KURL &url, const QString &myBox, const imapList &item, bool appendPath=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::doListEntry </td>
<td>(</td>
<td class="paramtype">const KURL & </td>
<td class="paramname"> <em>url</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>myBox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const imapList & </td>
<td class="paramname"> <em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>appendPath</em> = <code>true</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send a list entry (folder) to the application If <code>appendPath</code> is true the foldername will be appended to the path of <code>url</code>.
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l02325">2325</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="b69679750eac750c0c2753d1623f6e45"></a><!-- doxytag: member="IMAP4Protocol::specialACLCommand" ref="b69679750eac750c0c2753d1623f6e45" args="(int command, QDataStream &stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::specialACLCommand </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QDataStream & </td>
<td class="paramname"> <em>stream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send an ACL command which is identified by <code>command</code>.
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01435">1435</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="5d97eac198aec68334f4f972a4521ce0"></a><!-- doxytag: member="IMAP4Protocol::specialAnnotateMoreCommand" ref="5d97eac198aec68334f4f972a4521ce0" args="(int command, QDataStream &stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::specialAnnotateMoreCommand </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QDataStream & </td>
<td class="paramname"> <em>stream</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send an annotation command which is identified by <code>command</code>.
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01644">1644</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="59ddb4792b3f962a3a59b33f7ad3ccc0"></a><!-- doxytag: member="IMAP4Protocol::specialSearchCommand" ref="59ddb4792b3f962a3a59b33f7ad3ccc0" args="(QDataStream &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::specialSearchCommand </td>
<td>(</td>
<td class="paramtype">QDataStream & </td>
<td class="paramname"> <em>stream</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search current folder, the search string is passed as SECTION.
<p>
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01537">1537</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="f4a9c882f8b93d5bbdf78720b6b71187"></a><!-- doxytag: member="IMAP4Protocol::specialCustomCommand" ref="f4a9c882f8b93d5bbdf78720b6b71187" args="(QDataStream &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IMAP4Protocol::specialCustomCommand </td>
<td>(</td>
<td class="paramtype">QDataStream & </td>
<td class="paramname"> <em>stream</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send a custom command to the server.
<p>
<p>
In 'normal' mode we send the command with all information in one go and retrieve the result.<p>
In 'extended' mode we send a first header and push the data of the request in streaming mode.
<p>Definition at line <a class="el" href="imap4_8cc-source.html#l01565">1565</a> of file <a class="el" href="imap4_8cc-source.html">imap4.cc</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="imap4_8h-source.html">imap4.h</a><li><a class="el" href="imap4_8cc-source.html">imap4.cc</a></ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kioslaves/imap4</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classIMAP4Protocol.html">imap4protocol</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
