• Skip to content
  • Skip to link menu
KDE 4.5 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

  • 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.

To implement a transport-enabled resource, inherit from both ResourceBase and TransportResourceBase, implement the virtual method sendItem(), and call emitTransportResult() when finished sending. The resource must also have the "MailTransport" capability flag.

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

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

Definition at line 49 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 65 of file transportresourcebase.h.


Constructor & Destructor Documentation

Akonadi::TransportResourceBase::TransportResourceBase (  ) 

Creates a new transport resource base.

virtual Akonadi::TransportResourceBase::~TransportResourceBase (  )  [virtual]

Destroys the transport resource base.


Member Function Documentation

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

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

Parameters:
item The item that was sent.
result The result that indicates whether the sending was successfully or not.
message An optional textual explanation of the result.
See also:
Transport.
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 according result flag.

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

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

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
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • 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.1
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