mailtransport
#include <dispatcherinterface.h>
Public Member Functions | |
DispatcherInterface () | |
Akonadi::AgentInstance | dispatcherInstance () const |
void | dispatchManually () |
void | dispatchManualTransport (int transportId) |
void | retryDispatching () |
Detailed Description
An interface for applications to interact with the dispatcher agent.
This class provides methods such as send queued messages (
- See Also
- dispatchManually) and retry sending (
- retryDispatching).
This class also takes care of registering the attributes that the mail dispatcher agent and MailTransport use.
- Since
- 4.4
Definition at line 43 of file dispatcherinterface.h.
Constructor & Destructor Documentation
DispatcherInterface::DispatcherInterface | ( | ) |
Creates a new dispatcher interface.
Definition at line 49 of file dispatcherinterface.cpp.
Member Function Documentation
AgentInstance DispatcherInterface::dispatcherInstance | ( | ) | const |
Returns the current instance of the mail dispatcher agent.
May return an invalid AgentInstance in case it cannot find the mail dispatcher agent.
Definition at line 53 of file dispatcherinterface.cpp.
void DispatcherInterface::dispatchManually | ( | ) |
Looks for messages in the outbox with DispatchMode::Manual and marks them DispatchMode::Automatic for sending.
Definition at line 63 of file dispatcherinterface.cpp.
void DispatcherInterface::dispatchManualTransport | ( | int | transportId | ) |
Looks for messages in the outbox with DispatchMode::Manual and changes the Transport for them to the one with id transportId
.
- Since
- 4.5
Definition at line 89 of file dispatcherinterface.cpp.
void DispatcherInterface::retryDispatching | ( | ) |
Looks for messages in the outbox with ErrorAttribute, and clears them and queues them again for sending.
Definition at line 76 of file dispatcherinterface.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:26:53 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.