<?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>MailTransport::DispatcherInterface 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>mailtransport</h2>
<!-- BC -->
<div id="top">
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>MailTransport</b></li><li class="navelem"><a class="el" href="classMailTransport_1_1DispatcherInterface.html">DispatcherInterface</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classMailTransport_1_1DispatcherInterface-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MailTransport::DispatcherInterface Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="dispatcherinterface_8h_source.html">dispatcherinterface.h</a>></code></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:a26488031b61dcc3469b2fe8c2cc737c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMailTransport_1_1DispatcherInterface.html#a26488031b61dcc3469b2fe8c2cc737c6">DispatcherInterface</a> ()</td></tr>
<tr class="separator:a26488031b61dcc3469b2fe8c2cc737c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe6755de00ce3d543e2cdf41c27f8902"><td class="memItemLeft" align="right" valign="top">Akonadi::AgentInstance </td><td class="memItemRight" valign="bottom"><a class="el" href="classMailTransport_1_1DispatcherInterface.html#afe6755de00ce3d543e2cdf41c27f8902">dispatcherInstance</a> () const </td></tr>
<tr class="separator:afe6755de00ce3d543e2cdf41c27f8902"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cfc5a87d26f7106a2da1de914ff1e62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMailTransport_1_1DispatcherInterface.html#a6cfc5a87d26f7106a2da1de914ff1e62">dispatchManually</a> ()</td></tr>
<tr class="separator:a6cfc5a87d26f7106a2da1de914ff1e62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39406aa1f64b8b9430f5c15a3b8ea2ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMailTransport_1_1DispatcherInterface.html#a39406aa1f64b8b9430f5c15a3b8ea2ee">dispatchManualTransport</a> (int transportId)</td></tr>
<tr class="separator:a39406aa1f64b8b9430f5c15a3b8ea2ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33c321c437a127709888a8384c9341b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMailTransport_1_1DispatcherInterface.html#a33c321c437a127709888a8384c9341b6">retryDispatching</a> ()</td></tr>
<tr class="separator:a33c321c437a127709888a8384c9341b6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>An interface for applications to interact with the dispatcher agent. </p>
<p>This class provides methods such as send queued messages (</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classMailTransport_1_1DispatcherInterface.html#a6cfc5a87d26f7106a2da1de914ff1e62" title="Looks for messages in the outbox with DispatchMode::Manual and marks them DispatchMode::Automatic for...">dispatchManually</a>) and retry sending (</dd>
<dd>
<a class="el" href="classMailTransport_1_1DispatcherInterface.html#a33c321c437a127709888a8384c9341b6" title="Looks for messages in the outbox with ErrorAttribute, and clears them and queues them again for sendi...">retryDispatching</a>).</dd></dl>
<p>This class also takes care of registering the attributes that the mail dispatcher agent and MailTransport use.</p>
<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="dispatcherinterface_8h_source.html#l00043">43</a> of file <a class="el" href="dispatcherinterface_8h_source.html">dispatcherinterface.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a26488031b61dcc3469b2fe8c2cc737c6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DispatcherInterface::DispatcherInterface </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new dispatcher interface. </p>
<p>Definition at line <a class="el" href="dispatcherinterface_8cpp_source.html#l00049">49</a> of file <a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afe6755de00ce3d543e2cdf41c27f8902"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AgentInstance DispatcherInterface::dispatcherInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current instance of the mail dispatcher agent. </p>
<p>May return an invalid AgentInstance in case it cannot find the mail dispatcher agent. </p>
<p>Definition at line <a class="el" href="dispatcherinterface_8cpp_source.html#l00053">53</a> of file <a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6cfc5a87d26f7106a2da1de914ff1e62"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DispatcherInterface::dispatchManually </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks for messages in the outbox with DispatchMode::Manual and marks them DispatchMode::Automatic for sending. </p>
<p>Definition at line <a class="el" href="dispatcherinterface_8cpp_source.html#l00063">63</a> of file <a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a39406aa1f64b8b9430f5c15a3b8ea2ee"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DispatcherInterface::dispatchManualTransport </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>transportId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks for messages in the outbox with DispatchMode::Manual and changes the <a class="el" href="classMailTransport_1_1Transport.html" title="Represents the settings of a specific mail transport.">Transport</a> for them to the one with id <code>transportId</code>. </p>
<dl class="section since"><dt>Since</dt><dd>4.5 </dd></dl>
<p>Definition at line <a class="el" href="dispatcherinterface_8cpp_source.html#l00089">89</a> of file <a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a33c321c437a127709888a8384c9341b6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DispatcherInterface::retryDispatching </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks for messages in the outbox with <a class="el" href="classMailTransport_1_1ErrorAttribute.html" title="An Attribute to mark messages that failed to be sent.">ErrorAttribute</a>, and clears them and queues them again for sending. </p>
<p>Definition at line <a class="el" href="dispatcherinterface_8cpp_source.html#l00076">76</a> of file <a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="dispatcherinterface_8h_source.html">dispatcherinterface.h</a></li>
<li><a class="el" href="dispatcherinterface_8cpp_source.html">dispatcherinterface.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:43 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">mailtransport</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "mailtransport"</a>
</div></div>
<ul><li><a href="index.html">Main Page</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="classAkonadi_1_1FilterAction.html">akonadi::filteraction</option>, <option value="classAkonadi_1_1FilterActionJob.html">akonadi::filteractionjob</option>, <option value="classMailTransport_1_1AddTransportDialog.html">mailtransport::addtransportdialog</option>, <option value="classMailTransport_1_1ClearErrorAction.html">mailtransport::clearerroraction</option>, <option value="classMailTransport_1_1ConfigModule.html">mailtransport::configmodule</option>, <option value="classMailTransport_1_1DispatcherInterface.html">mailtransport::dispatcherinterface</option>, <option value="classMailTransport_1_1DispatcherInterfacePrivate.html">mailtransport::dispatcherinterfaceprivate</option>, <option value="classMailTransport_1_1DispatchManualTransportAction.html">mailtransport::dispatchmanualtransportaction</option>, <option value="classMailTransport_1_1DispatchModeAttribute.html">mailtransport::dispatchmodeattribute</option>, <option value="classMailTransport_1_1ErrorAttribute.html">mailtransport::errorattribute</option>, <option value="classMailTransport_1_1Legacy.html">mailtransport::legacy</option>, <option value="classMailTransport_1_1MessageQueueJob.html">mailtransport::messagequeuejob</option>, <option value="classMailTransport_1_1PrecommandJob.html">mailtransport::precommandjob</option>, <option value="classMailTransport_1_1ResourceSendJob.html">mailtransport::resourcesendjob</option>, <option value="classMailTransport_1_1SendmailConfigWidget.html">mailtransport::sendmailconfigwidget</option>, <option value="classMailTransport_1_1SendmailJob.html">mailtransport::sendmailjob</option>, <option value="classMailTransport_1_1SendQueuedAction.html">mailtransport::sendqueuedaction</option>, <option value="classMailTransport_1_1SentActionAttribute.html">mailtransport::sentactionattribute</option>, <option value="classMailTransport_1_1SentActionAttribute_1_1Action.html">mailtransport::sentactionattribute::action</option>, <option value="classMailTransport_1_1SentBehaviourAttribute.html">mailtransport::sentbehaviourattribute</option>, <option value="classMailTransport_1_1ServerTest.html">mailtransport::servertest</option>, <option value="classMailTransport_1_1SMTPConfigWidget.html">mailtransport::smtpconfigwidget</option>, <option value="classMailTransport_1_1SmtpJob.html">mailtransport::smtpjob</option>, <option value="classMailTransport_1_1SmtpSession.html">mailtransport::smtpsession</option>, <option value="classMailTransport_1_1Socket.html">mailtransport::socket</option>, <option value="classMailTransport_1_1Transport.html">mailtransport::transport</option>, <option value="classMailTransport_1_1TransportAttribute.html">mailtransport::transportattribute</option>, <option value="classMailTransport_1_1TransportComboBox.html">mailtransport::transportcombobox</option>, <option value="classMailTransport_1_1TransportConfigDialog.html">mailtransport::transportconfigdialog</option>, <option value="classMailTransport_1_1TransportConfigWidget.html">mailtransport::transportconfigwidget</option>, <option value="classMailTransport_1_1TransportConfigWidgetPrivate.html">mailtransport::transportconfigwidgetprivate</option>, <option value="classMailTransport_1_1TransportJob.html">mailtransport::transportjob</option>, <option value="classMailTransport_1_1TransportListView.html">mailtransport::transportlistview</option>, <option value="classMailTransport_1_1TransportManagementWidget.html">mailtransport::transportmanagementwidget</option>, <option value="classMailTransport_1_1TransportManager.html">mailtransport::transportmanager</option>, <option value="classMailTransport_1_1TransportType.html">mailtransport::transporttype</option>, <option value="classMailTransport_1_1TransportType_1_1Private.html">mailtransport::transporttype::private</option>, <option value="classTransportPrivate.html">transportprivate</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>
