<?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::SetMetaDataJob 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_1SetMetaDataJob.html">SetMetaDataJob</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_1SetMetaDataJob-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KIMAP::SetMetaDataJob Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="setmetadatajob_8h_source.html">setmetadatajob.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KIMAP::SetMetaDataJob:</div>
<div class="dyncontent">
<div class="center">
<img src="classKIMAP_1_1SetMetaDataJob.png" usemap="#KIMAP::SetMetaDataJob_map" alt=""/>
<map id="KIMAP::SetMetaDataJob_map" name="KIMAP::SetMetaDataJob_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:acb459417f3990e90f0549711a8d61471"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471">MetaDataError</a> { <a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471ae0356e044b551f73913c302f99d7e2eb">NoError</a> = 0,
<a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471ad30bcab344a94d6c6b58d06a52402371">TooMany</a> = 1,
<a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471abe8454f02c9d0782bb8ccb918e3ae8fe">TooBig</a> = 2,
<a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471a7864657c7b4e5f3b7c2f0510d3bbcc84">NoPrivate</a> = 4
}</td></tr>
<tr class="separator:acb459417f3990e90f0549711a8d61471"><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:a1804d6956aa8e0558e1001e1d6d56dfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1804d6956aa8e0558e1001e1d6d56dfc"></a>
 </td><td class="memItemRight" valign="bottom"><b>SetMetaDataJob</b> (Session *session)</td></tr>
