• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

mailtransport

  • MailTransport
  • DispatcherInterface
Public Member Functions | List of all members
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.nosp@m.219@.nosp@m.gmail.nosp@m..com
Since
4.4

Definition at line 43 of file dispatcherinterface.h.

Constructor & Destructor Documentation

◆ DispatcherInterface()

DispatcherInterface::DispatcherInterface ( )

Creates a new dispatcher interface.

Definition at line 48 of file dispatcherinterface.cpp.

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 52 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 62 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 88 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 75 of file dispatcherinterface.cpp.


The documentation for this class was generated from the following files:
  • dispatcherinterface.h
  • dispatcherinterface.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

mailtransport

Skip menu "mailtransport"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal