<?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::FetchJob 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_1FetchJob.html">FetchJob</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classKIMAP_1_1FetchJob-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KIMAP::FetchJob Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>></code></p>
<p>Inherits KIMAP::Job.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchScope</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:a62df78a95937356b16782fde4a6d1b57"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a62df78a95937356b16782fde4a6d1b57">headersReceived</a> (const QString &mailBox, const QMap< qint64, qint64 > &<a class="el" href="classKIMAP_1_1FetchJob.html#a4b29bd12601d00278c50605ce0ccb8cb">uids</a>, const QMap< qint64, qint64 > &<a class="el" href="classKIMAP_1_1FetchJob.html#aef1262171708dd870943d6c893924931">sizes</a>, const QMap< qint64, KIMAP::MessageFlags > &<a class="el" href="classKIMAP_1_1FetchJob.html#ad4abacbcac6223b44d3542f1862abf7c">flags</a>, const QMap< qint64, KIMAP::MessagePtr > &<a class="el" href="classKIMAP_1_1FetchJob.html#aadec2e85edb8c3597fd2c474f9e9e0af">messages</a>)</td></tr>
<tr class="separator:a62df78a95937356b16782fde4a6d1b57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae22cf31346db914d17506945a733e427"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#ae22cf31346db914d17506945a733e427">messagesReceived</a> (const QString &mailBox, const QMap< qint64, qint64 > &<a class="el" href="classKIMAP_1_1FetchJob.html#a4b29bd12601d00278c50605ce0ccb8cb">uids</a>, const QMap< qint64, KIMAP::MessagePtr > &<a class="el" href="classKIMAP_1_1FetchJob.html#aadec2e85edb8c3597fd2c474f9e9e0af">messages</a>)</td></tr>
<tr class="separator:ae22cf31346db914d17506945a733e427"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50d1333dd91385c89411a7cbc3983df9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a50d1333dd91385c89411a7cbc3983df9">partsReceived</a> (const QString &mailBox, const QMap< qint64, qint64 > &<a class="el" href="classKIMAP_1_1FetchJob.html#a4b29bd12601d00278c50605ce0ccb8cb">uids</a>, const QMap< qint64, KIMAP::MessageParts > &<a class="el" href="classKIMAP_1_1FetchJob.html#aa7d4f5f09b483458d855b4cda3a6a2d6">parts</a>)</td></tr>
<tr class="separator:a50d1333dd91385c89411a7cbc3983df9"><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:a91045eb84b1dda8a673766dd420c4d0c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91045eb84b1dda8a673766dd420c4d0c"></a>
 </td><td class="memItemRight" valign="bottom"><b>FetchJob</b> (Session *session)</td></tr>
