GSmtp::StoredMessage Class Reference

An abstract class for messages which have come from the store. More...

#include <gstoredmessage.h>

Inheritance diagram for GSmtp::StoredMessage:

GSmtp::StoredFile

List of all members.

Public Member Functions

virtual std::string name () const =0
 Returns some sort of unique identifier for the message.
virtual std::string location () const =0
 Returns another sort of unique identifier for the message.
virtual const std::string & from () const =0
 Returns the envelope 'from' field.
virtual const G::Stringsto () const =0
 Returns the envelope 'to' fields.
virtual std::auto_ptr
< std::istream > 
extractContentStream ()=0
 Extracts the content stream.
virtual void destroy ()=0
 Deletes the message within the store.
virtual void fail (const std::string &reason, int reason_code)=0
 Marks the message as failed within the store.
virtual bool eightBit () const =0
 Returns true if the message content (header+body) contains a character with the most significant bit set.
virtual std::string authentication () const =0
 Returns the message authentication string.
virtual size_t remoteRecipientCount () const =0
 Returns the number of non-local recipients.
virtual size_t errorCount () const =0
 Returns the number of accumulated submission errors.
virtual void sync ()=0
 Synchronises the message object with the underlying storage.
virtual ~StoredMessage ()
 Destructor.


Detailed Description

An abstract class for messages which have come from the store.

See also:
GSmtp::MessageStore, GSmtp::MessageStore::get()

Definition at line 40 of file gstoredmessage.h.


Constructor & Destructor Documentation

GSmtp::StoredMessage::~StoredMessage (  )  [virtual]

Destructor.

Definition at line 25 of file gstoredmessage.cpp.


Member Function Documentation

virtual std::string GSmtp::StoredMessage::name (  )  const [pure virtual]

Returns some sort of unique identifier for the message.

Implemented in GSmtp::StoredFile.

virtual std::string GSmtp::StoredMessage::location (  )  const [pure virtual]

Returns another sort of unique identifier for the message.

Implemented in GSmtp::StoredFile.

virtual const std::string& GSmtp::StoredMessage::from (  )  const [pure virtual]

Returns the envelope 'from' field.

Implemented in GSmtp::StoredFile.

virtual const G::Strings& GSmtp::StoredMessage::to (  )  const [pure virtual]

Returns the envelope 'to' fields.

Implemented in GSmtp::StoredFile.

virtual std::auto_ptr<std::istream> GSmtp::StoredMessage::extractContentStream (  )  [pure virtual]

Extracts the content stream.

Can only be called once.

Implemented in GSmtp::StoredFile.

virtual void GSmtp::StoredMessage::destroy (  )  [pure virtual]

Deletes the message within the store.

Implemented in GSmtp::StoredFile.

virtual void GSmtp::StoredMessage::fail ( const std::string &  reason,
int  reason_code 
) [pure virtual]

Marks the message as failed within the store.

Implemented in GSmtp::StoredFile.

virtual bool GSmtp::StoredMessage::eightBit (  )  const [pure virtual]

Returns true if the message content (header+body) contains a character with the most significant bit set.

Implemented in GSmtp::StoredFile.

virtual std::string GSmtp::StoredMessage::authentication (  )  const [pure virtual]

Returns the message authentication string.

Implemented in GSmtp::StoredFile.

virtual size_t GSmtp::StoredMessage::remoteRecipientCount (  )  const [pure virtual]

Returns the number of non-local recipients.

Implemented in GSmtp::StoredFile.

virtual size_t GSmtp::StoredMessage::errorCount (  )  const [pure virtual]

Returns the number of accumulated submission errors.

Implemented in GSmtp::StoredFile.

virtual void GSmtp::StoredMessage::sync (  )  [pure virtual]

Synchronises the message object with the underlying storage.

Implemented in GSmtp::StoredFile.


The documentation for this class was generated from the following files:

Generated on Fri Apr 18 15:56:14 2008 for E-MailRelay by  doxygen 1.5.5