<?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::GetMetaDataJob 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_1GetMetaDataJob.html">GetMetaDataJob</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classKIMAP_1_1GetMetaDataJob-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KIMAP::GetMetaDataJob Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="getmetadatajob_8h_source.html">getmetadatajob.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KIMAP::GetMetaDataJob:</div>
<div class="dyncontent">
<div class="center">
<img src="classKIMAP_1_1GetMetaDataJob.png" usemap="#KIMAP::GetMetaDataJob_map" alt=""/>
<map id="KIMAP::GetMetaDataJob_map" name="KIMAP::GetMetaDataJob_map">
<area href="classKIMAP_1_1MetaDataJobBase.html" title="Base class for jobs that operate on mailbox metadata." alt="KIMAP::MetaDataJobBase" shape="rect" coords="0,0,160,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a3dc84ff1310388c21845fc6f277567ed"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567ed">Depth</a> { <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567edabbe6135488a0521fbb1d389b18319239">NoDepth</a> = 0,
<a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567edaa36e134840226717928f5c9a1aa7a606">OneLevel</a>,
<a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567eda2c5a9a6e29149f73b31da10a0c0acd64">AllLevels</a>
}</td></tr>
<tr class="separator:a3dc84ff1310388c21845fc6f277567ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_types_classKIMAP_1_1MetaDataJobBase"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classKIMAP_1_1MetaDataJobBase')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classKIMAP_1_1MetaDataJobBase.html">KIMAP::MetaDataJobBase</a></td></tr>
<tr class="memitem:a84fa57cdfdbe30d6f7e44d0dafe0b1de inherit pub_types_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a84fa57cdfdbe30d6f7e44d0dafe0b1de">ServerCapability</a> { <a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a84fa57cdfdbe30d6f7e44d0dafe0b1deae9dea8a392120c5d36cff66657678ccb">Metadata</a> = 0,
<a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a84fa57cdfdbe30d6f7e44d0dafe0b1dea709ee45a9579b71d23dd26fca78880cb">Annotatemore</a>
}</td></tr>
<tr class="separator:a84fa57cdfdbe30d6f7e44d0dafe0b1de inherit pub_types_classKIMAP_1_1MetaDataJobBase"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:ad1d162c2c1c2198946a35aa396c098c9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1d162c2c1c2198946a35aa396c098c9"></a>
 </td><td class="memItemRight" valign="bottom"><b>GetMetaDataJob</b> (Session *session)</td></tr>
