mail::Transport Class Reference

Mail transport interface. More...

#include <transport.h>

Inheritance diagram for mail::Transport:

modules::ErrorInterface modules::Interface

List of all members.

Public Member Functions

virtual bool deliver (Mail const &mail, bool *temp)=0
 Delivers an e-mail.

Static Public Attributes

static
modules::PSIID const 
IID = 0x45724731
 Unique interface identifier.


Detailed Description

This interface is used by modules to implement mail transport modules, that can be used by the mail subsystem to deliver mails by different means.

This interface must be exposed through the Module::interface() function. The deliver() function needs to be implemented.


Member Function Documentation

virtual bool mail::Transport::deliver ( Mail const &  mail,
bool *  temp 
) [pure virtual]

Delivers an e-mail. How this e-mail is sent is up to the implementer.

Parameters:
[in] mail The e-mail to send. A copy of this object must be done if needed as it is not guaranteed to be valid after the function returns.
[out] temp If the function fails, the boolean value pointed by this parameter must be set to true if the error is temporary (and thus the e-mail could be delivered later) and false if the error is permanent.
Returns:
true if the e-mail has been delivered or is queued for delivery, false otherwise. The error() function of the interface must return a description of the error that happened in the latter case.


The documentation for this class was generated from the following file:
Generated on Fri Apr 18 22:03:28 2008 for Epona API by  doxygen 1.5.3