<?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::FetchScope Struct 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><li class="navelem"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html">FetchScope</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structKIMAP_1_1FetchJob_1_1FetchScope-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KIMAP::FetchJob::FetchScope Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>></code></p>
<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:aba3986315de057610b94dccbe918fa3f"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3f">Mode</a> { <br/>
  <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f">Headers</a>,
<a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fac68b71a6c55407b41ea395c4e786f018">Flags</a>,
<a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa94a464913c4b69e5d2e494379cb196c9">Structure</a>,
<a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150">Content</a>,
<br/>
  <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db">Full</a>,
<a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fac1fa9f904e91461c8e996b884660f470">HeaderAndContent</a>
<br/>
}</td></tr>
<tr class="separator:aba3986315de057610b94dccbe918fa3f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aab70c6152ab6945508ca88debd657666"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3f">Mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aab70c6152ab6945508ca88debd657666">mode</a></td></tr>
<tr class="separator:aab70c6152ab6945508ca88debd657666"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afff503cba9e11706559ceeaf58c7302d"><td class="memItemLeft" align="right" valign="top">QList< QByteArray > </td><td class="memItemRight" valign="bottom"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#afff503cba9e11706559ceeaf58c7302d">parts</a></td></tr>
<tr class="separator:afff503cba9e11706559ceeaf58c7302d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used to indicate what message data should be fetched. </p>
<p>This doesn't provide the same fine-grained control over what is fetched that the IMAP FETCH command normally does, but the common cases are catered for. </p>
<p>Definition at line <a class="el" href="fetchjob_8h_source.html#l00071">71</a> of file <a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>.</p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aba3986315de057610b94dccbe918fa3f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3f">KIMAP::FetchJob::FetchScope::Mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used to indicate what part of the message should be fetched. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fa939ab1eb1e7f102620de0f71b9d4221f"></a>Headers</em> </td><td class="fielddoc">
<p>Fetch RFC-2822 or MIME message headers. </p>
<p>To fetch MIME headers for a MIME part, populate the <code>parts</code> field.</p>
<p>If the RFC-2822 headers are requested (so <code>parts</code> is empty), the returned information is:</p>
<ul>
<li>To, From, Message-id, References In-Reply-To, Subject and Date headers</li>
<li>The message size (in octets)</li>
<li>The internal date of the message</li>
<li>The message flags</li>
<li>The message UID </li>
</ul>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fac68b71a6c55407b41ea395c4e786f018"></a>Flags</em> </td><td class="fielddoc">
<p>Fetch the message flags (the UID is also fetched) </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fa94a464913c4b69e5d2e494379cb196c9"></a>Structure</em> </td><td class="fielddoc">
<p>Fetch the MIME message body structure (the UID is also fetched) </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150"></a>Content</em> </td><td class="fielddoc">
<p>Fetch the message content (the UID is also fetched) </p>
<p>To fetch only certain MIME parts (see Structure), populate the <code>parts</code> field. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fa732187db1df8763c1c29ffbec0e8f4db"></a>Full</em> </td><td class="fielddoc">
<p>Fetch the complete message. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="aba3986315de057610b94dccbe918fa3fac1fa9f904e91461c8e996b884660f470"></a>HeaderAndContent</em> </td><td class="fielddoc">
<p>Fetch the message MIME headers and the content of parts specified in the <code>parts</code> field. </p>
<p>If <code>parts</code> is empty, this mode will return the full message, just like <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fab335db5a0173f37a60839b366c982150" title="Fetch the message content (the UID is also fetched)">FetchScope::Content</a></p>
<p>Use case:</p>
<ol type="1">
<li>Start a <a class="el" href="classKIMAP_1_1FetchJob.html" title="Fetch message data from the server.">FetchJob</a> with the <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> mode to retrieve the structure of the message.</li>
<li>Parse the structure to identify the parts that are interesting (ie: probably everything but attachments).</li>
<li>Start another <a class="el" href="classKIMAP_1_1FetchJob.html" title="Fetch message data from the server.">FetchJob</a> with <a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3fac1fa9f904e91461c8e996b884660f470" title="Fetch the message MIME headers and the content of parts specified in the parts field.">FetchScope::HeaderAndContent</a> to fetch those parts.</li>
<li>At the request of the user, you can repeat the step above to fetch the attachments.</li>
</ol>
<dl class="section since"><dt>Since</dt><dd>4.7 </dd></dl>
</td></tr>
</table>
<p>Definition at line <a class="el" href="fetchjob_8h_source.html#l00076">76</a> of file <a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aab70c6152ab6945508ca88debd657666"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structKIMAP_1_1FetchJob_1_1FetchScope.html#aba3986315de057610b94dccbe918fa3f">Mode</a> KIMAP::FetchJob::FetchScope::mode</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify what message data should be fetched. </p>
<p>Definition at line <a class="el" href="fetchjob_8h_source.html#l00150">150</a> of file <a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>.</p>
</div>
</div>
<a class="anchor" id="afff503cba9e11706559ceeaf58c7302d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QList<QByteArray> KIMAP::FetchJob::FetchScope::parts</td>
</tr>
</table>
</div><div class="memdoc">
<p>Specify which message parts to operate on. </p>
<p>This refers to multipart-MIME message parts or MIME-IMB encapsulated message parts.</p>
<p>Note that this is ignored unless <code>mode</code> is Headers or Content.</p>
<p>If <code>mode</code> is Headers, this sets the parts to get the MIME headers for. If this list is empty, the headers for the whole message (the RFC-2822 headers) are fetched.</p>
<p>If <code>mode</code> is Content, this sets the parts to fetch. Parts are fetched wholesale. If this list is empty, the whole message body is fetched (all MIME parts together). </p>
<p>Definition at line <a class="el" href="fetchjob_8h_source.html#l00146">146</a> of file <a class="el" href="fetchjob_8h_source.html">fetchjob.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="fetchjob_8h_source.html">fetchjob.h</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>
