MailTransport::DispatcherInterface

Search for usage in LXR

MailTransport::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[email protected][email protected][email protected]gmail[email protected].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

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 36 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 45 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
transportIdthe transport to dispatch "manual dispatch" messages with
Since
4.5

Definition at line 69 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 57 of file dispatcherinterface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sun Dec 4 2022 03:53:38 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.