<?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" xml:lang="en">
<head>
<title>MBoxProtocol Class Reference</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="meta" href="http://www.kde.org/labels.rdf" type="application/rdf+xml" title="ICRA labels" />
<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" />
<meta name="no-email-collection" content="http://www.unspam.com/noemailcollection" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link rel="shortcut icon" href="../../../favicon.ico" /><link rel="icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../../../kde.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="../../../print.css" />
<link rel="stylesheet" media="screen, aural, handheld, tty, braille" type="text/css" title="Flat" href="../../../flat.css" />
<link rel="stylesheet" type="text/css" href="../../../doxygen.css" />
<link rel="stylesheet" type="text/css" href="../../../tabs.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div>
<img alt ="" src="../../../top-kde.jpg"/>
</div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="http://api.kde.org">KDE API Reference</a></li>
<li><a href="../../../index.html">kdepimlibs-4.10.5 API Reference</a></li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="http://www.kde.org/">KDE Home</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h2><a name="content"></a>kioslave/mbox</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classMBoxProtocol-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MBoxProtocol Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="mbox_8h_source.html">mbox.h</a>></code></p>
<p>Inherits SlaveBase.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a67f04bebf389cbbfec242787685e3baa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#a67f04bebf389cbbfec242787685e3baa">MBoxProtocol</a> (const QByteArray &, const QByteArray &)</td></tr>
<tr class="separator:a67f04bebf389cbbfec242787685e3baa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac999d765adb026b72c1c8ed7dbdec300"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#ac999d765adb026b72c1c8ed7dbdec300">~MBoxProtocol</a> ()</td></tr>
<tr class="separator:ac999d765adb026b72c1c8ed7dbdec300"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbf8c9611d1ca9b144ab4ab407f2ea68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#abbf8c9611d1ca9b144ab4ab407f2ea68">emitError</a> (int _errno, const QString &arg)</td></tr>
<tr class="separator:abbf8c9611d1ca9b144ab4ab407f2ea68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18a9fe664fadb23e5b6cb78fbbb11a7d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#a18a9fe664fadb23e5b6cb78fbbb11a7d">get</a> (const KUrl &url)</td></tr>
<tr class="separator:a18a9fe664fadb23e5b6cb78fbbb11a7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a334d5abb5f0e289dc174757258e6d2b9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#a334d5abb5f0e289dc174757258e6d2b9">listDir</a> (const KUrl &url)</td></tr>
<tr class="separator:a334d5abb5f0e289dc174757258e6d2b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd9550ce9fb518bd1cae53d3f89b7957"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#acd9550ce9fb518bd1cae53d3f89b7957">mimetype</a> (const KUrl &url)</td></tr>
<tr class="separator:acd9550ce9fb518bd1cae53d3f89b7957"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5061c26f3288286722997fa2126ff728"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMBoxProtocol.html#a5061c26f3288286722997fa2126ff728">stat</a> (const KUrl &url)</td></tr>
<tr class="separator:a5061c26f3288286722997fa2126ff728"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is the main class and implements all function which can be called through the user. </p>
<p>Definition at line <a class="el" href="mbox_8h_source.html#l00033">33</a> of file <a class="el" href="mbox_8h_source.html">mbox.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a67f04bebf389cbbfec242787685e3baa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MBoxProtocol::MBoxProtocol </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>arg2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor, for the parameters, See KIO::SlaveBase. </p>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00057">57</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac999d765adb026b72c1c8ed7dbdec300"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">MBoxProtocol::~MBoxProtocol </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Empty destructor. </p>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00064">64</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abbf8c9611d1ca9b144ab4ab407f2ea68"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MBoxProtocol::emitError </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>_errno</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>arg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Through this functions, other class which have an instance to this class (classes which are part of kio_mbox) can emit an error with this function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">errno</td><td>The error number to be thrown </td></tr>
<tr><td class="paramname">arg</td><td>The argument of the error message of the error number. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00159">159</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a18a9fe664fadb23e5b6cb78fbbb11a7d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MBoxProtocol::get </td>
<td>(</td>
<td class="paramtype">const KUrl & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This functions is used when an user or a program wants to get a file from a mbox-file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>The url which points to the virtual file to get </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00068">68</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a334d5abb5f0e289dc174757258e6d2b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MBoxProtocol::listDir </td>
<td>(</td>
<td class="paramtype">const KUrl & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This functions gives a listing back. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>The url to the mbox-file. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00101">101</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd9550ce9fb518bd1cae53d3f89b7957"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MBoxProtocol::mimetype </td>
<td>(</td>
<td class="paramtype">const KUrl & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This functions determinate the mimetype of a given mbox-file or mbox-email. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">url</td><td>The url to get the mimetype from </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00143">143</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5061c26f3288286722997fa2126ff728"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MBoxProtocol::stat </td>
<td>(</td>
<td class="paramtype">const KUrl & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This functions gives general properties about a mbox-file, or mbox-email back. </p>
<p>Definition at line <a class="el" href="mbox_8cpp_source.html#l00129">129</a> of file <a class="el" href="mbox_8cpp_source.html">mbox.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="mbox_8h_source.html">mbox.h</a></li>
<li><a class="el" href="mbox_8cpp_source.html">mbox.cpp</a></li>
</ul>
</div><!-- contents -->
<div class="copyrights">
This file is part of the KDE documentation.<br/>
Documentation copyright © 1996-2013 The KDE developers.<br/>
Generated on Fri Jul 12 2013 16:48:15 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.3.1 written
by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2006
<p>
KDE's <a href="http://techbase.kde.org/Policies/Library_Documentation_Policy">Doxygen guidelines</a> are available online.
</p>
</div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kioslave/mbox</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kioslave/mbox"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="functions.html">Class Members</a></li><li><a href="files.html">File List</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="classMBoxFile.html">mboxfile</option>, <option value="classMBoxProtocol.html">mboxprotocol</option>, <option value="classReadMBox.html">readmbox</option>, <option value="classStat.html">stat</option>,
</select>
</form>
</div>
-->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">kdepimlibs-4.10.5 API Reference</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "kdepimlibs-4.10.5 API Reference"</a>
</div></div>
<div class="nav_list">
<ul>
<li><a href="../../../akonadi/html/index.html">akonadi</a></li><li> <a href="../../../akonadi/contact/html/index.html">contact</a></li><li> <a href="../../../akonadi/kmime/html/index.html">kmime</a></li><li> <a href="../../../akonadi/socialutils/html/index.html">socialutils</a></li><li><a href="../../../kabc/html/index.html">kabc</a></li><li><a href="../../../kalarmcal/html/index.html">kalarmcal</a></li><li><a href="../../../kblog/html/index.html">kblog</a></li><li><a href="../../../kcal/html/index.html">kcal</a></li><li><a href="../../../kcalcore/html/index.html">kcalcore</a></li><li><a href="../../../kcalutils/html/index.html">kcalutils</a></li><li><a href="../../../kholidays/html/index.html">kholidays</a></li><li><a href="../../../kimap/html/index.html">kimap</a></li><li><a href="../../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../../kioslave/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslave/mbox/html/index.html">mbox</a></li><li> <a href="../../../kioslave/nntp/html/index.html">nntp</a></li><li><a href="../../../kldap/html/index.html">kldap</a></li><li><a href="../../../kmbox/html/index.html">kmbox</a></li><li><a href="../../../kmime/html/index.html">kmime</a></li><li><a href="../../../kontactinterface/html/index.html">kontactinterface</a></li><li><a href="../../../kpimidentities/html/index.html">kpimidentities</a></li><li><a href="../../../kpimtextedit/html/index.html">kpimtextedit</a></li><li><a href="../../../kpimutils/html/index.html">kpimutils</a></li><li><a href="../../../kresources/html/index.html">kresources</a></li><li><a href="../../../ktnef/html/index.html">ktnef</a></li><li><a href="../../../kxmlrpcclient/html/index.html">kxmlrpcclient</a></li><li><a href="../../../mailtransport/html/index.html">mailtransport</a></li><li><a href="../../../microblog/html/index.html">microblog</a></li><li><a href="../../../qgpgme/html/index.html">qgpgme</a></li><li><a href="../../../syndication/html/index.html">syndication</a></li><li> <a href="../../../syndication/atom/html/index.html">atom</a></li><li> <a href="../../../syndication/rdf/html/index.html">rdf</a></li><li> <a href="../../../syndication/rss2/html/index.html">rss2</a></li>
</ul></div></div>
<!-- api_searchbox -->
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Report problems with this website to <a href="https://bugs.kde.org/enter_sysadmin_request.cgi?component=api.kde.org">our bug tracking system</a>.<br>
Contact the specific authors with questions and comments about the page contents.<p>
KDE<sup>®</sup> and <a href="/media/images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a></p>
</div></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-45abe0e0c3bebc77@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
