<?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>setmetadatajob.h Source File</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"><a class="el" href="dir_e09087ff1473143b3d9fdc034eb04f95.html">kimap</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">setmetadatajob.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Copyright (c) 2009 Andras Mantia <amantia@kde.org></span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> This library is free software; you can redistribute it and/or modify it</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> under the terms of the GNU Library General Public License as published by</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> the Free Software Foundation; either version 2 of the License, or (at your</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> option) any later version.</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> This library is distributed in the hope that it will be useful, but WITHOUT</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> License for more details.</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> You should have received a copy of the GNU Library General Public License</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to the</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA</span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> 02110-1301, USA.</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">*/</span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef KIMAP_SETMETADATAJOB_H</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define KIMAP_SETMETADATAJOB_H</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "kimap_export.h"</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "metadatajobbase.h"</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>KIMAP {</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span>Session;</div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">struct </span>Message;</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span>SetMetaDataJobPrivate;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html"> 68</a></span> <span class="keyword">class </span>KIMAP_EXPORT <a class="code" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a> : <span class="keyword">public</span> <a class="code" href="classKIMAP_1_1MetaDataJobBase.html" title="Base class for jobs that operate on mailbox metadata.">MetaDataJobBase</a></div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> {</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  Q_OBJECT</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  Q_DECLARE_PRIVATE( <a class="code" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a> )</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">friend</span> <span class="keyword">class </span>SessionPrivate;</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">explicit</span> <a class="code" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a>( Session *session );</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> ~<a class="code" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a>();</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> <div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">void</span> addMetaData(<span class="keyword">const</span> QByteArray &name, <span class="keyword">const</span> QByteArray &value);</div> <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div> <div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// KDE5: this API is horrible for Annotatemore mode: use an overload of</span></div> <div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">// addMetaData() instead:</span></div> <div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">// void addMetaData(const QString &entry, const QByteArray &value,</span></div> <div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="comment">// const QByteArray &encoding = QByteArray(),</span></div> <div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="comment">// const QByteArray &language = QByteArray(),</span></div> <div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <span class="comment">// const QMap<QString,QByteArray> vendorAttributes =</span></div> <div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <span class="comment">// QMap<QString,QByteArray>());</span></div> <div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">void</span> setEntry(<span class="keyword">const</span> QByteArray &entry);</div> <div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div> <div class="line"><a name="l00179"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471"> 179</a></span>  <span class="keyword">enum</span> <a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471" title="Possible error codes that may be returned by the server.">MetaDataError</a> {</div> <div class="line"><a name="l00180"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471ae0356e044b551f73913c302f99d7e2eb"> 180</a></span>  NoError = 0, </div> <div class="line"><a name="l00181"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471ad30bcab344a94d6c6b58d06a52402371"> 181</a></span>  TooMany = 1, </div> <div class="line"><a name="l00182"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471abe8454f02c9d0782bb8ccb918e3ae8fe"> 182</a></span>  TooBig = 2, </div> <div class="line"><a name="l00183"></a><span class="lineno"><a class="code" href="classKIMAP_1_1SetMetaDataJob.html#acb459417f3990e90f0549711a8d61471a7864657c7b4e5f3b7c2f0510d3bbcc84"> 183</a></span>  NoPrivate = 4 </div> <div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  };</div> <div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div> <div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="comment">// Q_DECLARE_WHATEVER_THAT_WAS missing</span></div> <div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  Q_DECLARE_FLAGS( MetaDataErrors, MetaDataError )</div> <div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div> <div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  </div> <div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  MetaDataErrors metaDataErrors() const;</div> <div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  qint64 maxAcceptedSize();</div> <div class="line"><a name="l00205"></a><span class="lineno"> 205</span> </div> <div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  protected:</div> <div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  virtual <span class="keywordtype">void</span> doStart();</div> <div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  virtual <span class="keywordtype">void</span> handleResponse( const Message &response );</div> <div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div> <div class="line"><a name="l00210"></a><span class="lineno"> 210</span> };</div> <div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div> <div class="line"><a name="l00212"></a><span class="lineno"> 212</span> }</div> <div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div> <div class="line"><a name="l00214"></a><span class="lineno"> 214</span> Q_DECLARE_OPERATORS_FOR_FLAGS( KIMAP::<a class="code" href="classKIMAP_1_1SetMetaDataJob.html" title="Sets mailbox metadata.">SetMetaDataJob</a>::MetaDataErrors )</div> <div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div> <div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="preprocessor">#endif</span></div> </div><!-- fragment --></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>