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 (

This class also takes care of registering the attributes that the mail dispatcher agent and MailTransport use.

Definition at line 43 of file dispatcherinterface.h.

Constructor & Destructor Documentation

DispatcherInterface::DispatcherInterface ( )

Creates a new dispatcher interface.

Definition at line 48 of file dispatcherinterface.cpp.

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 52 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 62 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.

Parameters

transportId the transport to dispatch "manual dispatch" messages with

Definition at line 88 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: