• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

mailtransport

  • MailTransport
  • DispatcherInterface
Public Member Functions
MailTransport::DispatcherInterface Class Reference

#include <dispatcherinterface.h>

List of all members.

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 <exit3219@gmail.com>
Since:
4.4

Constructor & Destructor Documentation

DispatcherInterface::DispatcherInterface ( )

Creates a new dispatcher interface.

Definition at line 49 of file dispatcherinterface.cpp.


Member Function Documentation

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 53 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 63 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.

Since:
4.5

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


The documentation for this class was generated from the following files:
  • dispatcherinterface.h
  • dispatcherinterface.cpp

mailtransport

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal