<?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>Akonadi::SpecialMailCollectionsRequestJob 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>akonadi/kmime</h2> <!-- BC --> <div id="top"> <!-- Generated by Doxygen 1.8.3.1 --> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>Akonadi</b></li><li class="navelem"><a class="el" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html">SpecialMailCollectionsRequestJob</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classAkonadi_1_1SpecialMailCollectionsRequestJob-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Akonadi::SpecialMailCollectionsRequestJob Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <<a class="el" href="specialmailcollectionsrequestjob_8h_source.html">specialmailcollectionsrequestjob.h</a>></code></p> <p>Inherits SpecialCollectionsRequestJob.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aa7b992a56599041ab5bc14fcead18313"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#aa7b992a56599041ab5bc14fcead18313">SpecialMailCollectionsRequestJob</a> (QObject *parent=0)</td></tr> <tr class="separator:aa7b992a56599041ab5bc14fcead18313"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5f8aec5537be91330a36fb6a52e8501b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#a5f8aec5537be91330a36fb6a52e8501b">~SpecialMailCollectionsRequestJob</a> ()</td></tr> <tr class="separator:a5f8aec5537be91330a36fb6a52e8501b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02e9c65e75923a40871da933b7e7012d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#a02e9c65e75923a40871da933b7e7012d">requestCollection</a> (<a class="el" href="classAkonadi_1_1SpecialMailCollections.html#a2eddbbc137b25b7dd854b323bc0a46b4">SpecialMailCollections::Type</a> type, const AgentInstance &instance)</td></tr> <tr class="separator:a02e9c65e75923a40871da933b7e7012d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1dc55be7e13bf14e1754c0b0254ad891"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#a1dc55be7e13bf14e1754c0b0254ad891">requestDefaultCollection</a> (<a class="el" href="classAkonadi_1_1SpecialMailCollections.html#a2eddbbc137b25b7dd854b323bc0a46b4">SpecialMailCollections::Type</a> type)</td></tr> <tr class="separator:a1dc55be7e13bf14e1754c0b0254ad891"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A job to request <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a>. </p> <p>Use this job to request the <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a> you need. You can request both default <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a> and <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a> in a given resource. The default <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a> resource is created when the first default SpecialCollection is requested, but if a SpecialCollection in a custom resource is requested, this job expects that resource to exist already.</p> <p>If the folders you requested already exist, this job simply succeeds. Otherwise, it creates the required collections and registers them with <a class="el" href="classAkonadi_1_1SpecialMailCollections.html" title="Interface to special mail collections such as inbox, outbox etc.">SpecialMailCollections</a>.</p> <p>Example:</p> <div class="fragment"><div class="line"><a class="code" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#aa7b992a56599041ab5bc14fcead18313" title="Creates a new special mail collections request job.">SpecialMailCollectionsRequestJob</a> *job = <span class="keyword">new</span> <a class="code" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#aa7b992a56599041ab5bc14fcead18313" title="Creates a new special mail collections request job.">SpecialMailCollectionsRequestJob</a>( <span class="keyword">this</span> );</div> <div class="line">job->requestDefaultCollection( <a class="code" href="classAkonadi_1_1SpecialMailCollections.html#a2eddbbc137b25b7dd854b323bc0a46b4ab11c995d67789e4149ee62dacd684263" title="The outbox collection.">SpecialMailCollections::Outbox</a> );</div> <div class="line">connect( job, SIGNAL( result( KJob* ) ),</div> <div class="line"> <span class="keyword">this</span>, SLOT( requestDone( KJob* ) ) );</div> <div class="line"></div> <div class="line">...</div> <div class="line"></div> <div class="line">MyClass::requestDone( KJob *job )</div> <div class="line">{</div> <div class="line"> <span class="keywordflow">if</span> ( job->error() )</div> <div class="line"> <span class="keywordflow">return</span>;</div> <div class="line"></div> <div class="line"> <a class="code" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#aa7b992a56599041ab5bc14fcead18313" title="Creates a new special mail collections request job.">SpecialMailCollectionsRequestJob</a> *requestJob = qobject_cast<<a class="code" href="classAkonadi_1_1SpecialMailCollectionsRequestJob.html#aa7b992a56599041ab5bc14fcead18313" title="Creates a new special mail collections request job.">SpecialMailCollectionsRequestJob</a>*>( job );</div> <div class="line"></div> <div class="line"> <span class="keyword">const</span> Collection collection = requestJob->collection();</div> <div class="line"> ...</div> <div class="line">}</div> </div><!-- fragment --><dl class="section author"><dt>Author</dt><dd>Constantin Berzan <a href="#" onclick="location.href='mai'+'lto:'+'exi'+'t3'+'219'+'@g'+'mai'+'l.'+'com'; return false;">exit3<span style="display: none;">.nosp@m.</span>219@<span style="display: none;">.nosp@m.</span>gmail<span style="display: none;">.nosp@m.</span>.com</a> </dd></dl> <dl class="section since"><dt>Since</dt><dd>4.4 </dd></dl> <p>Definition at line <a class="el" href="specialmailcollectionsrequestjob_8h_source.html#l00072">72</a> of file <a class="el" href="specialmailcollectionsrequestjob_8h_source.html">specialmailcollectionsrequestjob.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aa7b992a56599041ab5bc14fcead18313"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">SpecialMailCollectionsRequestJob::SpecialMailCollectionsRequestJob </td> <td>(</td> <td class="paramtype">QObject * </td> <td class="paramname"><em>parent</em> = <code>0</code></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">explicit</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Creates a new special mail collections request job. </p> <p>Definition at line <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html#l00047">47</a> of file <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html">specialmailcollectionsrequestjob.cpp</a>.</p> </div> </div> <a class="anchor" id="a5f8aec5537be91330a36fb6a52e8501b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SpecialMailCollectionsRequestJob::~SpecialMailCollectionsRequestJob </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroys the special mail collections request job. </p> <p>Definition at line <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html#l00082">82</a> of file <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html">specialmailcollectionsrequestjob.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a02e9c65e75923a40871da933b7e7012d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SpecialMailCollectionsRequestJob::requestCollection </td> <td>(</td> <td class="paramtype"><a class="el" href="classAkonadi_1_1SpecialMailCollections.html#a2eddbbc137b25b7dd854b323bc0a46b4">SpecialMailCollections::Type</a> </td> <td class="paramname"><em>type</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const AgentInstance & </td> <td class="paramname"><em>instance</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Requests a special mail collection of the given <code>type</code> in the given resource <code>instance</code>. </p> <p>Definition at line <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html#l00091">91</a> of file <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html">specialmailcollectionsrequestjob.cpp</a>.</p> </div> </div> <a class="anchor" id="a1dc55be7e13bf14e1754c0b0254ad891"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void SpecialMailCollectionsRequestJob::requestDefaultCollection </td> <td>(</td> <td class="paramtype"><a class="el" href="classAkonadi_1_1SpecialMailCollections.html#a2eddbbc137b25b7dd854b323bc0a46b4">SpecialMailCollections::Type</a> </td> <td class="paramname"><em>type</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Requests a special mail collection of the given <code>type</code> in the default resource. </p> <p>Definition at line <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html#l00086">86</a> of file <a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html">specialmailcollectionsrequestjob.cpp</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="specialmailcollectionsrequestjob_8h_source.html">specialmailcollectionsrequestjob.h</a></li> <li><a class="el" href="specialmailcollectionsrequestjob_8cpp_source.html">specialmailcollectionsrequestjob.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:49:27 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">akonadi/kmime</h2> <a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "akonadi/kmime"</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="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="classAkonadi_1_1AddressAttribute.html">akonadi::addressattribute</option>, <option value="classAkonadi_1_1MessageFolderAttribute.html">akonadi::messagefolderattribute</option>, <option value="classAkonadi_1_1MessageModel.html">akonadi::messagemodel</option>, <option value="classAkonadi_1_1MessageStatus.html">akonadi::messagestatus</option>, <option value="classAkonadi_1_1MessageThreaderProxyModel.html">akonadi::messagethreaderproxymodel</option>, <option value="classAkonadi_1_1MessageThreadingAttribute.html">akonadi::messagethreadingattribute</option>, <option value="classAkonadi_1_1RemoveDuplicatesJob.html">akonadi::removeduplicatesjob</option>, <option value="classAkonadi_1_1SpecialMailCollections.html">akonadi::specialmailcollections</option>, <option value="classAkonadi_1_1SpecialMailCollectionsRequestJob.html">akonadi::specialmailcollectionsrequestjob</option>, <option value="classAkonadi_1_1SpecialMailCollectionsTesting.html">akonadi::specialmailcollectionstesting</option>, <option value="classAkonadi_1_1StandardMailActionManager.html">akonadi::standardmailactionmanager</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>