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

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 successful or not.
	message	An optional text 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 appropriate 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