E-MailRelay
Public Member Functions | List of all members
GStore::StoredMessage Class Referenceabstract

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

#include <gstoredmessage.h>

+ Inheritance diagram for GStore::StoredMessage:

Public Member Functions

virtual MessageId id () const =0
 Returns the message identifier. More...
 
virtual std::string location () const =0
 Returns the message location.
 
virtual std::string from () const =0
 Returns the envelope 'from' field.
 
virtual std::string to (std::size_t) const =0
 Returns the requested envelope non-local recipient or the empty string if out of range.
 
virtual std::size_t toCount () const =0
 Returns the number of non-local recipients.
 
virtual std::size_t contentSize () const =0
 Returns the content size.
 
virtual std::istream & contentStream ()=0
 Returns a reference to the content stream.
 
virtual void close ()=0
 Releases the message to allow external editing.
 
virtual std::string reopen ()=0
 Reverses a close(), returning the empty string on success or an error reason.
 
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 MessageStore::BodyType bodyType () const =0
 Returns the message body type.
 
virtual std::string authentication () const =0
 Returns the original session authentication id.
 
virtual std::string fromAuthIn () const =0
 Returns the incoming "mail from" auth parameter, either empty, xtext-encoded or "<>".
 
virtual std::string fromAuthOut () const =0
 Returns the outgoing "mail from" auth parameter, either empty, xtext-encoded or "<>".
 
virtual std::string forwardTo () const =0
 Returns the routing override or the empty string.
 
virtual std::string forwardToAddress () const =0
 Returns the forwardTo() address or the empty string.
 
virtual std::string clientAccountSelector () const =0
 Returns the client account selector or the empty string.
 
virtual bool utf8Mailboxes () const =0
 Returns true if the mail-from command should have SMTPUTF8 (RFC-6531).
 
virtual void editRecipients (const G::StringArray &)=0
 Updates the message's remote recipients, typically to the sub-set that have not received it successfully.
 
virtual ~StoredMessage ()=default
 Destructor.
 

Detailed Description

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

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

Definition at line 42 of file gstoredmessage.h.

Member Function Documentation

◆ id()

virtual MessageId GStore::StoredMessage::id ( ) const
pure virtual

Returns the message identifier.

Implemented in GStore::StoredFile.


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