<tr class="separator:ad1d162c2c1c2198946a35aa396c098c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a53064d35577bbf5519c4192bc09184c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a53064d35577bbf5519c4192bc09184c6">addEntry</a> (const QByteArray &entry, const QByteArray &attribute=QByteArray())</td></tr>
<tr class="separator:a53064d35577bbf5519c4192bc09184c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a163a932a3eb84e41fd510413db973a73"><td class="memItemLeft" align="right" valign="top">QMap< QByteArray, QMap<br class="typebreak"/>
< QByteArray, QByteArray > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a163a932a3eb84e41fd510413db973a73">allMetaData</a> (const QString &<a class="el" href="classKIMAP_1_1MetaDataJobBase.html#aed4f58a82f0e920708f352142a687992">mailBox</a>) const </td></tr>
<tr class="separator:a163a932a3eb84e41fd510413db973a73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57a92920714e81c5e4620496f84b87be"><td class="memItemLeft" align="right" valign="top">QByteArray </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a57a92920714e81c5e4620496f84b87be">metaData</a> (const QString &<a class="el" href="classKIMAP_1_1MetaDataJobBase.html#aed4f58a82f0e920708f352142a687992">mailBox</a>, const QByteArray &entry, const QByteArray &attribute=QByteArray()) const </td></tr>
<tr class="separator:a57a92920714e81c5e4620496f84b87be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86105952c6ea6926f3e0d4c3988d1105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a86105952c6ea6926f3e0d4c3988d1105">setDepth</a> (<a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567ed">Depth</a> depth)</td></tr>
<tr class="separator:a86105952c6ea6926f3e0d4c3988d1105"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac90de8a3c2ef91fa8930f1e0db8e080e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#ac90de8a3c2ef91fa8930f1e0db8e080e">setMaximumSize</a> (qint64 size)</td></tr>
<tr class="separator:ac90de8a3c2ef91fa8930f1e0db8e080e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classKIMAP_1_1MetaDataJobBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classKIMAP_1_1MetaDataJobBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classKIMAP_1_1MetaDataJobBase.html">KIMAP::MetaDataJobBase</a></td></tr>
<tr class="memitem:a63c5c58a9f1fcad8d33ee39da09f90dd inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63c5c58a9f1fcad8d33ee39da09f90dd"></a>
 </td><td class="memItemRight" valign="bottom"><b>MetaDataJobBase</b> (Session *session)</td></tr>
<tr class="separator:a63c5c58a9f1fcad8d33ee39da09f90dd inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed4f58a82f0e920708f352142a687992 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#aed4f58a82f0e920708f352142a687992">mailBox</a> () const </td></tr>
<tr class="separator:aed4f58a82f0e920708f352142a687992 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f5ddeabbef5d71c595ff53b8b56286d inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a84fa57cdfdbe30d6f7e44d0dafe0b1de">ServerCapability</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a1f5ddeabbef5d71c595ff53b8b56286d">serverCapability</a> () const </td></tr>
<tr class="separator:a1f5ddeabbef5d71c595ff53b8b56286d inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d68d23dd16790c56fd9f443d89f9d25 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a6d68d23dd16790c56fd9f443d89f9d25">setMailBox</a> (const QString &<a class="el" href="classKIMAP_1_1MetaDataJobBase.html#aed4f58a82f0e920708f352142a687992">mailBox</a>)</td></tr>
<tr class="separator:a6d68d23dd16790c56fd9f443d89f9d25 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46e6b001fccc3b101b79fe8e2b074dd4 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a46e6b001fccc3b101b79fe8e2b074dd4">setServerCapability</a> (const <a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a84fa57cdfdbe30d6f7e44d0dafe0b1de">ServerCapability</a> &capability)</td></tr>
<tr class="separator:a46e6b001fccc3b101b79fe8e2b074dd4 inherit pub_methods_classKIMAP_1_1MetaDataJobBase"><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:a35813a22842b804f1b02e0dcb9a93345"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35813a22842b804f1b02e0dcb9a93345"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>doStart</b> ()</td></tr>
<tr class="separator:a35813a22842b804f1b02e0dcb9a93345"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e3af7a22c2e13940b4fea958bad5328"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e3af7a22c2e13940b4fea958bad5328"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>handleResponse</b> (const Message &response)</td></tr>
<tr class="separator:a8e3af7a22c2e13940b4fea958bad5328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classKIMAP_1_1MetaDataJobBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classKIMAP_1_1MetaDataJobBase')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classKIMAP_1_1MetaDataJobBase.html">KIMAP::MetaDataJobBase</a></td></tr>
<tr class="memitem:a8f69ae5f06c3e4193a312a5be17b4e7e inherit pro_methods_classKIMAP_1_1MetaDataJobBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f69ae5f06c3e4193a312a5be17b4e7e"></a>
 </td><td class="memItemRight" valign="bottom"><b>MetaDataJobBase</b> (JobPrivate &dd)</td></tr>
<tr class="separator:a8f69ae5f06c3e4193a312a5be17b4e7e inherit pro_methods_classKIMAP_1_1MetaDataJobBase"><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>Fetches mailbox metadata. </p>
<p>Provides support for the IMAP METADATA extension; both the final RFC version (<a href="http://tools.ietf.org/html/rfc5464">RFC 5464</a>) and the older, incompatible draft version (known as ANNOTATEMORE) (<a href="http://tools.ietf.org/html/draft-daboo-imap-annotatemore-07">draft-daboo-imap-annotatemore-07</a>). See setServerCompatibility().</p>
<p>This job can only be run when the session is in the authenticated (or selected) state.</p>
<p>If the server supports ACLs, the user will need the <a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a7409566c3f434a26746dd1008a18ea7b" title="Mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox.">Acl::Lookup</a> right on the mailbox, as well as one of</p>
<ul>
<li><a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171aba809f2dc705cfff259297ad932ff678" title="SELECT the mailbox, perform STATUS.">Acl::Read</a></li>
<li><a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a2bc3ad3fb3c4721fe0903e75c3ca2a71" title="Set or clear the flag on messages in the mailbox, and keep it across sessions.">Acl::KeepSeen</a></li>
<li><a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171abc27e47671013cf73f40da00b375ebdf" title="Set or clear flags other than and on messages in the mailbox.">Acl::Write</a></li>
<li><a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a407f3f769a0084dba3f246f683473403" title="Perform APPEND and COPY with the mailbox as the target.">Acl::Insert</a></li>
<li><a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a9182dfdfc7c2574192d21bc19aaa9fe4" title="Send mail to the submission address for the mailbox.">Acl::Post</a> Otherwise, the user must be able to list the mailbox and either read or write the message content.</li>
</ul>
<p>Note also that on servers that implement the Annotatemore version of the extension, only <a class="el" href="namespaceKIMAP_1_1Acl.html#a297cd72adddacd10f027051ff0ca2171a7409566c3f434a26746dd1008a18ea7b" title="Mailbox is visible to LIST/LSUB commands, SUBSCRIBE mailbox.">Acl::Lookup</a> rights are required (ie: the user must be able to list the mailbox). </p>
<p>Definition at line <a class="el" href="getmetadatajob_8h_source.html#l00061">61</a> of file <a class="el" href="getmetadatajob_8h_source.html">getmetadatajob.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a3dc84ff1310388c21845fc6f277567ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567ed">KIMAP::GetMetaDataJob::Depth</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to specify the depth of the metadata heirachy to walk. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a3dc84ff1310388c21845fc6f277567edabbe6135488a0521fbb1d389b18319239"></a>NoDepth</em> </td><td class="fielddoc">
<p>Only the requested entries. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3dc84ff1310388c21845fc6f277567edaa36e134840226717928f5c9a1aa7a606"></a>OneLevel</em> </td><td class="fielddoc">
<p>The requested entries and all their direct children. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="a3dc84ff1310388c21845fc6f277567eda2c5a9a6e29149f73b31da10a0c0acd64"></a>AllLevels</em> </td><td class="fielddoc">
<p>The requested entries and all their descendants. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="getmetadatajob_8h_source.html#l00075">75</a> of file <a class="el" href="getmetadatajob_8h_source.html">getmetadatajob.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a53064d35577bbf5519c4192bc09184c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetMetaDataJob::addEntry </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>attribute</em> = <code>QByteArray()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an entry to the query list. </p>
<p>See <a class="el" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a> for a description of metadata entry names.</p>
<p>When operating in Annotatemore mode, you should provide an attribute name. Typically this will be "value", "value.priv" or "value.shared", although you might want to fetch the "content-type" or "content-language" attributes as well.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>the metadata entry name </td></tr>
<tr><td class="paramname">attribute</td><td>the attribute name, in Annotatemore mode </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="getmetadatajob_8cpp_source.html#l00162">162</a> of file <a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a163a932a3eb84e41fd510413db973a73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< QByteArray, QMap< QByteArray, QByteArray > > GetMetaDataJob::allMetaData </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>mailBox</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get all the metadata for a given mailbox. </p>
<p>The returned map is from metadata entry names to attributes or values.</p>
<p>If operating in Metadata mode, the metadata value is stored against the empty QByteArray: </p>
<div class="fragment"><div class="line">map = job.allMetaData( <span class="stringliteral">"INBOX"</span> );</div>
<div class="line">QByteArray value = map[ <span class="stringliteral">"/shared/comment"</span> ].value( QByteArray() );</div>
</div><!-- fragment --><p>The equivalent in Annotatemore mode would be: </p>
<div class="fragment"><div class="line">map = job.allMetaData( <span class="stringliteral">"INBOX"</span> );</div>
<div class="line">QByteArray value = map[ <span class="stringliteral">"/comment"</span> ].value( <span class="stringliteral">"value.shared"</span> );</div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailBox</td><td>a mailbox name or an empty string for server metadata </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a map from metadata entry names to attributes or values </dd></dl>
<p>Definition at line <a class="el" href="getmetadatajob_8cpp_source.html#l00212">212</a> of file <a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a57a92920714e81c5e4620496f84b87be"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QByteArray GetMetaDataJob::metaData </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>mailBox</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>attribute</em> = <code>QByteArray()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a single metadata entry. </p>
<p>The metadata must have been requested using <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a53064d35577bbf5519c4192bc09184c6" title="Add an entry to the query list.">addEntry()</a>, and the job must have completed successfully, or this method will not return anything.</p>
<p>Note that if <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#ac90de8a3c2ef91fa8930f1e0db8e080e" title="Limits the size of returned metadata entries.">setMaximumSize()</a> was used to limit the size of returned metadata, this method may return an empty QByteArray even if the metadata entry was requested and exists on the server. This will happen when the metadata entry is larger than the size limit given to <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#ac90de8a3c2ef91fa8930f1e0db8e080e" title="Limits the size of returned metadata entries.">setMaximumSize()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailBox</td><td>the mailbox the metadata is attached to, or an empty string for server metadata </td></tr>
<tr><td class="paramname">entry</td><td>the entry to get </td></tr>
<tr><td class="paramname">attribute</td><td>(only in Annotatemore mode) the attribute to get </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the metadata entry value </dd></dl>
<p>Definition at line <a class="el" href="getmetadatajob_8cpp_source.html#l00194">194</a> of file <a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a86105952c6ea6926f3e0d4c3988d1105"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetMetaDataJob::setDepth </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a3dc84ff1310388c21845fc6f277567ed">Depth</a> </td>
<td class="paramname"><em>depth</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether to retrieve children or descendants of the requested entries. </p>
<p>Metadata entry names are heirachical, much like UNIX path names. It therefore makes sense to ask for an entry and all its children (OneLevel) or an entry and all its descendants (AllLevels).</p>
<p>For example, /shared/foo/bar/baz is a child of /shared/foo/bar and a descendent of /shared/foo. So if you request the entry "/shared/foo" with depth NoDepth, you will only get the "/shared/foo" entry. If you set the depth to OneLevel, you will also get "/shared/foo/bar". If you set the depth to AllLevels, you will also get "/shared/foo/bar/baz", and every other metadata entry that starts with "/shared/foo/".</p>
<p>Note that this is only used when the server capability mode is Metadata.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">depth</td><td>the depth of the metadata tree to return </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="getmetadatajob_8cpp_source.html#l00178">178</a> of file <a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac90de8a3c2ef91fa8930f1e0db8e080e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetMetaDataJob::setMaximumSize </td>
<td>(</td>
<td class="paramtype">qint64 </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Limits the size of returned metadata entries. </p>
<p>In order to save time or bandwidth, it is possible to prevent the server from returning metadata entries that are larger than a certain size. These entries will simply not appear in the list returned by <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a163a932a3eb84e41fd510413db973a73" title="Get all the metadata for a given mailbox.">allMetaData()</a>, and will not be accessible using <a class="el" href="classKIMAP_1_1GetMetaDataJob.html#a57a92920714e81c5e4620496f84b87be" title="Get a single metadata entry.">metaData()</a>.</p>
<p>Note that this is only used when the server capability mode is Metadata.</p>
<p>The default is no limit (-1). A value of less than -1 will cause the job to fail.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>the entry size limit, in octets, or -1 for no limit </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="getmetadatajob_8cpp_source.html#l00172">172</a> of file <a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="getmetadatajob_8h_source.html">getmetadatajob.h</a></li>
<li><a class="el" href="getmetadatajob_8cpp_source.html">getmetadatajob.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>
