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

akonadi

  • Akonadi
  • TransportResourceBase
Public Types | Public Member Functions
Akonadi::TransportResourceBase Class Reference

Resource implementing mail transport capability. More...

#include <transportresourcebase.h>

List of all members.

Public Types

enum  TransportResult { TransportSucceeded, TransportFailed }

Public Member Functions

 TransportResourceBase ()
virtual ~TransportResourceBase ()
void itemSent (const Akonadi::Item &item, TransportResult result, const QString &message=QString())
virtual void sendItem (const Akonadi::Item &item)=0

Detailed Description

Resource implementing mail transport capability.

This class allows a resource to provide mail transport (i.e. sending mail). A resource than can provide mail transport inherits from both ResourceBase and TransportResourceBase, implements the virtual method sendItem(), and calls itemSent() when finished sending.

The resource must also have the "MailTransport" capability flag. For example the desktop file may contain:

    X-Akonadi-Capabilities=Resource,MailTransport

For an example of a transport-enabled resource, see kdepim/runtime/resources/mailtransport_dummy

Author:
Constantin Berzan <exit3219@gmail.com>
Since:
4.4

Definition at line 55 of file transportresourcebase.h.


Member Enumeration Documentation

enum Akonadi::TransportResourceBase::TransportResult

Describes the result of the transport process.

Enumerator:
TransportSucceeded 

The transport process succeeded.

TransportFailed 

The transport process failed.

Definition at line 71 of file transportresourcebase.h.


Constructor & Destructor Documentation

TransportResourceBase::TransportResourceBase ( )

Creates a new transport resource base.

Definition at line 64 of file transportresourcebase.cpp.

TransportResourceBase::~TransportResourceBase ( ) [virtual]

Destroys the transport resource base.

Definition at line 69 of file transportresourcebase.cpp.


Member Function Documentation

void TransportResourceBase::itemSent ( const Akonadi::Item &  item,
TransportResult  result,
const QString &  message = QString() 
)

This method marks the sending of the passed item as finished.

Parameters:
itemThe item that was sent.
resultThe result that indicates whether the sending was successful or not.
messageAn optional text explanation of the result.
See also:
Transport.

Definition at line 74 of file transportresourcebase.cpp.

virtual void Akonadi::TransportResourceBase::sendItem ( const Akonadi::Item &  item) [pure virtual]

This method is called when the given item shall be send.

When the sending is done or an error occurred during sending, call itemSent() with the appropriate result flag.

Parameters:
itemThe message item to be send.
See also:
itemSent().

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

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • 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.4
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