Akonadi::DispatcherInterface Class
class Akonadi::DispatcherInterfaceAn interface for applications to interact with the dispatcher agent. More...
| Header: | #include <Akonadi/DispatcherInterface> |
| CMake: | find_package(KPim6AkonadiMime REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::AkonadiMime) |
Public Functions
| DispatcherInterface() | |
| void | dispatchManualTransport(int transportId) |
| void | dispatchManually() |
| Akonadi::AgentInstance | dispatcherInstance() const |
| void | retryDispatching() |
Detailed Description
This class provides methods such as send queued messages (
dispatchManually) and retry sending (
This class also takes care of registering the attributes that the mail dispatcher agent and MailTransport use.
Author: Constantin Berzan <exit3219@gmail.com>
See also retryDispatching and ).
Member Function Documentation
DispatcherInterface::DispatcherInterface()
Creates a new dispatcher interface.
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.
transportId the transport to dispatch "manual dispatch" messages with
void DispatcherInterface::dispatchManually()
Looks for messages in the outbox with DispatchMode::Manual and marks them DispatchMode::Automatic for sending.
Akonadi::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.
void DispatcherInterface::retryDispatching()
Looks for messages in the outbox with ErrorAttribute, and clears them and queues them again for sending.