mailtransport
MailTransport::DispatcherInterface Class Reference
An interface for applications to interact with the dispatcher agent. More...
#include <dispatcherinterface.h>
Public Member Functions | |
DispatcherInterface () | |
Akonadi::AgentInstance | dispatcherInstance () const |
void | dispatchManually () |
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 41 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::retryDispatching | ( | ) |
Looks for messages in the outbox with ErrorAttribute, and clears them and queues them again for sending.
Definition at line 75 of file dispatcherinterface.cpp.
The documentation for this class was generated from the following files: