Akonadi::DispatcherInterface Class Reference

#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.

Author

Constantin Berzan exit3.nosp@m.219@.nosp@m.gmail.nosp@m..com

Since

4.4

Definition at line 29 of file dispatcherinterface.h.

Constructor & Destructor Documentation

DispatcherInterface()

DispatcherInterface::DispatcherInterface ( )

default

Creates a new dispatcher interface.

Member Function Documentation

dispatcherInstance()

AgentInstance DispatcherInterface::dispatcherInstance ( ) const

nodiscard

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 35 of file dispatcherinterface.cpp.

dispatchManually()

void DispatcherInterface::dispatchManually

(

)

Looks for messages in the outbox with DispatchMode::Manual and marks them DispatchMode::Automatic for sending.

Definition at line 44 of file dispatcherinterface.cpp.

dispatchManualTransport()

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.

Parameters

transportId

the transport to dispatch "manual dispatch" messages with

Since

4.5

Definition at line 68 of file dispatcherinterface.cpp.

retryDispatching()

void DispatcherInterface::retryDispatching

(

)

Looks for messages in the outbox with ErrorAttribute, and clears them and queues them again for sending.

Definition at line 56 of file dispatcherinterface.cpp.

---

The documentation for this class was generated from the following files:

• dispatcherinterface.h
• dispatcherinterface.cpp