<tr class="separator:a1804d6956aa8e0558e1001e1d6d56dfc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f690d9e62fe04a48997e1ff9b041110"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1SetMetaDataJob.html#a8f690d9e62fe04a48997e1ff9b041110">addMetaData</a> (const QByteArray &name, const QByteArray &value)</td></tr>
<tr class="separator:a8f690d9e62fe04a48997e1ff9b041110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a771d891aa60157e22fc65a7d2fa3199d"><td class="memItemLeft" align="right" valign="top">qint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1SetMetaDataJob.html#a771d891aa60157e22fc65a7d2fa3199d">maxAcceptedSize</a> ()</td></tr>
<tr class="separator:a771d891aa60157e22fc65a7d2fa3199d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfc99e595c64490bbe5e9ba8d302d754"><td class="memItemLeft" align="right" valign="top">MetaDataErrors </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1SetMetaDataJob.html#abfc99e595c64490bbe5e9ba8d302d754">metaDataErrors</a> () const </td></tr>
<tr class="separator:abfc99e595c64490bbe5e9ba8d302d754"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3af93fad6bbe5be161ad59dda8b3744"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1SetMetaDataJob.html#aa3af93fad6bbe5be161ad59dda8b3744">setEntry</a> (const QByteArray &entry)</td></tr>
<tr class="separator:aa3af93fad6bbe5be161ad59dda8b3744"><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:a7921ddc92a161bd1e70722e9b481a2c1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7921ddc92a161bd1e70722e9b481a2c1"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>doStart</b> ()</td></tr>
<tr class="separator:a7921ddc92a161bd1e70722e9b481a2c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1785f4afaf25966dc7474f318208ba8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1785f4afaf25966dc7474f318208ba8"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>handleResponse</b> (const Message &response)</td></tr>
<tr class="separator:ad1785f4afaf25966dc7474f318208ba8"><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>Sets 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>Note that in Annotatemore mode, this job can only operate on one metadata entry at once.</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 that even if the user has these permissions, the server may refuse to allow the user to write metadata based on some other criteria.</p>
<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="setmetadatajob_8h_source.html#l00068">68</a> of file <a class="el" href="setmetadatajob_8h_source.html">setmetadatajob.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="acb459417f3990e90f0549711a8d61471"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471">KIMAP::SetMetaDataJob::MetaDataError</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible error codes that may be returned by the server. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="acb459417f3990e90f0549711a8d61471ae0356e044b551f73913c302f99d7e2eb"></a>NoError</em> </td><td class="fielddoc">
<p>Used to indicate that no errors have been received. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acb459417f3990e90f0549711a8d61471ad30bcab344a94d6c6b58d06a52402371"></a>TooMany</em> </td><td class="fielddoc">
<p>Cannot add a new metadata item, because the limit has already been reached. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acb459417f3990e90f0549711a8d61471abe8454f02c9d0782bb8ccb918e3ae8fe"></a>TooBig</em> </td><td class="fielddoc">
<p>A metadata value was too big (see <a class="el" href="classKIMAP_1_1SetMetaDataJob.html#a771d891aa60157e22fc65a7d2fa3199d" title="The maximum accepted metadata size.">maxAcceptedSize()</a>) </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="acb459417f3990e90f0549711a8d61471a7864657c7b4e5f3b7c2f0510d3bbcc84"></a>NoPrivate</em> </td><td class="fielddoc">
<p>The server does not support private metadata entries. </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="setmetadatajob_8h_source.html#l00179">179</a> of file <a class="el" href="setmetadatajob_8h_source.html">setmetadatajob.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8f690d9e62fe04a48997e1ff9b041110"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SetMetaDataJob::addMetaData </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a metadata entry or attribute to the list of modifications to make. </p>
<p>When in Metadata mode, this method adds a metadata entry to the list of metadata additions and updates that will be performed when the job is run.</p>
<p><code>name</code> must be a valid ASCII string and may not contain two consecutive forward slashes ('/'), must not end with '/' and must not contain '*', '', non-ASCII characters or characters in the ASCII range 0x00 to 0x19 (in practice, all control characters should be avoided). The name is case-insensitive.</p>
<p>The first part of the entry name should be "/private" or "/shared", indicating the scope of the entry. Note that private metadata may not be supported by all servers.</p>
<p>Server metadata entry names include:</p>
<ul>
<li>/shared/comment</li>
<li>/shared/admin - a URI for contacting the server administrator (eg: a mailto: or tel: URI)</li>
<li>/shared/vendor/<vendor-token>/something</li>
<li>/private/vendor/<vendor-token>/something</li>
</ul>
<p>Mailbox metadata entry names include:</p>
<ul>
<li>/shared/comment</li>
<li>/private/comment</li>
<li>/shared/vendor/<vendor-token>/something</li>
<li>/private/vendor/<vendor-token>/something</li>
</ul>
<p><code>value</code> can be any data, although if it is a multi-line string value, CRLF line-endings must be used.</p>
<p>When in Annotatemore mode, this method adds an attribute entry to the list of additions and updates that will be performed on the metadata entry when the job is run.</p>
<p><code>name</code> must be a valid UTF-8 string, and may not contain the '' or '*' characters, or NUL. Use of non-visible UTF-8 characters is strongly discouraged.</p>
<p>Possible attribute name prefixes are:</p>
<ul>
<li>value - the data value of the attribute</li>
<li>content-type - a MIME content type and subtype</li>
<li>content-language - a RFC 3282 language code</li>
<li>vendor.<vendor-token> - a vendor-specific attribute</li>
</ul>
<p>Attribute names an attribute name prefix followed by ".priv" for private attributes or ".shared" for shared attributes. Note that the attributes "size.priv" and "size.shared" are read-only attributes set by the server, and so cannot be used with <a class="el" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>the metadata entry name (Metadata mode) in ASCII or attribute name (Annotatemore mode) in UTF-8 </td></tr>
<tr><td class="paramname">value</td><td>the value of the entry or attribute </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="setmetadatajob_8cpp_source.html#l00138">138</a> of file <a class="el" href="setmetadatajob_8cpp_source.html">setmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a771d891aa60157e22fc65a7d2fa3199d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qint64 KIMAP::SetMetaDataJob::maxAcceptedSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The maximum accepted metadata size. </p>
<p>If the server replied that one of the metadata values was too large (see metaDataErrors), this should indicate what the maximum size accepted by the server is.</p>
<dl class="section return"><dt>Returns</dt><dd>the maximum value size in octets, or -1 if the limit is unknown </dd></dl>
</div>
</div>
<a class="anchor" id="abfc99e595c64490bbe5e9ba8d302d754"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SetMetaDataJob::MetaDataErrors SetMetaDataJob::metaDataErrors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The metadata errors received from the server. </p>
<dl class="section return"><dt>Returns</dt><dd>a set of error codes </dd></dl>
<p>Definition at line <a class="el" href="setmetadatajob_8cpp_source.html#l00150">150</a> of file <a class="el" href="setmetadatajob_8cpp_source.html">setmetadatajob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa3af93fad6bbe5be161ad59dda8b3744"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SetMetaDataJob::setEntry </td>
<td>(</td>
<td class="paramtype">const QByteArray & </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the metadata entry name to operate on (in Annotatemore mode) </p>
<p>In Annotatemore mode, this specifies the metadata entry name to operate on. For server metadata, this is one of:</p>
<ul>
<li>/comment</li>
<li>/motd</li>
<li>/admin</li>
<li>/vendor/<vendor-token>/something</li>
</ul>
<p>For mailbox metadata, this is one of:</p>
<ul>
<li>/comment</li>
<li>/sort</li>
<li>/thread</li>
<li>/check</li>
<li>/checkperiod</li>
<li>/vendor/<vendor-token>/something</li>
</ul>
<p>Entry names must be valid UTF-8 strings that do not contain the '' or '*' characters, or NUL. Use of non-visible UTF-8 characters is strongly discouraged.</p>
<p>In Metadata mode, this has no effect. Metadata entry names should instead be specified as the first argument to <a class="el" href="classKIMAP_1_1SetMetaDataJob.html#a8f690d9e62fe04a48997e1ff9b041110" title="Adds a metadata entry or attribute to the list of modifications to make.">addMetaData()</a>.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classKIMAP_1_1MetaDataJobBase.html#a46e6b001fccc3b101b79fe8e2b074dd4" title="Set what version of the metadata extension to be compatible with.">setServerCapability()</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>the metadata entry name in UTF-8 </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="setmetadatajob_8cpp_source.html#l00144">144</a> of file <a class="el" href="setmetadatajob_8cpp_source.html">setmetadatajob.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="setmetadatajob_8h_source.html">setmetadatajob.h</a></li>
<li><a class="el" href="setmetadatajob_8cpp_source.html">setmetadatajob.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>
