<?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>KIMAP::CloseJob 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>KIMAP Library</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>KIMAP</b></li><li class="navelem"><a class="el" href="classKIMAP_1_1CloseJob.html">CloseJob</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classKIMAP_1_1CloseJob-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KIMAP::CloseJob Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="closejob_8h_source.html">closejob.h</a>></code></p>
<p>Inherits KIMAP::Job.</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:a18b8f34e6df04bb66a10d6a8ba9dadde"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18b8f34e6df04bb66a10d6a8ba9dadde"></a>
 </td><td class="memItemRight" valign="bottom"><b>CloseJob</b> (Session *session)</td></tr>
<tr class="separator:a18b8f34e6df04bb66a10d6a8ba9dadde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classKIMAP_1_1Job"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classKIMAP_1_1Job')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classKIMAP_1_1Job.html">KIMAP::Job</a></td></tr>
<tr class="memitem:a52d24efe2be115fe0f57eb912a15f29f inherit pub_methods_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52d24efe2be115fe0f57eb912a15f29f"></a>
Session * </td><td class="memItemRight" valign="bottom"><b>session</b> () const </td></tr>
<tr class="separator:a52d24efe2be115fe0f57eb912a15f29f inherit pub_methods_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e1752f8e61d0c6ae3eb2ee82f58a3d9 inherit pub_methods_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e1752f8e61d0c6ae3eb2ee82f58a3d9"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>start</b> ()</td></tr>
<tr class="separator:a1e1752f8e61d0c6ae3eb2ee82f58a3d9 inherit pub_methods_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ad2be4005745a43757a6043aa4cd4e39b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2be4005745a43757a6043aa4cd4e39b"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>doStart</b> ()</td></tr>
<tr class="separator:ad2be4005745a43757a6043aa4cd4e39b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classKIMAP_1_1Job"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classKIMAP_1_1Job')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classKIMAP_1_1Job.html">KIMAP::Job</a></td></tr>
<tr class="memitem:a80158cbd42766350508d657cabeeeb81 inherit pro_methods_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80158cbd42766350508d657cabeeeb81"></a>
 </td><td class="memItemRight" valign="bottom"><b>Job</b> (Session *session)</td></tr>
<tr class="separator:a80158cbd42766350508d657cabeeeb81 inherit pro_methods_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1838144305a5128d69f5951aeeb0e519 inherit pro_methods_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1838144305a5128d69f5951aeeb0e519"></a>
 </td><td class="memItemRight" valign="bottom"><b>Job</b> (JobPrivate &dd)</td></tr>
<tr class="separator:a1838144305a5128d69f5951aeeb0e519 inherit pro_methods_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82e9fae4f27b97c05574a28f4cb21a34 inherit pro_methods_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82e9fae4f27b97c05574a28f4cb21a34"></a>
HandlerResponse </td><td class="memItemRight" valign="bottom"><b>handleErrorReplies</b> (const Message &response)</td></tr>
<tr class="separator:a82e9fae4f27b97c05574a28f4cb21a34 inherit pro_methods_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classKIMAP_1_1Job"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classKIMAP_1_1Job')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classKIMAP_1_1Job.html">KIMAP::Job</a></td></tr>
<tr class="memitem:a3c4dac99187d2c5f442d43a1aa54fa00 inherit pro_types_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>HandlerResponse</b> { <b>Handled</b> = 0,
<b>NotHandled</b>
}</td></tr>
<tr class="separator:a3c4dac99187d2c5f442d43a1aa54fa00 inherit pro_types_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classKIMAP_1_1Job"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classKIMAP_1_1Job')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classKIMAP_1_1Job.html">KIMAP::Job</a></td></tr>
<tr class="memitem:a255ab2fc9c2e39911d58373ed356655e inherit pro_attribs_classKIMAP_1_1Job"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a255ab2fc9c2e39911d58373ed356655e"></a>
JobPrivate *const </td><td class="memItemRight" valign="bottom"><b>d_ptr</b></td></tr>
<tr class="separator:a255ab2fc9c2e39911d58373ed356655e inherit pro_attribs_classKIMAP_1_1Job"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Closes the current mailbox. </p>
<p>This job can only be run when the session is in the selected state.</p>
<p>Permanently removes all messages that have the \Deleted flag set from the currently selected mailbox, and returns to the authenticated state from the selected state.</p>
<p>The server will not provide any notifications of which messages were expunged, so this is quicker than doing an expunge and then implicitly closing the mailbox (by selecting or examining another mailbox or logging out).</p>
<p>No messages are removed if the mailbox is open in a read-only state, or if the server supports ACLs and the user does not have the <a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a021376460b40653179f3c851a6ade660" title="Expunge the messages in this mailbox.">Acl::Expunge</a> right on the mailbox. </p>
<p>Definition at line <a class="el" href="closejob_8h_source.html#l00052">52</a> of file <a class="el" href="closejob_8h_source.html">closejob.h</a>.</p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="closejob_8h_source.html">closejob.h</a></li>
<li><a class="el" href="closejob_8cpp_source.html">closejob.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:09 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">KIMAP Library</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "KIMAP Library"</a>
</div></div>
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="namespacemembers.html">Namespace Members</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><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="classKIMAP_1_1AclJobBase.html">kimap::acljobbase</option>, <option value="classKIMAP_1_1AppendJob.html">kimap::appendjob</option>, <option value="classKIMAP_1_1CapabilitiesJob.html">kimap::capabilitiesjob</option>, <option value="classKIMAP_1_1CloseJob.html">kimap::closejob</option>, <option value="classKIMAP_1_1CopyJob.html">kimap::copyjob</option>, <option value="classKIMAP_1_1CreateJob.html">kimap::createjob</option>, <option value="classKIMAP_1_1DeleteAclJob.html">kimap::deleteacljob</option>, <option value="classKIMAP_1_1DeleteJob.html">kimap::deletejob</option>, <option value="classKIMAP_1_1ExpungeJob.html">kimap::expungejob</option>, <option value="classKIMAP_1_1FetchJob.html">kimap::fetchjob</option>, <option value="classKIMAP_1_1GetAclJob.html">kimap::getacljob</option>, <option value="classKIMAP_1_1GetMetaDataJob.html">kimap::getmetadatajob</option>, <option value="classKIMAP_1_1GetQuotaJob.html">kimap::getquotajob</option>, <option value="classKIMAP_1_1GetQuotaRootJob.html">kimap::getquotarootjob</option>, <option value="classKIMAP_1_1IdleJob.html">kimap::idlejob</option>, <option value="classKIMAP_1_1ImapInterval.html">kimap::imapinterval</option>, <option value="classKIMAP_1_1ImapSet.html">kimap::imapset</option>, <option value="classKIMAP_1_1ImapStreamParser.html">kimap::imapstreamparser</option>, <option value="classKIMAP_1_1ListRightsJob.html">kimap::listrightsjob</option>, <option value="classKIMAP_1_1MetaDataJobBase.html">kimap::metadatajobbase</option>, <option value="classKIMAP_1_1MyRightsJob.html">kimap::myrightsjob</option>, <option value="classKIMAP_1_1QuotaJobBase.html">kimap::quotajobbase</option>, <option value="classKIMAP_1_1SessionUiProxy.html">kimap::sessionuiproxy</option>, <option value="classKIMAP_1_1SetAclJob.html">kimap::setacljob</option>, <option value="classKIMAP_1_1SetMetaDataJob.html">kimap::setmetadatajob</option>, <option value="classKIMAP_1_1SetQuotaJob.html">kimap::setquotajob</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>