<tr class="separator:a91045eb84b1dda8a673766dd420c4d0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad4abacbcac6223b44d3542f1862abf7c"><td class="memItemLeft" align="right" valign="top">QMap< qint64, MessageFlags > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#ad4abacbcac6223b44d3542f1862abf7c">flags</a> () const </td></tr>
<tr class="separator:ad4abacbcac6223b44d3542f1862abf7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bd99400eb3a13a916462e605540a4e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a0bd99400eb3a13a916462e605540a4e6">isUidBased</a> () const </td></tr>
<tr class="separator:a0bd99400eb3a13a916462e605540a4e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadec2e85edb8c3597fd2c474f9e9e0af"><td class="memItemLeft" align="right" valign="top">QMap< qint64, MessagePtr > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#aadec2e85edb8c3597fd2c474f9e9e0af">messages</a> () const </td></tr>
<tr class="separator:aadec2e85edb8c3597fd2c474f9e9e0af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7d4f5f09b483458d855b4cda3a6a2d6"><td class="memItemLeft" align="right" valign="top">QMap< qint64, MessageParts > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#aa7d4f5f09b483458d855b4cda3a6a2d6">parts</a> () const </td></tr>
<tr class="separator:aa7d4f5f09b483458d855b4cda3a6a2d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43ca83299dd39074ad292dcda8a0ca25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchScope</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a43ca83299dd39074ad292dcda8a0ca25">scope</a> () const </td></tr>
<tr class="separator:a43ca83299dd39074ad292dcda8a0ca25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a084117af699c56640163340ce0aa9d33"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKIMAP_1_1ImapSet.html">ImapSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a084117af699c56640163340ce0aa9d33">sequenceSet</a> () const </td></tr>
<tr class="separator:a084117af699c56640163340ce0aa9d33"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb36d1e12240456be9d9761807b2dc1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#aeb36d1e12240456be9d9761807b2dc1a">setScope</a> (const <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchScope</a> &<a class="el" href="classKIMAP_1_1FetchJob.html#a43ca83299dd39074ad292dcda8a0ca25">scope</a>)</td></tr>
<tr class="separator:aeb36d1e12240456be9d9761807b2dc1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abca0ae71292c5e2adfc99ee0997a26bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#abca0ae71292c5e2adfc99ee0997a26bf">setSequenceSet</a> (const <a class="el" href="classKIMAP_1_1ImapSet.html">ImapSet</a> &set)</td></tr>
<tr class="separator:abca0ae71292c5e2adfc99ee0997a26bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b195a77c885a4dd4117e47c5848d2fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a1b195a77c885a4dd4117e47c5848d2fe">setUidBased</a> (bool uidBased)</td></tr>
<tr class="separator:a1b195a77c885a4dd4117e47c5848d2fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef1262171708dd870943d6c893924931"><td class="memItemLeft" align="right" valign="top">QMap< qint64, qint64 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#aef1262171708dd870943d6c893924931">sizes</a> () const </td></tr>
<tr class="separator:aef1262171708dd870943d6c893924931"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b29bd12601d00278c50605ce0ccb8cb"><td class="memItemLeft" align="right" valign="top">QMap< qint64, qint64 > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKIMAP_1_1FetchJob.html#a4b29bd12601d00278c50605ce0ccb8cb">uids</a> () const </td></tr>
<tr class="separator:a4b29bd12601d00278c50605ce0ccb8cb"><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:a375f69bb1cd4ae8c28f4f57617d5a027"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a375f69bb1cd4ae8c28f4f57617d5a027"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>doStart</b> ()</td></tr>
<tr class="separator:a375f69bb1cd4ae8c28f4f57617d5a027"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac12e363e53a9f3b12b4d45b044703da4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac12e363e53a9f3b12b4d45b044703da4"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>handleResponse</b> (const Message &response)</td></tr>
<tr class="separator:ac12e363e53a9f3b12b4d45b044703da4"><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>Fetch message data from the server. </p>
<p>All data is returned using the signals, so you need to connect to the relevant signal (or all of them) before starting the job.</p>
<p>This job will always use BODY.PEEK rather than BODY to fetch message content, so it will not set the flag.</p>
<p>This job can only be run when the session is in the selected state. </p>
<p>Definition at line <a class="el" href="fetchjob_8h_source.html#l00056">56</a> of file <a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad4abacbcac6223b44d3542f1862abf7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< qint64, MessageFlags > FetchJob::flags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>returns an empty map; use the signals instead </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00149">149</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a62df78a95937356b16782fde4a6d1b57"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void KIMAP::FetchJob::headersReceived </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 QMap< qint64, qint64 > & </td>
<td class="paramname"><em>uids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap< qint64, qint64 > & </td>
<td class="paramname"><em>sizes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap< qint64, KIMAP::MessageFlags > & </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap< qint64, KIMAP::MessagePtr > & </td>
<td class="paramname"><em>messages</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides header and message results. </p>
<p>This signal will be emitted if the requested scope mode was <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db" title="Fetch the complete message.">FetchScope::Full</a>, <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fac68b71a6c55407b41ea395c4e786f018" title="Fetch the message flags (the UID is also fetched)">FetchScope::Flags</a> or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> with no parts specified</p>
<p>This signal may be emitted any number of times before the result() signal is emitted. The result() signal will only be emitted once all results have been reported via one of the signals.</p>
<p>Note that, depending on the scope, some of the parameters of this signal may be empty maps.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailBox</td><td>the name of the mailbox the fetch job was executed on </td></tr>
<tr><td class="paramname">uids</td><td>a map from message sequence numbers to message UIDs; this will always be populated </td></tr>
<tr><td class="paramname">sizes</td><td>a map from message sequence numbers to message sizes (sizes are in octets and refer to the transfer encoding of the message); populated if the scope is <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db" title="Fetch the complete message.">FetchScope::Full</a> or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> </td></tr>
<tr><td class="paramname">flags</td><td>a map from message sequence numbers to message flags; populated if the scope is <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fac68b71a6c55407b41ea395c4e786f018" title="Fetch the message flags (the UID is also fetched)">FetchScope::Flags</a>, <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db" title="Fetch the complete message.">FetchScope::Full</a> of <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> </td></tr>
<tr><td class="paramname">messages</td><td>a map from message sequence numbers to message contents (including headers); populated if the scope is <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db" title="Fetch the complete message.">FetchScope::Full</a>, <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa94a464913c4b69e5d2e494379cb196c9" title="Fetch the MIME message body structure (the UID is also fetched)">FetchScope::Structure</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0bd99400eb3a13a916462e605540a4e6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FetchJob::isUidBased </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>How to interpret the sequence set. </p>
<dl class="section return"><dt>Returns</dt><dd>if <code>true</code> the result of <a class="el" href="classKIMAP_1_1FetchJob.html#a084117af699c56640163340ce0aa9d33" title="The messages that will be fetched.">sequenceSet()</a> should be interpreted as UIDs, if <code>false</code> it should be interpreted as sequence numbers </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00121">121</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aadec2e85edb8c3597fd2c474f9e9e0af"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< qint64, MessagePtr > FetchJob::messages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>returns an empty map; use the signals instead </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00139">139</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae22cf31346db914d17506945a733e427"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void KIMAP::FetchJob::messagesReceived </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 QMap< qint64, qint64 > & </td>
<td class="paramname"><em>uids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap< qint64, KIMAP::MessagePtr > & </td>
<td class="paramname"><em>messages</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides header and message results. </p>
<p>This signal will be emitted if the requested scope mode was <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150" title="Fetch the message content (the UID is also fetched)">FetchScope::Content</a> or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> with no parts specified or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa94a464913c4b69e5d2e494379cb196c9" title="Fetch the MIME message body structure (the UID is also fetched)">FetchScope::Structure</a>.</p>
<p>This signal may be emitted any number of times before the result() signal is emitted. The result() signal will only be emitted once all results have been reported via one of the signals.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailBox</td><td>the name of the mailbox the fetch job was executed on </td></tr>
<tr><td class="paramname">uids</td><td>a map from message sequence numbers to message UIDs </td></tr>
<tr><td class="paramname">messages</td><td>a map from message sequence numbers to message contents </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa7d4f5f09b483458d855b4cda3a6a2d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< qint64, MessageParts > FetchJob::parts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>returns an empty map; use the signals instead </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00144">144</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a50d1333dd91385c89411a7cbc3983df9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void KIMAP::FetchJob::partsReceived </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 QMap< qint64, qint64 > & </td>
<td class="paramname"><em>uids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QMap< qint64, KIMAP::MessageParts > & </td>
<td class="paramname"><em>parts</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides header and message results. </p>
<p>This signal will be emitted if the requested scope mode was <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150" title="Fetch the message content (the UID is also fetched)">FetchScope::Content</a> or <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f" title="Fetch RFC-2822 or MIME message headers.">FetchScope::Headers</a> with specified parts.</p>
<p>This signal may be emitted any number of times before the result() signal is emitted. The result() signal will only be emitted once all results have been reported via one of the signals.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mailBox</td><td>the name of the mailbox the fetch job was executed on </td></tr>
<tr><td class="paramname">uids</td><td>a map from message sequence numbers to message UIDs </td></tr>
<tr><td class="paramname">parts</td><td>a map from message sequence numbers to message part collections </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a43ca83299dd39074ad292dcda8a0ca25"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchJob::FetchScope</a> FetchJob::scope </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies what data will be fetched. </p>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00133">133</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a084117af699c56640163340ce0aa9d33"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKIMAP_1_1ImapSet.html">ImapSet</a> FetchJob::sequenceSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>The messages that will be fetched. </p>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00109">109</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aeb36d1e12240456be9d9761807b2dc1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FetchJob::setScope </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchScope</a> & </td>
<td class="paramname"><em>scope</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets what data should be fetched. </p>
<p>The default scope is <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150" title="Fetch the message content (the UID is also fetched)">FetchScope::Content</a> (all content parts).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scope</td><td>a <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html" title="Used to indicate what message data should be fetched.">FetchScope</a> object describing what data should be fetched </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00127">127</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abca0ae71292c5e2adfc99ee0997a26bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FetchJob::setSequenceSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKIMAP_1_1ImapSet.html">ImapSet</a> & </td>
<td class="paramname"><em>set</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set which messages to fetch data for. </p>
<p>If sequence numbers are given, <a class="el" href="classKIMAP_1_1FetchJob.html#a0bd99400eb3a13a916462e605540a4e6" title="How to interpret the sequence set.">isUidBased()</a> should be false. If UIDs are given, <a class="el" href="classKIMAP_1_1FetchJob.html#a0bd99400eb3a13a916462e605540a4e6" title="How to interpret the sequence set.">isUidBased()</a> should be true.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">set</td><td>the sequence numbers or UIDs of the messages to fetch data for </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00102">102</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1b195a77c885a4dd4117e47c5848d2fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FetchJob::setUidBased </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>uidBased</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set how the sequence set should be interpreted. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uidBased</td><td>if <code>true</code> the argument to setSequenceSet will be interpreted as UIDs, if <code>false</code> it will be interpreted as sequence numbers </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00115">115</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aef1262171708dd870943d6c893924931"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< qint64, qint64 > FetchJob::sizes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>returns an empty map; use the signals instead </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00154">154</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4b29bd12601d00278c50605ce0ccb8cb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QMap< qint64, qint64 > FetchJob::uids </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>returns an empty map; use the signals instead </dd></dl>
<p>Definition at line <a class="el" href="fetchjob_8cpp_source.html#l00159">159</a> of file <a class="el" href="fetchjob_8cpp_source.html">fetchjob.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="fetchjob_8h_source.html">fetchjob.h</a></li>
<li><a class="el" href="fetchjob_8cpp_source.html">fetchjob.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>
