KDE 4.5 PyKDE API Reference
TransportResourceBase Class Reference
from PyKDE4.akonadi import *
Namespace: Akonadi
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.
- Since:
- 4.4
Enumerations | |
| TransportResult | { TransportSucceeded, TransportFailed } |
Methods | |
| __init__ (self) | |
| itemSent (self, Akonadi.Item item, Akonadi.TransportResourceBase.TransportResult result, QString message=QString()) | |
| sendItem (self, Akonadi.Item item) | |
Method Documentation
| __init__ | ( | self ) |
Creates a new transport resource base.
| itemSent | ( | self, | ||
| Akonadi.Item | item, | |||
| Akonadi.TransportResourceBase.TransportResult | result, | |||
| 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.
| sendItem | ( | self, | ||
| Akonadi.Item | item | |||
| ) |
- Abstract method:
- This method is abstract and can be overridden but not called directly.
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().
Enumeration Documentation
| TransportResult |
Describes the result of the transport process.
- Enumerator:
-
TransportSucceeded TransportFailed
